Interface CheckpointAlgorithm

Method Detail

• checkpointTimeout

  int checkpointTimeout()
                 throws Exception

  The checkpointTimeout is invoked at the beginning of a new checkpoint interval for the purpose of establishing the checkpoint timeout. It is invoked before the next checkpoint transaction begins. This method returns an integer value, which is the timeout value that will be used for the next checkpoint transaction. This method is useful to automate the setting of the checkpoint timeout based on factors known outside the job * definition.

  Parameters:

  timeout - specifies the checkpoint timeout value for the * next checkpoint interval.

  Returns:

  the timeout interval to use for the next checkpoint interval

  Throws:

  Exception - thrown for any errors.

• beginCheckpoint

  void beginCheckpoint()
                throws Exception

  The beginCheckpoint method is invoked before the next checkpoint interval begins.

  Throws:

  Exception - thrown for any errors.

• isReadyToCheckpoint

  boolean isReadyToCheckpoint()
                       throws Exception

  The isReadyToCheckpoint method is invoked by the batch runtime after each item processed to determine if now is the time to checkpoint the current chunk.

  Returns:

  boolean indicating whether or not to checkpoint now.

  Throws:

  Exception - thrown for any errors.

• endCheckpoint

  void endCheckpoint()
              throws Exception

  The endCheckpoint method is invoked after the current checkpoint ends.

  Throws:

  Exception - thrown for any errors.