Module org.elasticsearch.server

Package org.elasticsearch.reservedstate.service

Class ReservedClusterStateService

java.lang.Object

org.elasticsearch.reservedstate.service.ReservedClusterStateService

public class ReservedClusterStateService
extends Object

Controller class for storing and reserving a portion of the ClusterState

This class contains the logic about validation, ordering and applying of the cluster state specified in a file or through plugins/modules. Reserved cluster state cannot be modified through the REST APIs, only through this controller class.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	METADATA_FIELD
static final ParseField	STATE_FIELD

Constructor Summary

Constructors

Constructor	Description
ReservedClusterStateService(ClusterService clusterService, RerouteService rerouteService, List<ReservedClusterStateHandler<?>> clusterHandlerList, List<ReservedProjectStateHandler<?>> projectHandlerList)	Controller class for saving and reserving ClusterState.

Method Summary

Modifier and Type	Method	Description
void	initEmpty(String namespace, ActionListener<ActionResponse.Empty> listener)
void	installClusterStateHandler(ReservedClusterStateHandler<?> handler)	Adds additional ReservedClusterStateHandler to the handler registry
void	installProjectStateHandler(ReservedProjectStateHandler<?> handler)	Adds additional ReservedClusterStateHandler to the handler registry
ReservedStateChunk	parse(ProjectId projectId, String namespace, XContentParser parser)
void	process(String namespace, ReservedStateChunk reservedStateChunk, ReservedStateVersionCheck versionCheck, Consumer<Exception> errorListener)	Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser
void	process(String namespace, XContentParser parser, ReservedStateVersionCheck versionCheck, Consumer<Exception> errorListener)	Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser
void	process(ProjectId projectId, String namespace, List<ReservedStateChunk> reservedStateChunks, ReservedStateVersionCheck versionCheck, Consumer<Exception> errorListener)	Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser by combining several chunks into one
void	process(ProjectId projectId, String namespace, ReservedStateChunk reservedStateChunk, ReservedStateVersionCheck versionCheck, Consumer<Exception> errorListener)	Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser
void	process(ProjectId projectId, String namespace, XContentParser parser, ReservedStateVersionCheck versionCheck, Consumer<Exception> errorListener)	Saves and reserves a chunk of the project state under a given 'namespace' from XContentParser

Methods inherited from class java.lang.Object

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

Field Details

STATE_FIELD

public static final ParseField STATE_FIELD

METADATA_FIELD

public static final ParseField METADATA_FIELD

Constructor Details

ReservedClusterStateService

public ReservedClusterStateService(ClusterService clusterService,
 RerouteService rerouteService,
 List<ReservedClusterStateHandler<?>> clusterHandlerList,
 List<ReservedProjectStateHandler<?>> projectHandlerList)

Controller class for saving and reserving ClusterState.

Method Details

process

public void process(String namespace,
 XContentParser parser,
 ReservedStateVersionCheck versionCheck,
 Consumer<Exception> errorListener)

Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser

Parameters:

namespace - the namespace under which we'll store the reserved keys in the cluster state metadata

parser - the XContentParser to process

versionCheck - determines if current and new versions of reserved state require processing or should be skipped

errorListener - a consumer called with IllegalStateException if the content has errors and the cluster state cannot be correctly applied, null if successful or state couldn't be applied because of incompatible version.

parse

public ReservedStateChunk parse(ProjectId projectId,
 String namespace,
 XContentParser parser)

process

public void process(ProjectId projectId,
 String namespace,
 XContentParser parser,
 ReservedStateVersionCheck versionCheck,
 Consumer<Exception> errorListener)

Saves and reserves a chunk of the project state under a given 'namespace' from XContentParser

Parameters:

projectId - the project this state is for

namespace - the namespace under which we'll store the reserved keys in the project state metadata

parser - the XContentParser to process

versionCheck - determines if current and new versions of reserved state require processing or should be skipped

errorListener - a consumer called with IllegalStateException if the content has errors and the cluster state cannot be correctly applied, null if successful or state couldn't be applied because of incompatible version.

initEmpty

public void initEmpty(String namespace,
 ActionListener<ActionResponse.Empty> listener)

process

public void process(String namespace,
 ReservedStateChunk reservedStateChunk,
 ReservedStateVersionCheck versionCheck,
 Consumer<Exception> errorListener)

Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser

Parameters:

namespace - the namespace under which we'll store the reserved keys in the cluster state metadata

reservedStateChunk - a ReservedStateChunk composite state object to process

errorListener - a consumer called with IllegalStateException if the content has errors and the cluster state cannot be correctly applied, null if successful or the state failed to apply because of incompatible version.

process

public void process(ProjectId projectId,
 String namespace,
 ReservedStateChunk reservedStateChunk,
 ReservedStateVersionCheck versionCheck,
 Consumer<Exception> errorListener)

Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser

Parameters:

projectId - the project state to modify

namespace - the namespace under which we'll store the reserved keys in the cluster state metadata

reservedStateChunk - a ReservedStateChunk composite state object to process

versionCheck - Enum representing whether a reserved state should be processed based on the current and new versions

errorListener - a consumer called with IllegalStateException if the content has errors and the cluster state cannot be correctly applied, null if successful or the state failed to apply because of incompatible version.

process

public void process(ProjectId projectId,
 String namespace,
 List<ReservedStateChunk> reservedStateChunks,
 ReservedStateVersionCheck versionCheck,
 Consumer<Exception> errorListener)

Saves and reserves a chunk of the cluster state under a given 'namespace' from XContentParser by combining several chunks into one

Parameters:

projectId - the project state to modify

namespace - the namespace under which we'll store the reserved keys in the cluster state metadata

reservedStateChunks - a list of ReservedStateChunk composite state objects to process

versionCheck - Enum representing whether a reserved state should be processed based on the current and new versions

errorListener - a consumer called with IllegalStateException if the content has errors and the cluster state cannot be correctly applied, null if successful or the state failed to apply because of incompatible version.

installClusterStateHandler

public void installClusterStateHandler(ReservedClusterStateHandler<?> handler)

Adds additional ReservedClusterStateHandler to the handler registry

Parameters:

handler - an additional reserved state handler to be added

installProjectStateHandler

public void installProjectStateHandler(ReservedProjectStateHandler<?> handler)

Adds additional ReservedClusterStateHandler to the handler registry

Parameters:

handler - an additional reserved state handler to be added