org.elasticsearch.action.support.replication

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

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

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

Direct Known Subclasses:

TransportDeleteAction, TransportIndexAction, TransportShardBulkAction, TransportShardFlushAction, TransportShardRefreshAction

public abstract class TransportReplicationAction<Request extends ReplicationRequest,ReplicaRequest extends ReplicationRequest,Response extends ActionWriteResponse>
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 and Description
static class	TransportReplicationAction.RetryOnPrimaryException
static class	TransportReplicationAction.RetryOnReplicaException
protected static class	TransportReplicationAction.WriteResult<T extends ActionWriteResponse>

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterService	clusterService
protected WriteConsistencyLevel	defaultWriteConsistencyLevel
protected IndicesService	indicesService
protected MappingUpdatedAction	mappingUpdatedAction
protected ShardStateAction	shardStateAction
protected TransportRequestOptions	transportOptions
protected TransportService	transportService

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

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

TransportReplicationAction(Settings settings, String actionName, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, MappingUpdatedAction mappingUpdatedAction, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Class<Request> request, Class<ReplicaRequest> replicaRequest, String executor)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkWriteConsistency() True if write consistency should be checked for an implementation
protected void	doExecute(Request request, ActionListener<Response> listener)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected Releasable	getIndexShardOperationsCounter(ShardId shardId)
protected ClusterBlockLevel	globalBlockLevel() Cluster level block to check before request execution
protected boolean	ignoreReplicaException(Throwable e) Should an exception be ignored when the operation is performed on the replica.
protected ClusterBlockLevel	indexBlockLevel() Index level block to check before request execution
protected boolean	isConflictException(Throwable e)
protected boolean	mustFailReplica(Throwable e) Returns true iff the replica must be failed if it threw the given exception.
protected abstract Response	newResponseInstance()
protected void	processAfterWrite(boolean refresh, IndexShard indexShard, Translog.Location location)
protected boolean	resolveIndex() True if provided index should be resolved when resolving request
protected void	resolveRequest(MetaData metaData, String concreteIndex, Request request) Resolves the target shard id of the incoming request.
protected boolean	retryPrimaryException(Throwable e)
protected abstract Tuple<Response,ReplicaRequest>	shardOperationOnPrimary(MetaData metaData, Request shardRequest) Primary operation on node with primary copy, the provided metadata should be used for request validation if needed
protected abstract void	shardOperationOnReplica(ReplicaRequest shardRequest) Replica operation on nodes with replica copies
protected boolean	shouldExecuteReplication(Settings settings) Indicated whether this operation should be replicated to shadow replicas or not.
protected TransportRequestOptions	transportOptions()

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

execute, execute, execute, execute

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

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

transportService

protected final TransportService transportService

clusterService

protected final ClusterService clusterService

indicesService

protected final IndicesService indicesService

shardStateAction

protected final ShardStateAction shardStateAction

defaultWriteConsistencyLevel

protected final WriteConsistencyLevel defaultWriteConsistencyLevel

transportOptions

protected final TransportRequestOptions transportOptions

mappingUpdatedAction

protected final MappingUpdatedAction mappingUpdatedAction

Constructor Detail

TransportReplicationAction

protected TransportReplicationAction(Settings settings,
                          String actionName,
                          TransportService transportService,
                          ClusterService clusterService,
                          IndicesService indicesService,
                          ThreadPool threadPool,
                          ShardStateAction shardStateAction,
                          MappingUpdatedAction mappingUpdatedAction,
                          ActionFilters actionFilters,
                          IndexNameExpressionResolver indexNameExpressionResolver,
                          Class<Request> request,
                          Class<ReplicaRequest> replicaRequest,
                          String executor)

Method Detail

doExecute

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

Specified by:

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

doExecute

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

Overrides:

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

newResponseInstance

protected abstract Response newResponseInstance()

resolveRequest

protected void resolveRequest(MetaData metaData,
                  String concreteIndex,
                  Request request)

Resolves the target shard id of the incoming request. Additional processing or validation of the request should be done here.

shardOperationOnPrimary

protected abstract Tuple<Response,ReplicaRequest> shardOperationOnPrimary(MetaData metaData,
                                                     Request shardRequest)
                                                                                                                          throws Throwable

Primary operation on node with primary copy, the provided metadata should be used for request validation if needed

Returns:

A tuple containing not null values, as first value the result of the primary operation and as second value the request to be executed on the replica shards.

Throws:

Throwable

shardOperationOnReplica

protected abstract void shardOperationOnReplica(ReplicaRequest shardRequest)

Replica operation on nodes with replica copies

checkWriteConsistency

protected boolean checkWriteConsistency()

True if write consistency should be checked for an implementation

globalBlockLevel

protected ClusterBlockLevel globalBlockLevel()

Cluster level block to check before request execution

indexBlockLevel

protected ClusterBlockLevel indexBlockLevel()

Index level block to check before request execution

resolveIndex

protected boolean resolveIndex()

True if provided index should be resolved when resolving request

transportOptions

protected TransportRequestOptions transportOptions()

retryPrimaryException

protected boolean retryPrimaryException(Throwable e)

ignoreReplicaException

protected boolean ignoreReplicaException(Throwable e)

Should an exception be ignored when the operation is performed on the replica.

mustFailReplica

protected boolean mustFailReplica(Throwable e)

Returns true iff the replica must be failed if it threw the given exception. This defaults to the inverse of ignoreReplicaException(Throwable)

isConflictException

protected boolean isConflictException(Throwable e)

getIndexShardOperationsCounter

protected Releasable getIndexShardOperationsCounter(ShardId shardId)

shouldExecuteReplication

protected boolean shouldExecuteReplication(Settings settings)

Indicated whether this operation should be replicated to shadow replicas or not. If this method returns true the replication phase will be skipped. For example writes such as index and delete don't need to be replicated on shadow replicas but refresh and flush do.

processAfterWrite

protected final void processAfterWrite(boolean refresh,
                     IndexShard indexShard,
                     Translog.Location location)