org.apache.flink.runtime.checkpoint

Class StandaloneCompletedCheckpointStore

java.lang.Object

org.apache.flink.runtime.checkpoint.StandaloneCompletedCheckpointStore

All Implemented Interfaces:

CompletedCheckpointStore

public class StandaloneCompletedCheckpointStore
extends Object
implements CompletedCheckpointStore

CompletedCheckpointStore for JobManagers running in HighAvailabilityMode.NONE.

Constructor Summary

Constructors

Constructor and Description
StandaloneCompletedCheckpointStore(int maxNumberOfCheckpointsToRetain) Creates StandaloneCompletedCheckpointStore.

Method Summary

Modifier and Type	Method and Description
void	addCheckpoint(CompletedCheckpoint checkpoint) Adds a CompletedCheckpoint instance to the list of completed checkpoints.
List<CompletedCheckpoint>	getAllCheckpoints() Returns all CompletedCheckpoint instances.
CompletedCheckpoint	getLatestCheckpoint() Returns the latest CompletedCheckpoint instance or null if none was added.
int	getMaxNumberOfRetainedCheckpoints() Returns the max number of retained checkpoints.
int	getNumberOfRetainedCheckpoints() Returns the current number of retained checkpoints.
void	recover() Recover available CompletedCheckpoint instances.
boolean	requiresExternalizedCheckpoints() This method returns whether the completed checkpoint store requires checkpoints to be externalized.
void	shutdown(JobStatus jobStatus) Shuts down the store.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandaloneCompletedCheckpointStore

public StandaloneCompletedCheckpointStore(int maxNumberOfCheckpointsToRetain)

Creates StandaloneCompletedCheckpointStore.

Parameters:

maxNumberOfCheckpointsToRetain - The maximum number of checkpoints to retain (at least 1). Adding more checkpoints than this results in older checkpoints being discarded.

Method Detail

recover

public void recover()
             throws Exception

Description copied from interface: CompletedCheckpointStore

Recover available CompletedCheckpoint instances.

After a call to this method, CompletedCheckpointStore.getLatestCheckpoint() returns the latest available checkpoint.

Specified by:

recover in interface CompletedCheckpointStore

Throws:

Exception

addCheckpoint

public void addCheckpoint(CompletedCheckpoint checkpoint)
                   throws Exception

Description copied from interface: CompletedCheckpointStore

Adds a CompletedCheckpoint instance to the list of completed checkpoints.

Only a bounded number of checkpoints is kept. When exceeding the maximum number of retained checkpoints, the oldest one will be discarded.

Specified by:

addCheckpoint in interface CompletedCheckpointStore

Throws:

Exception

getLatestCheckpoint

public CompletedCheckpoint getLatestCheckpoint()

Description copied from interface: CompletedCheckpointStore

Returns the latest CompletedCheckpoint instance or null if none was added.

Specified by:

getLatestCheckpoint in interface CompletedCheckpointStore

getAllCheckpoints

public List<CompletedCheckpoint> getAllCheckpoints()

Description copied from interface: CompletedCheckpointStore

Returns all CompletedCheckpoint instances.

Returns an empty list if no checkpoint has been added yet.

Specified by:

getAllCheckpoints in interface CompletedCheckpointStore

getNumberOfRetainedCheckpoints

public int getNumberOfRetainedCheckpoints()

Description copied from interface: CompletedCheckpointStore

Returns the current number of retained checkpoints.

Specified by:

getNumberOfRetainedCheckpoints in interface CompletedCheckpointStore

getMaxNumberOfRetainedCheckpoints

public int getMaxNumberOfRetainedCheckpoints()

Description copied from interface: CompletedCheckpointStore

Returns the max number of retained checkpoints.

Specified by:

getMaxNumberOfRetainedCheckpoints in interface CompletedCheckpointStore

shutdown

public void shutdown(JobStatus jobStatus)
              throws Exception

Description copied from interface: CompletedCheckpointStore

Shuts down the store.

The job status is forwarded and used to decide whether state should actually be discarded or kept.

Specified by:

shutdown in interface CompletedCheckpointStore

Parameters:

jobStatus - Job state on shut down

Throws:

Exception

requiresExternalizedCheckpoints

public boolean requiresExternalizedCheckpoints()

Description copied from interface: CompletedCheckpointStore

This method returns whether the completed checkpoint store requires checkpoints to be externalized. Externalized checkpoints have their meta data persisted, which the checkpoint store can exploit (for example by simply pointing the persisted metadata).

Specified by:

requiresExternalizedCheckpoints in interface CompletedCheckpointStore

Returns:

True, if the store requires that checkpoints are externalized before being added, false if the store stores the metadata itself.