Package javax.batch.api.chunk
Class AbstractCheckpointAlgorithm
- java.lang.Object
-
- javax.batch.api.chunk.AbstractCheckpointAlgorithm
-
- All Implemented Interfaces:
CheckpointAlgorithm
public abstract class AbstractCheckpointAlgorithm extends java.lang.Object implements CheckpointAlgorithm
The AbstractCheckpointAlgorithm provides default implementations of less commonly implemented methods.
-
-
Constructor Summary
Constructors Constructor Description AbstractCheckpointAlgorithm()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
beginCheckpoint()
Override this method for the CheckpointAlgorithm to do something before a checkpoint begins.int
checkpointTimeout()
Override this method if the CheckpointAlgorithm establishes a checkpoint timeout.void
endCheckpoint()
Override this method for the CheckpointAlgorithm to do something after a checkpoint ends.abstract boolean
isReadyToCheckpoint()
Implement logic in this method to decide if a checkpoint should be taken now.
-
-
-
Method Detail
-
checkpointTimeout
public int checkpointTimeout() throws java.lang.Exception
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:
java.lang.Exception
- (or subclass) if an error occurs.
-
beginCheckpoint
public void beginCheckpoint() throws java.lang.Exception
Override this method for the CheckpointAlgorithm to do something before a checkpoint begins. The default implementation does nothing.- Specified by:
beginCheckpoint
in interfaceCheckpointAlgorithm
- Throws:
java.lang.Exception
- (or subclass) if an error occurs.
-
isReadyToCheckpoint
public abstract boolean isReadyToCheckpoint() throws java.lang.Exception
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:
java.lang.Exception
- (or subclass) if an error occurs.
-
endCheckpoint
public void endCheckpoint() throws java.lang.Exception
Override this method for the CheckpointAlgorithm to do something after a checkpoint ends. The default implementation does nothing.- Specified by:
endCheckpoint
in interfaceCheckpointAlgorithm
- Throws:
java.lang.Exception
- (or subclass) if an error occurs.
-
-