com.ibm.ims.dli.tm

Interface Transaction

public interface Transaction

This interface provides support for transactions that are managed internal to IMS, and do not require an external transaction manager. Use this interface to issue commit (SYNC) and rollback (ROLB) DL/I calls, as well as symbolic checkpoint (CHKP) and restart (XRST) calls.

For more details and a code example for rollback in a JMP application, see the topic "Rolling back IMS changes in a JMP application" in the IMS Application Programming guide documentation.

For more details and a code sample for JBP symbolic checkpoint and restart, see the topic "Developing JBP applications with the IMS Java dependent region resource adapter" in the IMS Application Programming guide documentation.

Method Summary

Modifier and Type	Method and Description
void	abend() Abnormally terminates the application by making a "ROLL" call.
void	checkpoint() Issues a checkpoint call for a Java batch message processing (JBP) application that uses symbolic checkpoints.
void	checkpoint(SaveArea saveArea) Issues a checkpoint call for a Java batch message processing (JBP) application that uses symbolic checkpoints.
void	commit() Commits an IMS transaction
AIB	getAIB() Returns the AIB instance associated with the most recent DL/I call.
SaveArea	getSaveArea() Returns the SaveArea object that is used during CHKP or XRST calls to checkpoint the application data objects.
SaveArea	restart() Issues a restart call for a Java batch message processing (JBP) application that uses symbolic checkpoints.
void	rollback() Rolls back an IMS transaction

Method Detail

commit

void commit()
     throws DLIException

Commits an IMS transaction

Throws:

com.ibm.ims.dli.tm.TMException - if the operation fails

DLIException

rollback

void rollback()
       throws DLIException

Rolls back an IMS transaction

Throws:

com.ibm.ims.dli.tm.TMException - if the operation fails

DLIException

checkpoint

void checkpoint()
         throws DLIException

Issues a checkpoint call for a Java batch message processing (JBP) application that uses symbolic checkpoints. For JBP applications that use symbolic checkpoint or restart, call this method at intervals to write checkpoints to the IMS log.

This version of the checkpoint method does not take any parameters. Use this method when your application needs to take checkpoints without having to specify a checkpoint ID and without having to save any application state information.

If this method is used to take checkpoints, when restarting, use the 4-character constant "LAST" as the checkpoint ID for restart.

Before taking any checkpoints, you must issue an initial restart() call to notify IMS that your application intends to use symbolic checkpoints.

If your application needs to save application objects, use the other form of the checkpoint method: @link {Transaction#checkpoint(SaveArea)}.

Throws:

IMSException - if the checkpoint ID is invalid, or if an IMS call returns a non-blank status code.

DLIException

checkpoint

void checkpoint(SaveArea saveArea)
         throws DLIException

Issues a checkpoint call for a Java batch message processing (JBP) application that uses symbolic checkpoints. For JBP applications that use symbolic checkpoint or restart, call this method at intervals to write checkpoints to the IMS log.

Use this method when the application needs to take checkpoints without having to specify a checkpoint ID but has to store application state information.

If this method is used to take checkpoints, when restarting, use the 4-character constant "LAST" as the checkpoint ID for restart.

Before taking any checkpoints, you must issue an initial restart() call to notify IMS that your application intends to use symbolic checkpoints.

Parameters:

saveArea - the SaveArea instance to store application state information.

Throws:

IMSException - if the checkpoint ID is invalid, or if an IMS call returns a non-blank status code.

DLIException

restart

SaveArea restart()
          throws DLIException

Issues a restart call for a Java batch message processing (JBP) application that uses symbolic checkpoints.

Use this method in one of the following cases:

• At normal program start, this method tells IMS that subsequent checkpoint calls are symbolic checkpoint calls.
• The restart checkpoint ID (if any) is supplied through the CKPTID= parameter in the JBP region JCL procedure.

Returns:

the SaveArea instance with the application state information to be restored.

Throws:

IMSException - if a non-blank status code is returned from the XRST call.

DLIException

getAIB

AIB getAIB()

Returns the AIB instance associated with the most recent DL/I call. The AIB contains all the data attributes of the IMS application interface block.

Returns:

the AIB instance associated with the most recent DL/I call.

getSaveArea

SaveArea getSaveArea()

Returns the SaveArea object that is used during CHKP or XRST calls to checkpoint the application data objects.

Returns:

the SaveArea instance that stores the application state.

abend

void abend()

Abnormally terminates the application by making a "ROLL" call.