com.ibm.ims.dli.tm

Interface Application

public interface Application

The Application interface is the starting point of a IMS transaction management application. Use this interface to create the Transaction, MessageQueue and IOMessage objects.

For more details about the programming model for Java message processing (JMP) applications, see the topic "JMP programming models" in the IMS Application Programming guide documentation.

For more details about the programming model for Java batch processing (JBP) applications, 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
IMSCallout	createImsCallout() Retrieves a handle to the IMSCallout object needed to execute an IMS Callout request.
void	end() Ends the life-cycle of the Application instance and frees up any resources associated with it.
void	free31BitDirectByteBuffer(java.nio.ByteBuffer byteBuffer) Frees a 31 bit direct ByteBuffer
java.nio.ByteBuffer	get31BitDirectByteBuffer(int size) Allocates a 31-bit direct ByteBuffer.
AssemblerCall	getAssemblerCall() Retrieves a handle to the AssemblerCall object that represents an assembler module to invoke.
IMSQueueConnectionFactory	getIMSQueueConnectionFactory() Retrieves a handle to the IMSQueueConnectionFactory object that represents a Factory class used to create IMS Point-to-Point messaging domain QueueConnection objects.
IOMessage	getIOMessage(java.lang.String url) Retrieves a handle to the IOMessage object that represents messages that are coming from or going to an IMS message queue.
MessageQueue	getMessageQueue() Retrieves a handle to the MessageQueue object that provides support for IMS message queue processing.
Transaction	getTransaction() Retrieves a handle for the Transaction object that provides support for transactions that are managed by IMS.
DBQueryInfo	inqyDBQuery() Issues a DLI INQY call with the subfunction DBQUERY
DBQueryInfo	inqyDBQuery(boolean throwExceptionOnNonBlankStatus) Issues a DLI INQY call with the subfunction DBQUERY
EnvironInfo	inqyEnviron() Issues a DLI INQY call with the subfunction ENVIRON
FindInfo	inqyFind(java.lang.String pcb) Issues a DLI INQY call with the subfunction FIND
MessageInfo	inqyMessageInfo() Issues a DLI INQY call with the subfunction MSGINFO
com.ibm.ims.dli.ProgramInfo	inqyProgram() Issues a DLI INQY call with the subfunction PROGRAM

Method Detail

getTransaction

Transaction getTransaction()

Retrieves a handle for the Transaction object that provides support for transactions that are managed by IMS.

Returns:

the Transaction object

getMessageQueue

MessageQueue getMessageQueue()

Retrieves a handle to the MessageQueue object that provides support for IMS message queue processing.

Returns:

the MessageQueue object

getIOMessage

IOMessage getIOMessage(java.lang.String url)
                throws DLIException

Retrieves a handle to the IOMessage object that represents messages that are coming from or going to an IMS message queue.

The following code example shows how an IOMessage object is retrieved:

    Application app = ApplicationFactory.createApplication();
    IOMessage msg = app.getIOMessage("class://myPackage.MyIMSFldMsgSubClass");
 

For more details on defining input and output message classes, see the topic "Defining the input and output message classes" in the IMS Application Programming guide documentation.

Parameters:

url - the URL representing a subclass of com.ibm.ims.application.IMSFieldMessage

Returns:

the IOMessage object

Throws:

DLIException - if an error occurs during processing

getAssemblerCall

AssemblerCall getAssemblerCall()

Retrieves a handle to the AssemblerCall object that represents an assembler module to invoke.

The following code example shows how an AssemblerCall object is retrieved and used to invoke an assembler module named MYMOD with an input parameter of type String:

    Application app = ApplicationFactory.createApplication();
    AssemblerCall asCall = app.getAssemblerCall();
    asCall.setModuleName("MYMOD");
    asCall.setReturnType(AssemblerCall.RETURN_VOID);
    asCall.setString(1, "CharacterInput");
    asCall.invoke();
 

Returns:

the AssemblerCall object

getIMSQueueConnectionFactory

IMSQueueConnectionFactory getIMSQueueConnectionFactory()

Retrieves a handle to the IMSQueueConnectionFactory object that represents a Factory class used to create IMS Point-to-Point messaging domain QueueConnection objects.

Returns:

the IMSQueueConnectionFactory object

createImsCallout

