com.hazelcast.spi.hotrestart.impl.gc

Class BackupExecutor

java.lang.Object

com.hazelcast.spi.hotrestart.impl.gc.BackupExecutor

All Implemented Interfaces:

com.hazelcast.nio.Disposable

public class BackupExecutor
extends Object
implements com.hazelcast.nio.Disposable

Executor in charge of running backup tasks. This one runs the backup task in a separate thread and exposes its progress by the inProgress() method. Repeated calls of run(BackupTask) will run just one backup task. The currently running task can be interrupted by calling the dispose() method. An instance of this class can be reused by calling run(BackupTask) with a new backup task.

Constructor Summary

Constructors

Constructor and Description
BackupExecutor()

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	getBackupTaskMaxChunkSeq() Returns the maximum chunk seq that the last submitted task will or has backed up
com.hazelcast.hotrestart.BackupTaskState	getBackupTaskState() Returns the current state of the last backup task
boolean	inProgress() Returns if the backup task is in progress.
void	interruptBackupTask(boolean waitForCompletion) Interrupts the backup task if one is currently running.
boolean	isBackupTaskDone() Returns true if the backup task is done (successfully or with failure) or if there is no submitted backup task
boolean	prepareForNewTask() If there is no currently running task, makes a reservation so that following invocations of getBackupTaskState() return BackupTaskState.NOT_STARTED.
void	run(BackupTask task) Runs the backup task.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupExecutor

public BackupExecutor()

Method Detail

run

public void run(BackupTask task)

Runs the backup task. If a backup task is already in progress returns without starting a new task. The backup task can be interrupted by calling dispose(). This method should be run from a single thread.

Parameters:

task - the backup task to be run

dispose

public void dispose()

Specified by:

dispose in interface com.hazelcast.nio.Disposable

interruptBackupTask

public void interruptBackupTask(boolean waitForCompletion)

Interrupts the backup task if one is currently running. The contents of the target backup directory will be left as-is

Parameters:

waitForCompletion - should this thread block until the backup thread terminates

inProgress

public boolean inProgress()

Returns if the backup task is in progress.

prepareForNewTask

public boolean prepareForNewTask()

If there is no currently running task, makes a reservation so that following invocations of getBackupTaskState() return BackupTaskState.NOT_STARTED. If invoked concurrently, only one invocation will return true, thus enabling prevention of concurrent backup task runs.

Returns:

if the preparation succeeded

getBackupTaskState

public com.hazelcast.hotrestart.BackupTaskState getBackupTaskState()

Returns the current state of the last backup task

getBackupTaskMaxChunkSeq

public long getBackupTaskMaxChunkSeq()

Returns the maximum chunk seq that the last submitted task will or has backed up

isBackupTaskDone

public boolean isBackupTaskDone()

Returns true if the backup task is done (successfully or with failure) or if there is no submitted backup task