Package javax.batch.api.chunk
Class AbstractCheckpointAlgorithm
java.lang.Object
javax.batch.api.chunk.AbstractCheckpointAlgorithm
- All Implemented Interfaces:
CheckpointAlgorithm
The AbstractCheckpointAlgorithm provides default
implementations of less commonly implemented
methods.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Override this method for the CheckpointAlgorithm to do something before a checkpoint begins.int
Override this method if the CheckpointAlgorithm establishes a checkpoint timeout.void
Override this method for the CheckpointAlgorithm to do something after a checkpoint ends.abstract boolean
Implement logic in this method to decide if a checkpoint should be taken now.
-
Constructor Details
-
AbstractCheckpointAlgorithm
public AbstractCheckpointAlgorithm()
-
-
Method Details
-
checkpointTimeout
Override this method if the CheckpointAlgorithm establishes a checkpoint timeout. The default implementation returns 0, which means maximum permissible timeout allowed by runtime environment.- Specified by:
checkpointTimeout
in interfaceCheckpointAlgorithm
- Returns:
- the timeout interval to use for the next checkpoint interval
- Throws:
Exception
- (or subclass) if an error occurs.
-
beginCheckpoint
Override this method for the CheckpointAlgorithm to do something before a checkpoint begins. The default implementation does nothing.- Specified by:
beginCheckpoint
in interfaceCheckpointAlgorithm
- Throws:
Exception
- (or subclass) if an error occurs.
-
isReadyToCheckpoint
Implement logic in this method to decide if a checkpoint should be taken now.- Specified by:
isReadyToCheckpoint
in interfaceCheckpointAlgorithm
- Returns:
- boolean indicating whether or not to checkpoint now.
- Throws:
Exception
- (or subclass) if an error occurs.
-
endCheckpoint
Override this method for the CheckpointAlgorithm to do something after a checkpoint ends. The default implementation does nothing.- Specified by:
endCheckpoint
in interfaceCheckpointAlgorithm
- Throws:
Exception
- (or subclass) if an error occurs.
-