Package org.opensearch.action.support.replication

Class TransportWriteAction.WriteActionReplicasProxy

java.lang.Object

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

org.opensearch.action.support.replication.TransportWriteAction.WriteActionReplicasProxy

All Implemented Interfaces:

ReplicationOperation.Replicas<ReplicaRequest>

Enclosing class:

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

protected class TransportWriteAction.WriteActionReplicasProxy
extends TransportReplicationAction<Request,ReplicaRequest,Response>.ReplicasProxy

A proxy for write operations that need to be performed on the replicas, where a failure to execute the operation should fail the replica shard and/or mark the replica as stale.

This extends TransportReplicationAction.ReplicasProxy to do the failing and stale-ing.

Opensearch.internal:

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteActionReplicasProxy()

Method Summary

Modifier and Type	Method	Description
void	failShardIfNeeded(ShardRouting replica, long primaryTerm, String message, Exception exception, org.opensearch.core.action.ActionListener<Void> listener)	Fail the specified shard if needed, removing it from the current set of active shards.
void	markShardCopyAsStaleIfNeeded(org.opensearch.core.index.shard.ShardId shardId, String allocationId, long primaryTerm, org.opensearch.core.action.ActionListener<Void> listener)	Marks shard copy as stale if needed, removing its allocation id from the set of in-sync allocation ids.

Methods inherited from class org.opensearch.action.support.replication.TransportReplicationAction.ReplicasProxy

performOn

Methods inherited from class java.lang.Object

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

Constructor Details

WriteActionReplicasProxy

protected WriteActionReplicasProxy()

Method Details

failShardIfNeeded

public void failShardIfNeeded(ShardRouting replica,
 long primaryTerm,
 String message,
 Exception exception,
 org.opensearch.core.action.ActionListener<Void> listener)

Description copied from interface: ReplicationOperation.Replicas

Fail the specified shard if needed, removing it from the current set of active shards. Whether a failure is needed is left up to the implementation.

Specified by:

failShardIfNeeded in interface ReplicationOperation.Replicas<ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>>

Overrides:

failShardIfNeeded in class TransportReplicationAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>.ReplicasProxy

Parameters:

replica - shard to fail

primaryTerm - the primary term

message - a (short) description of the reason

exception - the original exception which caused the ReplicationOperation to request the shard to be failed

listener - a listener that will be notified when the failing shard has been removed from the in-sync set

markShardCopyAsStaleIfNeeded

public void markShardCopyAsStaleIfNeeded(org.opensearch.core.index.shard.ShardId shardId,
 String allocationId,
 long primaryTerm,
 org.opensearch.core.action.ActionListener<Void> listener)

Description copied from interface: ReplicationOperation.Replicas

Marks shard copy as stale if needed, removing its allocation id from the set of in-sync allocation ids. Whether marking as stale is needed is left up to the implementation.

Specified by:

markShardCopyAsStaleIfNeeded in interface ReplicationOperation.Replicas<ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>>

Overrides:

markShardCopyAsStaleIfNeeded in class TransportReplicationAction<Request extends ReplicatedWriteRequest<Request>,ReplicaRequest extends ReplicatedWriteRequest<ReplicaRequest>,Response extends ReplicationResponse & WriteResponse>.ReplicasProxy

Parameters:

shardId - shard id

allocationId - allocation id to remove from the set of in-sync allocation ids

primaryTerm - the primary term

listener - a listener that will be notified when the failing shard has been removed from the in-sync set