com.ibm.di.store
Class CheckpointRestart

java.lang.Object
  extended by com.ibm.di.store.CheckpointRestart

public class CheckpointRestart
extends Object

The CheckpointRestart class provides methods to store and retrieve java objects for use in a checkpoint/restart context. The class


Field Summary
static String DEFAULT_CHECKPOINT_TABLE
           
 
Constructor Summary
CheckpointRestart()
           
CheckpointRestart(String identifier, Log log)
           
CheckpointRestart(String identifier, Log log, boolean initialize)
           
CheckpointRestart(String identifier, Log log, boolean initialize, boolean create)
           
 
Method Summary
 void checkpointRSI(String src, Entry rsi)
          Checkpoints the restart-info object
 void checkpointState(ALState state)
          Checkpoints the ALState object
 void checkpointTCB(TaskCallBlock tcb)
          Checkpoints the TCB
 void checkpointWork(Entry work)
          Checkpoints the work entry
 void close()
           
 void commit()
          Commits the checkpoint information
 void dropTable()
           
 boolean exists()
           
 ALState getALState()
          Returns the old ALState object.
 Log getLog()
           
 Entry getRSI(String src)
           
 String getRSIID(String name)
          Returns the connector RSI id
 TaskCallBlock getTCB(AssemblyLineConfig alc, TaskInterface task)
           
 Entry getUserEntry()
           
 Entry getWorkEntry()
           
 void initializeCheckpoint(String identifier, Log log, boolean initialize, boolean create)
           
 void initIdentifier()
          Make sure we have the "master" row in our table
 void initUserEntry()
          Create a slot for the user entry
 boolean isInitialized()
           
 void setLog(Log log)
           
 void setUserEntry(Entry e)
           
 boolean wasCreated()
          Returns true if the checkpoint table did not exist and was created.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_CHECKPOINT_TABLE

public static final String DEFAULT_CHECKPOINT_TABLE
See Also:
Constant Field Values
Constructor Detail

CheckpointRestart

public CheckpointRestart()

CheckpointRestart

public CheckpointRestart(String identifier,
                         Log log)
                  throws Exception
Throws:
Exception

CheckpointRestart

public CheckpointRestart(String identifier,
                         Log log,
                         boolean initialize)
                  throws Exception
Throws:
Exception

CheckpointRestart

public CheckpointRestart(String identifier,
                         Log log,
                         boolean initialize,
                         boolean create)
                  throws Exception
Throws:
Exception
Method Detail

initializeCheckpoint

public void initializeCheckpoint(String identifier,
                                 Log log,
                                 boolean initialize,
                                 boolean create)
                          throws Exception
Throws:
Exception

dropTable

public void dropTable()
               throws Exception
Throws:
Exception

exists

public boolean exists()
               throws Exception
Throws:
Exception

wasCreated

public boolean wasCreated()
Returns true if the checkpoint table did not exist and was created.


close

public void close()

initIdentifier

public void initIdentifier()
                    throws Exception
Make sure we have the "master" row in our table

Throws:
Exception

getRSIID

public String getRSIID(String name)
Returns the connector RSI id


checkpointState

public void checkpointState(ALState state)
                     throws Exception
Checkpoints the ALState object

Throws:
Exception

checkpointWork

public void checkpointWork(Entry work)
                    throws Exception
Checkpoints the work entry

Throws:
Exception

checkpointRSI

public void checkpointRSI(String src,
                          Entry rsi)
                   throws Exception
Checkpoints the restart-info object

Throws:
Exception

checkpointTCB

public void checkpointTCB(TaskCallBlock tcb)
                   throws Exception
Checkpoints the TCB

Throws:
Exception

commit

public void commit()
            throws Exception
Commits the checkpoint information

Throws:
Exception

getALState

public ALState getALState()
Returns the old ALState object.


getWorkEntry

public Entry getWorkEntry()

getTCB

public TaskCallBlock getTCB(AssemblyLineConfig alc,
                            TaskInterface task)

getRSI

public Entry getRSI(String src)
             throws Exception
Throws:
Exception

setLog

public void setLog(Log log)

getLog

public Log getLog()

isInitialized

public boolean isInitialized()

initUserEntry

public void initUserEntry()
                   throws Exception
Create a slot for the user entry

Throws:
Exception

setUserEntry

public void setUserEntry(Entry e)
                  throws Exception
Throws:
Exception

getUserEntry

public Entry getUserEntry()
                   throws Exception
Throws:
Exception