Module org.elasticsearch.server

Package org.elasticsearch.reservedstate.service

Class ReservedStateUpdateTask<T extends ReservedStateHandler<?>>

java.lang.Object

org.elasticsearch.reservedstate.service.ReservedStateUpdateTask<T>

All Implemented Interfaces:

ClusterStateTaskListener

Direct Known Subclasses:

ReservedClusterStateUpdateTask, ReservedProjectStateUpdateTask

public abstract class ReservedStateUpdateTask<T extends ReservedStateHandler<?>>
extends Object
implements ClusterStateTaskListener

Generic task to update and reserve parts of the cluster state

Reserved cluster state can only be modified by using the ReservedClusterStateService. Updating the reserved cluster state through REST APIs is not permitted.

Constructor Summary

Constructors

Constructor	Description
ReservedStateUpdateTask(String namespace, ReservedStateChunk stateChunk, ReservedStateVersionCheck versionCheck, Map<String,T> handlers, SequencedCollection<String> updateSequence, Consumer<org.elasticsearch.reservedstate.service.ErrorState> errorReporter, ActionListener<ActionResponse.Empty> listener)

Method Summary

Modifier and Type	Method	Description
void	onFailure(Exception e)	A callback for when task execution fails.
protected abstract Optional<ProjectId>	projectId()
protected abstract ClusterState	remove(T handler, TransformState prevState)
protected abstract TransformState	transform(T handler, Object state, TransformState transformState)

Methods inherited from class java.lang.Object

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

Constructor Details

ReservedStateUpdateTask

public ReservedStateUpdateTask(String namespace,
 ReservedStateChunk stateChunk,
 ReservedStateVersionCheck versionCheck,
 Map<String,T> handlers,
 SequencedCollection<String> updateSequence,
 Consumer<org.elasticsearch.reservedstate.service.ErrorState> errorReporter,
 ActionListener<ActionResponse.Empty> listener)

Parameters:

updateSequence - the names of handlers corresponding to configuration sections present in the source, in the order they should be processed according to their dependencies. It equals the result of applying orderedStateHandlers(java.util.Collection<java.lang.String>, java.util.Map<java.lang.String, ? extends org.elasticsearch.reservedstate.ReservedStateHandler<?>>) to stateChunk.state().keySet() but the caller will typically also need it for a trial run, so we avoid computing it twice.

Method Details

onFailure

public void onFailure(Exception e)

Description copied from interface: ClusterStateTaskListener

A callback for when task execution fails. May receive a NotMasterException if this node stopped being the master before this task was executed or a ProcessClusterEventTimeoutException if the task timed out before it was executed. If the task fails during execution then this method receives the corresponding exception. If the task executes successfully but the resulting cluster state publication fails then this method receives a FailedToCommitClusterStateException. If publication fails then a new master is elected and the update might or might not take effect, depending on whether or not the newly-elected master accepted the published state that failed to be committed.

Use MasterService.isPublishFailureException(java.lang.Exception) to detect the "expected" master failure cases if needed.

Implementations of this callback must not throw exceptions: an exception thrown here is logged by the master service at ERROR level and otherwise ignored, except in tests where it raises an AssertionError. If log-and-ignore is the right behaviour then implementations must do so themselves, typically using a more specific logger and at a less dramatic log level.

Specified by:

onFailure in interface ClusterStateTaskListener

projectId

protected abstract Optional<ProjectId> projectId()

transform

protected abstract TransformState transform(T handler,
 Object state,
 TransformState transformState)
                                     throws Exception

Throws:

Exception

remove

protected abstract ClusterState remove(T handler,
 TransformState prevState)
                                throws Exception

Throws:

Exception