Class NoopCheckpointSpi
- java.lang.Object
- 
- org.apache.ignite.spi.IgniteSpiAdapter
- 
- org.apache.ignite.spi.checkpoint.noop.NoopCheckpointSpi
 
 
- 
- All Implemented Interfaces:
- CheckpointSpi,- IgniteSpi
 
 @IgniteSpiNoop @IgniteSpiMultipleInstancesSupport(true) public class NoopCheckpointSpi extends IgniteSpiAdapter implements CheckpointSpi No-op implementation ofCheckpointSpi. This is default implementation since4.5.0version.
- 
- 
Field Summary- 
Fields inherited from class org.apache.ignite.spi.IgniteSpiAdapterignite, igniteInstanceName
 
- 
 - 
Constructor SummaryConstructors Constructor Description NoopCheckpointSpi()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description @org.jetbrains.annotations.Nullable byte[]loadCheckpoint(String key)Loads checkpoint from storage by its unique key.booleanremoveCheckpoint(String key)This method instructs the checkpoint provider to clean saved data for a givenkey.booleansaveCheckpoint(String key, byte[] state, long timeout, boolean overwrite)Saves checkpoint to the storage.voidsetCheckpointListener(CheckpointListener lsnr)Sets the checkpoint listener.NoopCheckpointSpisetName(String name)Sets SPI name.voidspiStart(@Nullable String igniteInstanceName)This method is called to start SPI.voidspiStop()This method is called to stop SPI.StringtoString()- 
Methods inherited from class org.apache.ignite.spi.IgniteSpiAdapteraddTimeoutObject, assertParameter, checkConfigurationConsistency0, clientFailureDetectionTimeout, configInfo, createSpiAttributeName, failureDetectionTimeout, failureDetectionTimeoutEnabled, failureDetectionTimeoutEnabled, getConsistentAttributeNames, getExceptionRegistry, getLocalNode, getName, getNodeAttributes, getSpiContext, ignite, initFailureDetectionTimeout, injectables, injectResources, isNodeStopping, onBeforeStart, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, removeTimeoutObject, started, startInfo, startStopwatch, stopInfo, unregisterMBean
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.ignite.spi.IgniteSpigetName, getNodeAttributes, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized
 
- 
 
- 
- 
- 
Method Detail- 
spiStartpublic void spiStart(@Nullable @Nullable String igniteInstanceName) throws IgniteSpiExceptionThis method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.- Specified by:
- spiStartin interface- IgniteSpi
- Parameters:
- igniteInstanceName- Name of Ignite instance this SPI is being started for (- nullfor default Ignite instance).
- Throws:
- IgniteSpiException- Throws in case of any error during SPI start.
 
 - 
spiStoppublic void spiStop() throws IgniteSpiExceptionThis 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:
- spiStopin interface- IgniteSpi
- Throws:
- IgniteSpiException- Thrown in case of any error during SPI stop.
 
 - 
loadCheckpoint@Nullable public @org.jetbrains.annotations.Nullable byte[] loadCheckpoint(String key) throws IgniteSpiException Loads checkpoint from storage by its unique key.- Specified by:
- loadCheckpointin interface- CheckpointSpi
- Parameters:
- key- Checkpoint key.
- Returns:
- Loaded data or nullif there is no data for a given key.
- Throws:
- IgniteSpiException- Thrown in case of any error while loading checkpoint data. Note that in case when given- keyis not found this method will return- null.
 
 - 
saveCheckpointpublic boolean saveCheckpoint(String key, byte[] state, long timeout, boolean overwrite) Saves checkpoint to the storage.- Specified by:
- saveCheckpointin interface- CheckpointSpi
- 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- 0means that timeout will never expire.
- overwrite- Whether or not overwrite checkpoint if it already exists.
- Returns:
- trueif checkpoint has been actually saved,- falseotherwise.
 
 - 
removeCheckpointpublic boolean removeCheckpoint(String key) This method instructs the checkpoint provider to clean saved data for a givenkey.- Specified by:
- removeCheckpointin interface- CheckpointSpi
- Parameters:
- key- Key for the checkpoint to remove.
- Returns:
- trueif data has been actually removed,- falseotherwise.
 
 - 
setCheckpointListenerpublic void setCheckpointListener(CheckpointListener lsnr) Sets the checkpoint listener.- Specified by:
- setCheckpointListenerin interface- CheckpointSpi
- Parameters:
- lsnr- The listener to set or- null.
 
 - 
setNamepublic NoopCheckpointSpi setName(String name) Sets SPI name.- Overrides:
- setNamein class- IgniteSpiAdapter
- Parameters:
- name- SPI name.
- Returns:
- thisfor chaining.
 
 
- 
 
-