Package org.apache.ignite.internal.processors.cache.persistence.snapshot

Class AbstractCreateSnapshotFutureTask

java.lang.Object

org.apache.ignite.internal.util.future.GridFutureAdapter<T>

org.apache.ignite.internal.processors.cache.persistence.snapshot.AbstractCreateSnapshotFutureTask

All Implemented Interfaces:

IgniteInternalFuture<SnapshotFutureTaskResult>

Direct Known Subclasses:

CreateDumpFutureTask

public abstract class AbstractCreateSnapshotFutureTask
extends GridFutureAdapter<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected GridCacheSharedContext<?,?>	cctx	Shared context.
protected CompletableFuture<Void>	closeFut	Future which will be completed when task requested to be closed.
protected AtomicReference<Throwable>	err	An exception which has been occurred during snapshot processing.
protected IgniteLogger	log	Ignite logger.
protected Map<Integer,Set<Integer>>	parts	Partition to be processed.
protected Map<Integer,Set<Integer>>	processed	Cache group and corresponding partitions collected under the PME lock.
protected UUID	reqId	Snapshot operation request ID.
protected String	snpName	Unique identifier of snapshot process.
protected SnapshotSender	snpSndr	Snapshot data sender.
protected UUID	srcNodeId	Node id which cause snapshot operation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCreateSnapshotFutureTask(GridCacheSharedContext<?,?> cctx, UUID srcNodeId, UUID reqId, String snpName, SnapshotSender snpSndr, Map<Integer,Set<Integer>> parts)

Method Summary

Modifier and Type	Method	Description
void	acceptException(Throwable th)
Set<Integer>	affectedCacheGroups()
boolean	cancel()	Default no-op implementation that always returns false.
protected abstract CompletableFuture<Void>	closeAsync()
protected void	processPartitions()
UUID	requestId()
protected CompletableFuture<Void>	runAsync(IgniteThrowableRunner task)
protected abstract List<CompletableFuture<Void>>	saveCacheConfigs()
protected abstract List<CompletableFuture<Void>>	saveGroup(int grpId, Set<Integer> grpParts)
protected void	saveSnapshotData()	Starts async execution of all tasks required to create snapshot.
String	snapshotName()
UUID	sourceNodeId()
abstract boolean	start()	Initiates snapshot task.
protected boolean	stopping()
String	toString()

Methods inherited from class org.apache.ignite.internal.util.future.GridFutureAdapter

chain, chain, chain, chain, chainCompose, chainCompose, error, get, get, get, getUninterruptibly, ignoreInterrupts, isCancelled, isDone, isFailed, listen, listen, logger, onCancelled, onDone, onDone, onDone, onDone, onDone, reset, result

Methods inherited from class java.lang.Object

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

Field Detail

processed

protected final Map<Integer,Set<Integer>> processed

Cache group and corresponding partitions collected under the PME lock. For full snapshot additional checkpoint write lock required.

See Also:

CheckpointListener.onMarkCheckpointBegin(CheckpointListener.Context)

closeFut

protected volatile CompletableFuture<Void> closeFut

Future which will be completed when task requested to be closed. Will be executed on system pool.

cctx

protected final GridCacheSharedContext<?,?> cctx

Shared context.

log

protected final IgniteLogger log

Ignite logger.

srcNodeId

protected final UUID srcNodeId

Node id which cause snapshot operation.

reqId

protected final UUID reqId

Snapshot operation request ID.

snpName

protected final String snpName

Unique identifier of snapshot process.

snpSndr

@GridToStringExclude
protected final SnapshotSender snpSndr

Snapshot data sender.

parts

protected final Map<Integer,Set<Integer>> parts

Partition to be processed.

err

protected final AtomicReference<Throwable> err

An exception which has been occurred during snapshot processing.

Constructor Detail

AbstractCreateSnapshotFutureTask

protected AbstractCreateSnapshotFutureTask(GridCacheSharedContext<?,?> cctx,
                                           UUID srcNodeId,
                                           UUID reqId,
                                           String snpName,
                                           SnapshotSender snpSndr,
                                           Map<Integer,Set<Integer>> parts)

Parameters:

cctx - Shared context.

srcNodeId - Node id which cause snapshot task creation.

reqId - Snapshot operation request ID.

snpName - Snapshot name.

snpSndr - Factory which produces snapshot sender instance.

parts - Partitions to be processed.

Method Detail

saveCacheConfigs

protected abstract List<CompletableFuture<Void>> saveCacheConfigs()

saveGroup

protected abstract List<CompletableFuture<Void>> saveGroup(int grpId,
                                                           Set<Integer> grpParts)
                                                    throws IgniteCheckedException

Throws:

IgniteCheckedException

cancel

public boolean cancel()

Default no-op implementation that always returns false. Futures that do support cancellation should override this method and call GridFutureAdapter.onCancelled() callback explicitly if cancellation indeed did happen.

Specified by:

cancel in interface IgniteInternalFuture<SnapshotFutureTaskResult>

Returns:

True if future was canceled (i.e. was not finished prior to this call).

closeAsync

protected abstract CompletableFuture<Void> closeAsync()

Returns:

Future which will be completed when operations truly stopped.

stopping

protected boolean stopping()

Returns:

true if current task requested to be stopped.

processPartitions

protected void processPartitions()
                          throws IgniteCheckedException

Throws:

IgniteCheckedException

saveSnapshotData

protected void saveSnapshotData()

Starts async execution of all tasks required to create snapshot.

acceptException

public void acceptException(Throwable th)

Parameters:

th - An exception which occurred during snapshot processing.

runAsync

protected CompletableFuture<Void> runAsync(IgniteThrowableRunner task)

snapshotName

public String snapshotName()

Returns:

Snapshot name.

sourceNodeId

public UUID sourceNodeId()

Returns:

Node id which triggers this operation.

requestId

public UUID requestId()

Returns:

Snapshot operation request ID.

affectedCacheGroups

public Set<Integer> affectedCacheGroups()

Returns:

Set of cache groups included into snapshot operation.

start

public abstract boolean start()

Initiates snapshot task.

Returns:

true if task started by this call.

toString

public String toString()

Overrides:

toString in class GridFutureAdapter<T>