- java.lang.Object
-
- javax.batch.api.chunk.AbstractCheckpointAlgorithm
-
- All Implemented Interfaces:
- CheckpointAlgorithm
public abstract class AbstractCheckpointAlgorithm extends Object implements CheckpointAlgorithm
The AbstractCheckpointAlgorithm provides default implementations of less commonly implemented methods.
-
-
Constructor Summary
Constructors Constructor and Description AbstractCheckpointAlgorithm()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and 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 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:
Exception
- (or subclass) if an error occurs.
-
beginCheckpoint
public void beginCheckpoint() throws 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:
Exception
- (or subclass) if an error occurs.
-
isReadyToCheckpoint
public abstract boolean isReadyToCheckpoint() throws 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:
Exception
- (or subclass) if an error occurs.
-
endCheckpoint
public void endCheckpoint() throws 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:
Exception
- (or subclass) if an error occurs.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/batch/api/chunk/AbstractCheckpointAlgorithm.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.