public interface Application
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.
Modifier and Type | Method and Description |
---|---|
com.ibm.ims.dli.tm.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(ByteBuffer byteBuffer)
Frees a 31 bit direct ByteBuffer
|
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(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. |
com.ibm.ims.dli.DBQueryInfo |
inqyDBQuery()
Issues a DLI INQY call with the subfunction DBQUERY
|
com.ibm.ims.dli.DBQueryInfo |
inqyDBQuery(boolean throwExceptionOnNonBlankStatus)
Issues a DLI INQY call with the subfunction DBQUERY
|
EnvironInfo |
inqyEnviron()
Issues a DLI INQY call with the subfunction ENVIRON
|
com.ibm.ims.dli.FindInfo |
inqyFind(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
|
Transaction getTransaction()
Transaction
object that provides support for transactions that are managed by IMS.Transaction
objectMessageQueue getMessageQueue()
MessageQueue
object that provides support for IMS message queue processing.MessageQueue
objectIOMessage getIOMessage(String url) throws DLIException
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.
url
- the URL representing a subclass of com.ibm.ims.application.IMSFieldMessage
IOMessage
objectDLIException
- if an error occurs during processingAssemblerCall getAssemblerCall()
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();
AssemblerCall
objectIMSQueueConnectionFactory getIMSQueueConnectionFactory()
IMSQueueConnectionFactory
object that represents a Factory class used to create IMS Point-to-Point messaging
domain QueueConnection objects.IMSQueueConnectionFactory
objectcom.ibm.ims.dli.tm.IMSCallout createImsCallout()
IMSCallout
object
needed to execute an IMS Callout request. IMSCallout is a Java
wrapper for the ICAL DL/I call.IMSCallout
objectcom.ibm.ims.dli.DBQueryInfo inqyDBQuery(boolean throwExceptionOnNonBlankStatus) throws DLIException
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"
throwExceptionOnNonBlankStatus
- throws DLIException if true, returns
DBQueryInfo object if false, even in
the event of a non-blank status codeDBQueryInfo
object which contains the information
returned from the INQY call.Exception
DLIException
com.ibm.ims.dli.DBQueryInfo inqyDBQuery() throws DLIException
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"
DBQueryInfo
object which contains the information returned from the INQY call.Exception
DLIException
EnvironInfo inqyEnviron() throws DLIException
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"
EnvironInfo
object which contains the information returned from the INQY call.Exception
DLIException
MessageInfo inqyMessageInfo() throws DLIException
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"
MessageInfo
object which contains the information returned from the INQY call.Exception
DLIException
com.ibm.ims.dli.FindInfo inqyFind(String pcb) throws DLIException
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"
PCB
- nameFindInfo
object which contains the information returned from the INQY call.Exception
DLIException
com.ibm.ims.dli.ProgramInfo inqyProgram() throws DLIException
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"
ProgramInfo
object which contains the information returned from the INQY call.Exception
DLIException
ByteBuffer get31BitDirectByteBuffer(int size) throws DLIException
capacity
- The new buffer's capacity, in bytesByteBuffer
objectDLIException
ByteBuffer.allocateDirect
void free31BitDirectByteBuffer(ByteBuffer byteBuffer) throws DLIException
byteBuffer
- The ByteBuffer object to freeDLIException
void end()
Application
instance and frees up any resources associated
with it.(c) Copyright IBM Corporation 2008, 2017.