Module org.elasticsearch.security

Package org.elasticsearch.xpack.security.support

Class SecurityIndexManager

java.lang.Object

org.elasticsearch.xpack.security.support.SecurityIndexManager

All Implemented Interfaces:

ClusterStateListener

public class SecurityIndexManager
extends Object
implements ClusterStateListener

Manages the lifecycle, mapping and data upgrades/migrations of the RestrictedIndicesNames#SECURITY_MAIN_ALIAS and RestrictedIndicesNames#SECURITY_MAIN_ALIAS alias-index pair.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SecurityIndexManager.Availability	When checking availability, check for availability of search or availability of all primaries
class	SecurityIndexManager.IndexState
static enum	SecurityIndexManager.ProjectStatus
static enum	SecurityIndexManager.RoleMappingsCleanupMigrationStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	FILE_SETTINGS_METADATA_NAMESPACE
static final String	SECURITY_VERSION_STRING

Method Summary

Modifier and Type	Method	Description
void	addStateListener(TriConsumer<ProjectId,SecurityIndexManager.IndexState,SecurityIndexManager.IndexState> listener)	Add a listener for notifications on state changes to the configured index.
String	aliasName()
static SecurityIndexManager	buildSecurityIndexManager(Client client, ClusterService clusterService, FeatureService featureService, ProjectResolver projectResolver, SystemIndexDescriptor descriptor)
void	clusterChanged(ClusterChangedEvent event)
SecurityIndexManager.IndexState	forCurrentProject()	Retrieves the project scoped index state for the current project.
static int	getMigrationVersionFromIndexMetadata(IndexMetadata indexMetadata)
SecurityIndexManager.IndexState	getProject(ProjectId project)	Retrieves the project scoped index state.
static boolean	isIndexDeleted(SecurityIndexManager.IndexState previousState, SecurityIndexManager.IndexState currentState)	Return true if the state moves from the index existing to the index not existing.
static boolean	isMoveFromRedToNonRed(SecurityIndexManager.IndexState previousState, SecurityIndexManager.IndexState currentState)	Return true if the state moves from an unhealthy ("RED") index state to a healthy ("non-RED") state.
void	removeStateListener(TriConsumer<ProjectId,SecurityIndexManager.IndexState,SecurityIndexManager.IndexState> listener)	Remove a listener from notifications on state changes to the configured index.
static IndexMetadata	resolveConcreteIndex(String indexOrAliasName, ProjectMetadata project)	Resolves a concrete index name or alias to a IndexMetadata instance.
void	tryAwaitIndexAvailableForSearch(ActionListener<SecurityIndexManager.IndexState> listener)	Resolves a fresh SecurityIndexManager.IndexState for the current project once the security index is available for search, waiting up to SECURITY_INDEX_WAIT_TIMEOUT when shards are temporarily unavailable.
void	whenProjectStateAvailable(ProjectId targetProject, Consumer<SecurityIndexManager.IndexState> stateConsumer)

Methods inherited from class java.lang.Object

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

Field Details

SECURITY_VERSION_STRING

public static final String SECURITY_VERSION_STRING

See Also:

• Constant Field Values

FILE_SETTINGS_METADATA_NAMESPACE

protected static final String FILE_SETTINGS_METADATA_NAMESPACE

See Also:

• Constant Field Values

Method Details

buildSecurityIndexManager

public static SecurityIndexManager buildSecurityIndexManager(Client client,
 ClusterService clusterService,
 FeatureService featureService,
 ProjectResolver projectResolver,
 SystemIndexDescriptor descriptor)

forCurrentProject

public SecurityIndexManager.IndexState forCurrentProject()

Retrieves the project scoped index state for the current project.

See Also:

• getProject(ProjectId)

getProject

public SecurityIndexManager.IndexState getProject(ProjectId project)

Retrieves the project scoped index state. This is a point-in-time copy of the current state of the index in that project. Its internal representation will not change even if the index's underlying state changes in the cluster metadata.

tryAwaitIndexAvailableForSearch

public void tryAwaitIndexAvailableForSearch(ActionListener<SecurityIndexManager.IndexState> listener)

Resolves a fresh SecurityIndexManager.IndexState for the current project once the security index is available for search, waiting up to SECURITY_INDEX_WAIT_TIMEOUT when shards are temporarily unavailable.

Behavior:

• If the index is already available for search, completes immediately with the current snapshot.
• If the index is unavailable for a non-shards reason (e.g. closed, version mismatch, not found), completes immediately with that failure.
• If shards are unavailable and the wait timeout is zero, completes immediately with the UnavailableShardsException.
• Otherwise waits via SecurityIndexManager.IndexState.onIndexAvailableForSearch(org.elasticsearch.action.ActionListener<java.lang.Void>, org.elasticsearch.core.TimeValue) and, after the wait fires (success or timeout), performs a single fresh re-check: completes successfully with the fresh snapshot if shards are now available, or with the fresh SecurityIndexManager.IndexState.getUnavailableReason(Availability) otherwise. A timeout from the wait itself is never propagated to the listener.

aliasName

public String aliasName()

addStateListener

public void addStateListener(TriConsumer<ProjectId,SecurityIndexManager.IndexState,SecurityIndexManager.IndexState> listener)

Add a listener for notifications on state changes to the configured index. The previous and current state are provided.

removeStateListener

public void removeStateListener(TriConsumer<ProjectId,SecurityIndexManager.IndexState,SecurityIndexManager.IndexState> listener)

Remove a listener from notifications on state changes to the configured index.

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Specified by:

clusterChanged in interface ClusterStateListener

getMigrationVersionFromIndexMetadata

public static int getMigrationVersionFromIndexMetadata(IndexMetadata indexMetadata)

whenProjectStateAvailable

public void whenProjectStateAvailable(ProjectId targetProject,
 Consumer<SecurityIndexManager.IndexState> stateConsumer)

resolveConcreteIndex

public static IndexMetadata resolveConcreteIndex(String indexOrAliasName,
 ProjectMetadata project)

Resolves a concrete index name or alias to a IndexMetadata instance. Requires that if supplied with an alias, the alias resolves to at most one concrete index.

isMoveFromRedToNonRed

public static boolean isMoveFromRedToNonRed(SecurityIndexManager.IndexState previousState,
 SecurityIndexManager.IndexState currentState)

Return true if the state moves from an unhealthy ("RED") index state to a healthy ("non-RED") state.

isIndexDeleted

public static boolean isIndexDeleted(SecurityIndexManager.IndexState previousState,
 SecurityIndexManager.IndexState currentState)

Return true if the state moves from the index existing to the index not existing.