org.elasticsearch.action.support.replication

Class TransportWriteAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

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

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

Direct Known Subclasses:

TransportShardBulkAction, TransportSingleItemBulkWriteAction

public abstract class TransportWriteAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>
extends TransportReplicationAction<Request,ReplicaRequest,Response>

Base class for transport actions that modify data in some shard like index, delete, and shardBulk. Allows performing async actions (e.g. refresh) after performing write operations on primary and replica shards

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TransportWriteAction.WritePrimaryResult<ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse> Result of taking the action on the primary.
protected static class	TransportWriteAction.WriteReplicaResult<ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>> Result of taking the action on the replica.

Nested classes/interfaces inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

TransportReplicationAction.ConcreteShardRequest<R extends TransportRequest>, TransportReplicationAction.PrimaryResult<ReplicaRequest extends ReplicationRequest<ReplicaRequest>,Response extends ReplicationResponse>, TransportReplicationAction.ReplicaResult, TransportReplicationAction.RetryOnReplicaException

Field Summary

Fields inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

clusterService

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

actionName, indexNameExpressionResolver, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

TransportWriteAction(Settings settings, java.lang.String actionName, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, java.util.function.Supplier<Request> request, java.util.function.Supplier<ReplicaRequest> replicaRequest, java.lang.String executor)

Method Summary

Modifier and Type	Method and Description
protected ClusterBlockLevel	globalBlockLevel() Cluster level block to check before request execution.
protected ClusterBlockLevel	indexBlockLevel() Index level block to check before request execution.
protected abstract TransportWriteAction.WritePrimaryResult<ReplicaRequest,Response>	shardOperationOnPrimary(Request request, IndexShard primary) Called on the primary with a reference to the primary IndexShard to modify.
protected abstract TransportWriteAction.WriteReplicaResult<ReplicaRequest>	shardOperationOnReplica(ReplicaRequest request, IndexShard replica) Called once per replica with a reference to the replica IndexShard to modify.

Methods inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

doExecute, doExecute, newResponseInstance, resolveIndex, resolveRequest, retryPrimaryException, shouldExecuteReplication, 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

Constructor Detail

TransportWriteAction

protected TransportWriteAction(Settings settings,
                               java.lang.String actionName,
                               TransportService transportService,
                               ClusterService clusterService,
                               IndicesService indicesService,
                               ThreadPool threadPool,
                               ShardStateAction shardStateAction,
                               ActionFilters actionFilters,
                               IndexNameExpressionResolver indexNameExpressionResolver,
                               java.util.function.Supplier<Request> request,
                               java.util.function.Supplier<ReplicaRequest> replicaRequest,
                               java.lang.String executor)

Method Detail

shardOperationOnPrimary

protected abstract TransportWriteAction.WritePrimaryResult<ReplicaRequest,Response> shardOperationOnPrimary(Request request,
                                                                                                            IndexShard primary)
                                                                                                     throws java.lang.Exception

Called on the primary with a reference to the primary IndexShard to modify.

Specified by:

shardOperationOnPrimary in class TransportReplicationAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>

Parameters:

request - the request to the primary shard

primary - the primary shard to perform the operation on

Returns:

the result of the operation on primary, including current translog location and operation response and failure async refresh is performed on the primary shard according to the Request refresh policy

Throws:

java.lang.Exception

shardOperationOnReplica

protected abstract TransportWriteAction.WriteReplicaResult<ReplicaRequest> shardOperationOnReplica(ReplicaRequest request,
                                                                                                   IndexShard replica)
                                                                                            throws java.lang.Exception

Called once per replica with a reference to the replica IndexShard to modify.

Specified by:

shardOperationOnReplica in class TransportReplicationAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>

Parameters:

request - the request to the replica shard

replica - the replica shard to perform the operation on

Returns:

the result of the operation on replica, including current translog location and operation response and failure async refresh is performed on the replica shard according to the ReplicaRequest refresh policy

Throws:

java.lang.Exception

globalBlockLevel

protected ClusterBlockLevel globalBlockLevel()

Description copied from class: TransportReplicationAction

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

Overrides:

globalBlockLevel in class TransportReplicationAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>

indexBlockLevel

protected ClusterBlockLevel indexBlockLevel()

Description copied from class: TransportReplicationAction

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

Overrides:

indexBlockLevel in class TransportReplicationAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>