com.infoengine.SAK
Class BasicCheckpointProcessor

java.lang.Object
  extended bycom.infoengine.SAK.BasicCheckpointProcessor
All Implemented Interfaces:
CheckpointProcessor

public class BasicCheckpointProcessor
extends Object
implements CheckpointProcessor


Field Summary
private  String chkptRecoverTask
           
private  String chkptRemoveTask
           
private  String chkptSaveTask
           
 
Constructor Summary
BasicCheckpointProcessor()
          Constructs an instance of the Basic Checkpoint Processor.
 
Method Summary
private  boolean hasChanged(IeCollection collection)
          Returns true if a collection has changed.
 Task recoverState(String uniqueIdentifier)
          Recovers the saved state of a task.
 void removeState(String uniqueIdentifier)
          Removes all state information that might have been saved for a task.
private  void resetChange(IeCollection collection)
          Resets all change indications in a collection.
 void saveState(String uniqueIdentifier, Task task)
          Saves the state of a task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

chkptRemoveTask

private String chkptRemoveTask

chkptRecoverTask

private String chkptRecoverTask

chkptSaveTask

private String chkptSaveTask
Constructor Detail

BasicCheckpointProcessor

public BasicCheckpointProcessor()
Constructs an instance of the Basic Checkpoint Processor.

Method Detail

saveState

public void saveState(String uniqueIdentifier,
                      Task task)
               throws IEException
Saves the state of a task.

Specified by:
saveState in interface CheckpointProcessor
Parameters:
uniqueIdentifier - The unique identifier assigned to the task instance whose state is being saved.
task - The task instance.
Throws:
IEException - if the state was not saved successfully.

hasChanged

private boolean hasChanged(IeCollection collection)
Returns true if a collection has changed.

Parameters:
collection - The collection to check for change
Returns:
true if the collection has changed

resetChange

private void resetChange(IeCollection collection)
Resets all change indications in a collection.

Parameters:
collection - The collection to reset

recoverState

public Task recoverState(String uniqueIdentifier)
                  throws IEException
Recovers the saved state of a task.

Specified by:
recoverState in interface CheckpointProcessor
Parameters:
uniqueIdentifier - The unique identifier assigned to the task instance whose state is being recovered.
Returns:
A Task object containing the recovered VDB and context collections.
Throws:
IEException - if the state was not recovered successfully.

removeState

public void removeState(String uniqueIdentifier)
                 throws IEException
Removes all state information that might have been saved for a task. Normally, this method will be called only when a task is complete.

Specified by:
removeState in interface CheckpointProcessor
Parameters:
uniqueIdentifier - The unique identifier assigned to the task instance whose saved state is being removed.
Throws:
IEException - if the state was not removed successfully.