Package org.elasticsearch.index.seqno

Class RetentionLeaseSyncAction

java.lang.Object

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

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

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

org.elasticsearch.index.seqno.RetentionLeaseSyncAction

public class RetentionLeaseSyncAction
extends TransportWriteAction<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>

Write action responsible for syncing retention leases to replicas. This action is deliberately a write action so that if a replica misses a retention lease sync then that shard will be marked as stale.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RetentionLeaseSyncAction.Request
static class	RetentionLeaseSyncAction.Response

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

TransportWriteAction.WritePrimaryResult<ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>, TransportWriteAction.WriteReplicaResult<ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>>

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACTION_NAME

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

clusterService, executor, indicesService, shardStateAction, threadPool, transportOptions, transportPrimaryAction, transportReplicaAction, transportService

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

actionName, logger, taskManager

Constructor Summary

Constructors

Constructor	Description
RetentionLeaseSyncAction(Settings settings, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, ActionFilters actionFilters)

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(Task parentTask, RetentionLeaseSyncAction.Request request, ActionListener<RetentionLeaseSyncAction.Response> listener)
protected org.apache.logging.log4j.Logger	getLogger()
ClusterBlockLevel	indexBlockLevel()	Index level block to check before request execution.
protected RetentionLeaseSyncAction.Response	newResponseInstance(StreamInput in)
protected void	shardOperationOnPrimary(RetentionLeaseSyncAction.Request request, IndexShard primary, ActionListener<TransportReplicationAction.PrimaryResult<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>> listener)	Called on the primary with a reference to the primary IndexShard to modify.
protected TransportWriteAction.WriteReplicaResult<RetentionLeaseSyncAction.Request>	shardOperationOnReplica(RetentionLeaseSyncAction.Request 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.TransportWriteAction

globalBlockLevel, locationToSync, newReplicasProxy, syncOperationResultOrThrow

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

acquirePrimaryOperationPermit, acquireReplicaOperationPermit, adaptResponse, handleOperationRequest, handlePrimaryRequest, handleReplicaRequest, resolveRequest, retryPrimaryException, transportOptions, wrapResponseActionListener

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 Details

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

Constructor Details

RetentionLeaseSyncAction

@Inject public RetentionLeaseSyncAction(Settings settings, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, ActionFilters actionFilters)

Method Details

getLogger

protected org.apache.logging.log4j.Logger getLogger()

doExecute

protected void doExecute(Task parentTask, RetentionLeaseSyncAction.Request request, ActionListener<RetentionLeaseSyncAction.Response> listener)

Overrides:

doExecute in class TransportReplicationAction<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>

shardOperationOnPrimary

protected void shardOperationOnPrimary(RetentionLeaseSyncAction.Request request, IndexShard primary, ActionListener<TransportReplicationAction.PrimaryResult<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>> listener)

Description copied from class: TransportWriteAction

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

Specified by:

shardOperationOnPrimary in class TransportWriteAction<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>

Parameters:

request - the request to the primary shard

primary - the primary shard to perform the operation on

listener - listener for 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

shardOperationOnReplica

protected TransportWriteAction.WriteReplicaResult<RetentionLeaseSyncAction.Request> shardOperationOnReplica(RetentionLeaseSyncAction.Request request, IndexShard replica) throws WriteStateException

Description copied from class: TransportWriteAction

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

Specified by:

shardOperationOnReplica in class TransportWriteAction<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>

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:

WriteStateException

indexBlockLevel

public 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 TransportWriteAction<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>

newResponseInstance

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

Specified by:

newResponseInstance in class TransportReplicationAction<RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Request,RetentionLeaseSyncAction.Response>

Throws:

java.io.IOException