org.gridgain.grid.kernal.managers.checkpoint

Class GridCheckpointManager

java.lang.Object

org.gridgain.grid.kernal.managers.GridManagerAdapter<GridCheckpointSpi>

org.gridgain.grid.kernal.managers.checkpoint.GridCheckpointManager

All Implemented Interfaces:

GridComponent, GridManager

public class GridCheckpointManager
extends GridManagerAdapter<GridCheckpointSpi>

This class defines a checkpoint manager.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CLOSED_SESS Max closed topics to store.

Fields inherited from class org.gridgain.grid.kernal.managers.GridManagerAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridCheckpointManager(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	loadCheckpoint(GridTaskSessionInternal ses, String key)
void	onSessionEnd(GridTaskSessionInternal ses, boolean cleanup)
void	printMemoryStats() Prints memory statistics (sizes of internal structures, etc.).
boolean	removeCheckpoint(GridTaskSessionInternal ses, String key)
boolean	removeCheckpoint(String key)
Collection<GridUuid>	sessionIds()
void	start() Starts grid component.
void	stop(boolean cancel) Stops grid component.
boolean	storeCheckpoint(GridTaskSessionInternal ses, String key, Object state, GridComputeTaskSessionScope scope, long timeout, boolean override)

Methods inherited from class org.gridgain.grid.kernal.managers.GridManagerAdapter

addSpiAttributes, assertParameter, collectDiscoveryData, enabled, getSpi, getSpi, getSpis, onDiscoveryDataReceived, onKernalStart, onKernalStart0, onKernalStop, onKernalStop0, startInfo, startSpi, stopInfo, stopSpi, toString, validateNode

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CLOSED_SESS

public static final int MAX_CLOSED_SESS

Max closed topics to store.

See Also:

Constant Field Values

Constructor Detail

GridCheckpointManager

public GridCheckpointManager(GridKernalContext ctx)

Parameters:

ctx - Grid kernal context.

Method Detail

start

public void start()
           throws GridException

Starts grid component.

Throws:

GridException - Throws in case of any errors.

stop

public void stop(boolean cancel)
          throws GridException

Stops grid component.

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

GridException - Thrown in case of any errors.

sessionIds

public Collection<GridUuid> sessionIds()

Returns:

Session IDs.

storeCheckpoint

public boolean storeCheckpoint(GridTaskSessionInternal ses,
                      String key,
                      Object state,
                      GridComputeTaskSessionScope scope,
                      long timeout,
                      boolean override)
                        throws GridException

Parameters:

ses - Task session.

key - Checkpoint key.

state - Checkpoint state to save.

scope - Checkpoint scope.

timeout - Checkpoint timeout.

override - Whether or not override checkpoint if it already exists.

Returns:

true if checkpoint has been actually saved, false otherwise.

Throws:

GridException - Thrown in case of any errors.

removeCheckpoint

public boolean removeCheckpoint(String key)

Parameters:

key - Checkpoint key.

Returns:

Whether or not checkpoint was removed.

removeCheckpoint

public boolean removeCheckpoint(GridTaskSessionInternal ses,
                       String key)

Parameters:

ses - Task session.

key - Checkpoint key.

Returns:

Whether or not checkpoint was removed.

loadCheckpoint

@Nullable
public Serializable loadCheckpoint(GridTaskSessionInternal ses,
                                   String key)
                            throws GridException

Parameters:

ses - Task session.

key - Checkpoint key.

Returns:

Loaded checkpoint.

Throws:

GridException - Thrown in case of any errors.

onSessionEnd

public void onSessionEnd(GridTaskSessionInternal ses,
                boolean cleanup)

Parameters:

ses - Task session.

cleanup - Whether cleanup or not.

printMemoryStats

public void printMemoryStats()

Prints memory statistics (sizes of internal structures, etc.). NOTE: this method is for testing and profiling purposes only.

Specified by:

printMemoryStats in interface GridComponent

Overrides:

printMemoryStats in class GridManagerAdapter<GridCheckpointSpi>