IMSCallout createImsCallout()

Retrieves a handle to the IMSCallout object needed to execute an IMS Callout request. IMSCallout is a Java wrapper for the ICAL DL/I call.

Returns:

the IMSCallout object

inqyDBQuery

DBQueryInfo inqyDBQuery(boolean throwExceptionOnNonBlankStatus)
                 throws DLIException

Issues a DLI INQY call with the subfunction DBQUERY

The following code example shows how to issue the call:

 Application app = ApplicationFactory.createApplication();
 DBQueryInfo info = app.inqyDBQuery(false);
 

For more details on the INQY call and the DBQUERY subfunction, see the topic "INQY call"

Parameters:

throwExceptionOnNonBlankStatus - throws DLIException if true, returns DBQueryInfo object if false, even in the event of a non-blank status code

Returns:

the DBQueryInfo object which contains the information returned from the INQY call.

Throws:

java.lang.Exception

DLIException

inqyDBQuery

DBQueryInfo inqyDBQuery()
                 throws DLIException

Issues a DLI INQY call with the subfunction DBQUERY

The following code example shows how to issue the call:

    Application app = ApplicationFactory.createApplication();
    DBQueryInfo info = app.inqyDBQuery();
 

For more details on the INQY call and the DBQUERY subfunction, see the topic "INQY call"

Returns:

the DBQueryInfo object which contains the information returned from the INQY call.

Throws:

java.lang.Exception

DLIException

inqyEnviron

EnvironInfo inqyEnviron()
                 throws DLIException

Issues a DLI INQY call with the subfunction ENVIRON

The following code example shows how to issue the call:

    Application app = ApplicationFactory.createApplication();
    EnvironInfo info = app.inqyEnviron();
 

For more details on the INQY call and the ENVIRON subfunction, see the topic "INQY call"

Returns:

the EnvironInfo object which contains the information returned from the INQY call.

Throws:

java.lang.Exception

DLIException

inqyMessageInfo

MessageInfo inqyMessageInfo()
                     throws DLIException

Issues a DLI INQY call with the subfunction MSGINFO

The following code example shows how to issue the call:

    Application app = ApplicationFactory.createApplication();
    MessageInfo info = app.inqyMessageInfo();
 

For more details on the INQY call and the MSGINFO subfunction, see the topic "INQY call"

Returns:

the MessageInfo object which contains the information returned from the INQY call.

Throws:

java.lang.Exception

DLIException

inqyFind

FindInfo inqyFind(java.lang.String pcb)
           throws DLIException

Issues a DLI INQY call with the subfunction FIND

The following code example shows how to issue the call:

    Application app = ApplicationFactory.createApplication();
    FindInfo info = app.inqyFind("PCBName");
 

For more details on the INQY call and the FIND subfunction, see the topic "INQY call"

Parameters:

PCB - name

Returns:

the FindInfo object which contains the information returned from the INQY call.

Throws:

java.lang.Exception

DLIException

inqyProgram

com.ibm.ims.dli.ProgramInfo inqyProgram()
                                 throws DLIException

Issues a DLI INQY call with the subfunction PROGRAM

The following code example shows how to issue the call:

    Application app = ApplicationFactory.createApplication();
    ProgramInfo info = app.inqyProgram();
 

For more details on the INQY call and the PROGRAM subfunction, see the topic "INQY call"

Returns:

the ProgramInfo object which contains the information returned from the INQY call.

Throws:

java.lang.Exception

DLIException

get31BitDirectByteBuffer

java.nio.ByteBuffer get31BitDirectByteBuffer(int size)
                                      throws DLIException

Allocates a 31-bit direct ByteBuffer. Buffers that are not required to be 31-bit should be directly allocated using ByteBuffer.allocateDirect(int capacity)

Parameters:

capacity - The new buffer's capacity, in bytes

Returns:

the ByteBuffer object

Throws:

DLIException

See Also:

ByteBuffer.allocateDirect

free31BitDirectByteBuffer

void free31BitDirectByteBuffer(java.nio.ByteBuffer byteBuffer)
                        throws DLIException

Frees a 31 bit direct ByteBuffer

Parameters:

byteBuffer - The ByteBuffer object to free

Throws:

DLIException

end

void end()

Ends the life-cycle of the Application instance and frees up any resources associated with it.