Package org.elasticsearch.action.support.replication

Class TransportReplicationAction<Request extends ReplicationRequest<Request>,ReplicaRequest extends ReplicationRequest<ReplicaRequest>,Response extends ReplicationResponse>

java.lang.Object

org.elasticsearch.action.support.TransportAction<Request,Response>

org.elasticsearch.action.support.replication.TransportReplicationAction<Request,ReplicaRequest,Response>

Direct Known Subclasses:

GlobalCheckpointSyncAction, RetentionLeaseBackgroundSyncAction, TransportShardFlushAction, TransportShardRefreshAction, TransportVerifyShardBeforeCloseAction, TransportWriteAction

public abstract class TransportReplicationAction<Request extends ReplicationRequest<Request>,ReplicaRequest extends ReplicationRequest<ReplicaRequest>,Response extends ReplicationResponse>
extends TransportAction<Request,Response>

Base class for requests that should be executed on a primary copy followed by replica copies. Subclasses can resolve the target shard and provide implementation for primary and replica operations. The action samples cluster state on the receiving node to reroute to node with primary copy and on the primary node to validate request before primary operation followed by sampling state again for resolving nodes with replica copies to perform replication.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TransportReplicationAction.ConcreteReplicaRequest<R extends TransportRequest>
static class	TransportReplicationAction.ConcreteShardRequest<R extends TransportRequest>	a wrapper class to encapsulate a request when being sent to a specific allocation id
static class	TransportReplicationAction.PrimaryResult<ReplicaRequest extends ReplicationRequest<ReplicaRequest>,Response extends ReplicationResponse>
static class	TransportReplicationAction.ReplicaResponse
static class	TransportReplicationAction.ReplicaResult
protected class	TransportReplicationAction.ReplicasProxy	The ReplicasProxy is an implementation of the Replicas interface that performs the actual ReplicaRequest on the replica shards.
static class	TransportReplicationAction.RetryOnReplicaException

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterService	clusterService
protected java.lang.String	executor
protected IndexNameExpressionResolver	indexNameExpressionResolver
protected IndicesService	indicesService
protected ShardStateAction	shardStateAction
protected ThreadPool	threadPool
protected TransportRequestOptions	transportOptions
protected java.lang.String	transportPrimaryAction
protected java.lang.String	transportReplicaAction
protected TransportService	transportService

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, logger, taskManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportReplicationAction(Settings settings, java.lang.String actionName, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> requestReader, Writeable.Reader<ReplicaRequest> replicaRequestReader, java.lang.String executor)
protected	TransportReplicationAction(Settings settings, java.lang.String actionName, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> requestReader, Writeable.Reader<ReplicaRequest> replicaRequestReader, java.lang.String executor, boolean syncGlobalCheckpointAfterOperation, boolean forceExecutionOnPrimary)

Method Summary

Modifier and Type	Method	Description
protected void	acquirePrimaryOperationPermit(IndexShard primary, Request request, ActionListener<Releasable> onAcquired)	Executes the logic for acquiring one or more operation permit on a primary shard.
protected void	acquireReplicaOperationPermit(IndexShard replica, ReplicaRequest request, ActionListener<Releasable> onAcquired, long primaryTerm, long globalCheckpoint, long maxSeqNoOfUpdatesOrDeletes)	Executes the logic for acquiring one or more operation permit on a replica shard.
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected ClusterBlockLevel	globalBlockLevel()	Cluster level block to check before request execution.
protected void	handleOperationRequest(Request request, TransportChannel channel, Task task)
protected void	handlePrimaryRequest(TransportReplicationAction.ConcreteShardRequest<Request> request, TransportChannel channel, Task task)
protected void	handleReplicaRequest(TransportReplicationAction.ConcreteReplicaRequest<ReplicaRequest> replicaRequest, TransportChannel channel, Task task)
ClusterBlockLevel	indexBlockLevel()	Index level block to check before request execution.
protected ReplicationOperation.Replicas<ReplicaRequest>	newReplicasProxy()
protected abstract Response	newResponseInstance(StreamInput in)
protected boolean	resolveIndex()	True if provided index should be resolved when resolving request
protected void	resolveRequest(IndexMetaData indexMetaData, Request request)	Resolves derived values in the request.
protected boolean	retryPrimaryException(java.lang.Throwable e)
protected abstract void	shardOperationOnPrimary(Request shardRequest, IndexShard primary, ActionListener<TransportReplicationAction.PrimaryResult<ReplicaRequest,Response>> listener)	Primary operation on node with primary copy.
protected abstract TransportReplicationAction.ReplicaResult	shardOperationOnReplica(ReplicaRequest shardRequest, IndexShard replica)	Synchronously execute the specified replica operation.
protected TransportRequestOptions	transportOptions(Settings settings)

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, execute, execute

Methods inherited from class java.lang.Object

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

Field Detail

threadPool

protected final ThreadPool threadPool

transportService

protected final TransportService transportService

clusterService

protected final ClusterService clusterService

shardStateAction

protected final ShardStateAction shardStateAction

indicesService

protected final IndicesService indicesService

indexNameExpressionResolver

