Package org.opensearch.indices.replication.common

Class ReplicationTarget

java.lang.Object

org.opensearch.common.util.concurrent.AbstractRefCounted

org.opensearch.indices.replication.common.ReplicationTarget

All Implemented Interfaces:

org.opensearch.common.util.concurrent.RefCounted

Direct Known Subclasses:

RecoveryTarget, SegmentReplicationTarget

public abstract class ReplicationTarget
extends org.opensearch.common.util.concurrent.AbstractRefCounted

Represents the target of a replication operation performed on a shard

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
protected final CancellableThreads	cancellableThreads
protected final AtomicBoolean	finished
protected final IndexShard	indexShard
protected final ReplicationListener	listener
protected final org.apache.logging.log4j.Logger	logger
protected final ReplicationLuceneIndex	stateIndex
protected final Store	store

Constructor Summary

Constructors

Constructor	Description
ReplicationTarget(String name, IndexShard indexShard, ReplicationLuceneIndex stateIndex, ReplicationListener listener)

Method Summary

Modifier and Type	Method	Description
void	cancel(String reason)	cancel the replication.
CancellableThreads	cancellableThreads()
protected void	closeInternal()
org.opensearch.core.action.ActionListener<Void>	createOrFinishListener(TransportChannel channel, String action, RecoveryTransportRequest request)
org.opensearch.core.action.ActionListener<Void>	createOrFinishListener(TransportChannel channel, String action, RecoveryTransportRequest request, org.opensearch.common.CheckedFunction<Void,org.opensearch.core.transport.TransportResponse,Exception> responseFn)
abstract String	description()
protected void	ensureRefCount()
void	fail(ReplicationFailedException e, boolean sendShardFailure)	fail the replication and call listener
long	getId()
ReplicationListener	getListener()
protected abstract String	getPrefix()
void	handleFileChunk(FileChunkRequest request, ReplicationTarget replicationTarget, AtomicLong bytesSinceLastPause, org.apache.lucene.store.RateLimiter rateLimiter, org.opensearch.core.action.ActionListener<Void> listener)	Handle a FileChunkRequest for a ReplicationTarget.
IndexShard	indexShard()
long	lastAccessTime()	return the last time this ReplicationStatus was used (based on System.nanoTime()
void	markAsDone()	mark the current replication as done
org.opensearch.core.action.ActionListener<Void>	markRequestReceivedAndCreateListener(long requestSeqNo, org.opensearch.core.action.ActionListener<Void> listener)
abstract void	notifyListener(ReplicationFailedException e, boolean sendShardFailure)
protected void	onCancel(String reason)
protected abstract void	onDone()
abstract boolean	reset(CancellableThreads newTargetCancellableThreads)
abstract ReplicationTarget	retryCopy()
void	setLastAccessTime()	sets the lasAccessTime flag to now
org.opensearch.core.index.shard.ShardId	shardId()
abstract ReplicationState	state()
Store	store()
abstract void	writeFileChunk(StoreFileMetadata metadata, long position, org.opensearch.core.common.bytes.BytesReference content, boolean lastChunk, int totalTranslogOps, org.opensearch.core.action.ActionListener<Void> listener)

Methods inherited from class org.opensearch.common.util.concurrent.AbstractRefCounted

alreadyClosed, decRef, getName, incRef, refCount, tryIncRef

Methods inherited from class java.lang.Object

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

Field Details

finished

protected final AtomicBoolean finished

indexShard

protected final IndexShard indexShard

store

protected final Store store

listener

protected final ReplicationListener listener

logger

protected final org.apache.logging.log4j.Logger logger

cancellableThreads

protected final CancellableThreads cancellableThreads

stateIndex

protected final ReplicationLuceneIndex stateIndex

Constructor Details

ReplicationTarget

public ReplicationTarget(String name,
 IndexShard indexShard,
 ReplicationLuceneIndex stateIndex,
 ReplicationListener listener)

Method Details

getPrefix

protected abstract String getPrefix()

onDone

protected abstract void onDone()

onCancel

protected void onCancel(String reason)

state

public abstract ReplicationState state()

retryCopy

public abstract ReplicationTarget retryCopy()

description

public abstract String description()

getListener

public ReplicationListener getListener()

cancellableThreads

public CancellableThreads cancellableThreads()

notifyListener

public abstract void notifyListener(ReplicationFailedException e,
 boolean sendShardFailure)

getId

public long getId()

reset

public abstract boolean reset(CancellableThreads newTargetCancellableThreads)
                       throws IOException

Throws:

IOException

lastAccessTime

public long lastAccessTime()

return the last time this ReplicationStatus was used (based on System.nanoTime()

setLastAccessTime

public void setLastAccessTime()

sets the lasAccessTime flag to now

markRequestReceivedAndCreateListener

@Nullable
public org.opensearch.core.action.ActionListener<Void> markRequestReceivedAndCreateListener(long requestSeqNo,
 org.opensearch.core.action.ActionListener<Void> listener)

indexShard

public IndexShard indexShard()

store

public Store store()

shardId

public org.opensearch.core.index.shard.ShardId shardId()

markAsDone

public void markAsDone()

mark the current replication as done

cancel

public void cancel(String reason)

cancel the replication. calling this method will clean temporary files and release the store unless this object is in use (in which case it will be cleaned once all ongoing users call AbstractRefCounted.decRef()

fail

public void fail(ReplicationFailedException e,
 boolean sendShardFailure)

fail the replication and call listener

Parameters:

e - exception that encapsulates the failure

sendShardFailure - indicates whether to notify the master of the shard failure

ensureRefCount

protected void ensureRefCount()

createOrFinishListener

@Nullable
public org.opensearch.core.action.ActionListener<Void> createOrFinishListener(TransportChannel channel,
 String action,
 RecoveryTransportRequest request)

createOrFinishListener

@Nullable
public org.opensearch.core.action.ActionListener<Void> createOrFinishListener(TransportChannel channel,
 String action,
 RecoveryTransportRequest request,
 org.opensearch.common.CheckedFunction<Void,org.opensearch.core.transport.TransportResponse,Exception> responseFn)

handleFileChunk

public void handleFileChunk(FileChunkRequest request,
 ReplicationTarget replicationTarget,
 AtomicLong bytesSinceLastPause,
 org.apache.lucene.store.RateLimiter rateLimiter,
 org.opensearch.core.action.ActionListener<Void> listener)
                     throws IOException

Handle a FileChunkRequest for a ReplicationTarget.

Parameters:

request - FileChunkRequest Request containing the file chunk.

bytesSinceLastPause - AtomicLong Bytes since the last pause.

rateLimiter - RateLimiter Rate limiter.

listener - ActionListener listener that completes when the chunk has been written.

Throws:

IOException - When there is an issue pausing the rate limiter.

writeFileChunk

public abstract void writeFileChunk(StoreFileMetadata metadata,
 long position,
 org.opensearch.core.common.bytes.BytesReference content,
 boolean lastChunk,
 int totalTranslogOps,
 org.opensearch.core.action.ActionListener<Void> listener)

closeInternal

protected void closeInternal()

Specified by:

closeInternal in class org.opensearch.common.util.concurrent.AbstractRefCounted