Module org.elasticsearch.security

Package org.elasticsearch.xpack.security.authc

Class Realms

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.xpack.security.authc.Realms

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Realm>, LifecycleComponent, Releasable, ReloadableSecurityComponent

public class Realms
extends AbstractLifecycleComponent
implements Iterable<Realm>, ReloadableSecurityComponent

Serves as a realms registry (also responsible for ordering the realms appropriately)

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
Realms(Settings settings, Environment env, Map<String,Realm.Factory> factories, XPackLicenseState licenseState, ThreadContext threadContext, ReservedRealm reservedRealm)

Method Summary

Modifier and Type	Method	Description
protected List<Realm>	calculateLicensedRealms(XPackLicenseState licenseStateSnapshot)
protected void	doClose()
Map<String,Object>	domainUsageStats()
protected void	doStart()
protected void	doStop()
List<Realm>	getActiveRealms()
DomainConfig	getDomainConfig(String domainName)
Authentication.RealmRef	getFileRealmRef()
Authentication.RealmRef	getNativeRealmRef()
Authentication.RealmRef	getRealmRef(RealmConfig.RealmIdentifier realmIdentifier)	Retrieves the Authentication.RealmRef, which contains the DomainConfig, if configured, for the passed in RealmConfig.RealmIdentifier.
Authentication.RealmRef	getReservedRealmRef()
List<Realm>	getUnlicensedRealms()	Returns a list of realms that are configured, but are not permitted under the current license.
protected void	handleDisabledRealmDueToLicenseChange(Realm realm, XPackLicenseState licenseStateSnapshot)
protected List<Realm>	initRealms(List<RealmConfig> realmConfigs)
static boolean	isRealmTypeAvailable(XPackLicenseState licenseState, String type)
Iterator<Realm>	iterator()
Realm	realm(String name)
Realm.Factory	realmFactory(String type)
protected void	recomputeActiveRealms()
void	reload(Settings settings)	Called when a reload security settings action is executed.
Stream<Realm>	stream()
void	usageStats(ActionListener<Map<String,Object>> listener)

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Realms

public Realms(Settings settings,
 Environment env,
 Map<String,Realm.Factory> factories,
 XPackLicenseState licenseState,
 ThreadContext threadContext,
 ReservedRealm reservedRealm)
       throws Exception

Throws:

Exception

Method Details

recomputeActiveRealms

protected void recomputeActiveRealms()

handleDisabledRealmDueToLicenseChange

protected void handleDisabledRealmDueToLicenseChange(Realm realm,
 XPackLicenseState licenseStateSnapshot)

iterator

public Iterator<Realm> iterator()

Specified by:

iterator in interface Iterable<Realm>

getUnlicensedRealms

public List<Realm> getUnlicensedRealms()

Returns a list of realms that are configured, but are not permitted under the current license.

stream

public Stream<Realm> stream()

getActiveRealms

public List<Realm> getActiveRealms()

getDomainConfig

public DomainConfig getDomainConfig(String domainName)

calculateLicensedRealms

protected List<Realm> calculateLicensedRealms(XPackLicenseState licenseStateSnapshot)

isRealmTypeAvailable

public static boolean isRealmTypeAvailable(XPackLicenseState licenseState,
 String type)

realm

public Realm realm(String name)

realmFactory

public Realm.Factory realmFactory(String type)

initRealms

protected List<Realm> initRealms(List<RealmConfig> realmConfigs)
                          throws Exception

Throws:

Exception

usageStats

public void usageStats(ActionListener<Map<String,Object>> listener)

domainUsageStats

public Map<String,Object> domainUsageStats()

getRealmRef

@Nullable
public Authentication.RealmRef getRealmRef(RealmConfig.RealmIdentifier realmIdentifier)

Retrieves the Authentication.RealmRef, which contains the DomainConfig, if configured, for the passed in RealmConfig.RealmIdentifier. If the realm is not currently configured, null is returned.

getNativeRealmRef

public Authentication.RealmRef getNativeRealmRef()

getFileRealmRef

public Authentication.RealmRef getFileRealmRef()

getReservedRealmRef

public Authentication.RealmRef getReservedRealmRef()

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()
                throws IOException

Specified by:

doClose in class AbstractLifecycleComponent

Throws:

IOException

reload

public void reload(Settings settings)

Description copied from interface: ReloadableSecurityComponent

Called when a reload security settings action is executed. The reload operation must be completed when this method returns. Strictly speaking, the settings argument should not be accessed outside of this method's call stack, as any values stored in the node's keystore (see SecureSetting) will not otherwise be retrievable.

There is no guarantee that the secure setting's values have actually changed. Hence, it's up to implementor to detect if the actual internal reloading is necessary.

Any failure during the reloading should be signaled by raising an exception.

For additional info, see also: ReloadablePlugin.reload(Settings).

Specified by:

reload in interface ReloadableSecurityComponent

Parameters:

settings - Settings include the initial node's settings and all decrypted secure settings from the keystore. Absence of a particular secure setting may mean that the setting was either never configured or that it was simply removed.