protected final IndexNameExpressionResolver indexNameExpressionResolver

transportOptions

protected final TransportRequestOptions transportOptions

executor

protected final java.lang.String executor

transportReplicaAction

protected final java.lang.String transportReplicaAction

transportPrimaryAction

protected final java.lang.String transportPrimaryAction

Constructor Detail

TransportReplicationAction

protected TransportReplicationAction(Settings settings,
                                     java.lang.String actionName,
                                     TransportService transportService,
                                     ClusterService clusterService,
                                     IndicesService indicesService,
                                     ThreadPool threadPool,
                                     ShardStateAction shardStateAction,
                                     ActionFilters actionFilters,
                                     IndexNameExpressionResolver indexNameExpressionResolver,
                                     Writeable.Reader<Request> requestReader,
                                     Writeable.Reader<ReplicaRequest> replicaRequestReader,
                                     java.lang.String executor)

TransportReplicationAction

protected TransportReplicationAction(Settings settings,
                                     java.lang.String actionName,
                                     TransportService transportService,
                                     ClusterService clusterService,
                                     IndicesService indicesService,
                                     ThreadPool threadPool,
                                     ShardStateAction shardStateAction,
                                     ActionFilters actionFilters,
                                     IndexNameExpressionResolver indexNameExpressionResolver,
                                     Writeable.Reader<Request> requestReader,
                                     Writeable.Reader<ReplicaRequest> replicaRequestReader,
                                     java.lang.String executor,
                                     boolean syncGlobalCheckpointAfterOperation,
                                     boolean forceExecutionOnPrimary)

Method Detail

doExecute

protected void doExecute(Task task,
                         Request request,
                         ActionListener<Response> listener)

Specified by:

doExecute in class TransportAction<Request extends ReplicationRequest<Request>,Response extends ReplicationResponse>

newReplicasProxy

protected ReplicationOperation.Replicas<ReplicaRequest> newReplicasProxy()

newResponseInstance

protected abstract Response newResponseInstance(StreamInput in)
                                         throws java.io.IOException

Throws:

java.io.IOException

resolveRequest

protected void resolveRequest(IndexMetaData indexMetaData,
                              Request request)

Resolves derived values in the request. For example, the target shard id of the incoming request, if not set at request construction. Additional processing or validation of the request should be done here.

Parameters:

indexMetaData - index metadata of the concrete index this request is going to operate on

request - the request to resolve

shardOperationOnPrimary

protected abstract void shardOperationOnPrimary(Request shardRequest,
                                                IndexShard primary,
                                                ActionListener<TransportReplicationAction.PrimaryResult<ReplicaRequest,Response>> listener)

Primary operation on node with primary copy.

Parameters:

shardRequest - the request to the primary shard

primary - the primary shard to perform the operation on

shardOperationOnReplica

protected abstract TransportReplicationAction.ReplicaResult shardOperationOnReplica(ReplicaRequest shardRequest,
                                                                                    IndexShard replica)
                                                                             throws java.lang.Exception

Synchronously execute the specified replica operation. This is done under a permit from IndexShard.acquireReplicaOperationPermit(long, long, long, ActionListener, String, Object).

Parameters:

shardRequest - the request to the replica shard

replica - the replica shard to perform the operation on

Throws:

java.lang.Exception

globalBlockLevel

@Nullable
protected ClusterBlockLevel globalBlockLevel()

Cluster level block to check before request execution. Returning null means that no blocks need to be checked.

indexBlockLevel

@Nullable
public ClusterBlockLevel indexBlockLevel()

Index level block to check before request execution. Returning null means that no blocks need to be checked.

resolveIndex

protected boolean resolveIndex()

True if provided index should be resolved when resolving request

transportOptions

protected TransportRequestOptions transportOptions(Settings settings)

retryPrimaryException

protected boolean retryPrimaryException(java.lang.Throwable e)

handleOperationRequest

protected void handleOperationRequest(Request request,
                                      TransportChannel channel,
                                      Task task)

handlePrimaryRequest

protected void handlePrimaryRequest(TransportReplicationAction.ConcreteShardRequest<Request> request,
                                    TransportChannel channel,
                                    Task task)

handleReplicaRequest

protected void handleReplicaRequest(TransportReplicationAction.ConcreteReplicaRequest<ReplicaRequest> replicaRequest,
                                    TransportChannel channel,
                                    Task task)

acquirePrimaryOperationPermit

protected void acquirePrimaryOperationPermit(IndexShard primary,
                                             Request request,
                                             ActionListener<Releasable> onAcquired)

Executes the logic for acquiring one or more operation permit on a primary shard. The default is to acquire a single permit but this method can be overridden to acquire more.

acquireReplicaOperationPermit

protected void acquireReplicaOperationPermit(IndexShard replica,
                                             ReplicaRequest request,
                                             ActionListener<Releasable> onAcquired,
                                             long primaryTerm,
                                             long globalCheckpoint,
                                             long maxSeqNoOfUpdatesOrDeletes)

Executes the logic for acquiring one or more operation permit on a replica shard. The default is to acquire a single permit but this method can be overridden to acquire more.