org.gridgain.grid.spi.checkpoint.noop

Class GridNoopCheckpointSpi

java.lang.Object

org.gridgain.grid.spi.GridSpiAdapter

org.gridgain.grid.spi.checkpoint.noop.GridNoopCheckpointSpi

All Implemented Interfaces:

GridCheckpointSpi, GridSpi, GridSpiManagementMBean

@GridSpiNoop
@GridSpiMultipleInstancesSupport(value=true)
public class GridNoopCheckpointSpi
extends GridSpiAdapter
implements GridCheckpointSpi

No-op implementation of GridCheckpointSpi. This is default implementation since 4.5.0 version.

Constructor Summary

Constructors

Constructor and Description
GridNoopCheckpointSpi()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	loadCheckpoint(String key) Loads checkpoint from storage by its unique key.
boolean	removeCheckpoint(String key) This method instructs the checkpoint provider to clean saved data for a given key.
boolean	saveCheckpoint(String key, byte[] state, long timeout, boolean overwrite) Saves checkpoint to the storage.
void	setCheckpointListener(GridCheckpointListener lsnr) Sets the checkpoint listener.
void	spiStart(String gridName) This method is called to start SPI.
void	spiStop() This method is called to stop SPI.
String	toString()

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getSpiContext, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, injectables, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized

Constructor Detail

GridNoopCheckpointSpi

public GridNoopCheckpointSpi()

Method Detail

spiStart

public void spiStart(@Nullable
            String gridName)
              throws GridSpiException

This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.

Specified by:

spiStart in interface GridSpi

Parameters:

gridName - Name of grid instance this SPI is being started for (null for default grid).

Throws:

GridSpiException - Throws in case of any error during SPI start.

spiStop

public void spiStop()
             throws GridSpiException

This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.

Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.

Specified by:

spiStop in interface GridSpi

Throws:

GridSpiException - Thrown in case of any error during SPI stop.

loadCheckpoint

@Nullable
public byte[] loadCheckpoint(String key)
                      throws GridSpiException

Loads checkpoint from storage by its unique key.

Specified by:

loadCheckpoint in interface GridCheckpointSpi

Parameters:

key - Checkpoint key.

Returns:

Loaded data or null if there is no data for a given key.

Throws:

GridSpiException - Thrown in case of any error while loading checkpoint data. Note that in case when given key is not found this method will return null.

saveCheckpoint

public boolean saveCheckpoint(String key,
                     byte[] state,
                     long timeout,
                     boolean overwrite)
                       throws GridSpiException

Saves checkpoint to the storage.

Specified by:

saveCheckpoint in interface GridCheckpointSpi

Parameters:

key - Checkpoint unique key.

state - Saved data.

timeout - Every intermediate data stored by checkpoint provider should have a timeout. Timeout allows for effective resource management by checkpoint provider by cleaning saved data that are not needed anymore. Generally, the user should choose the minimum possible timeout to avoid long-term resource acquisition by checkpoint provider. Value 0 means that timeout will never expire.

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

Returns:

true if checkpoint has been actually saved, false otherwise.

Throws:

GridSpiException - Thrown in case of any error while saving checkpoint data.

removeCheckpoint

public boolean removeCheckpoint(String key)

This method instructs the checkpoint provider to clean saved data for a given key.

Specified by:

removeCheckpoint in interface GridCheckpointSpi

Parameters:

key - Key for the checkpoint to remove.

Returns:

true if data has been actually removed, false otherwise.

setCheckpointListener

public void setCheckpointListener(GridCheckpointListener lsnr)

Sets the checkpoint listener.

Specified by:

setCheckpointListener in interface GridCheckpointSpi

Parameters:

lsnr - The listener to set or null.

toString

public String toString()

Overrides:

toString in class Object