com.ibm.cics.server.pipeline
Interface ApplicationHandler


public interface ApplicationHandler

Interface for provider mode PIPELINE Application Handlers written in Java.

If you wish to write an Application Handler in Java and have it called from a CICS/Axis2 Pipeline then you must:

  1. create a class that implements this Interface.
  2. create a PROGRAM definition that targets your class and specifies the same JVMSERVER name as is used by the PIPELINE.
  3. Finally, register that PROGRAM as the AppHandler in the Configuration File for the PIPELINE.

Since CICS TS version:
4.2
Since package version:
1.0

Field Summary
static java.lang.String copyright_notice
          Comment for copyright notice
static java.lang.String NORESPONSE_PROPERTY
          This property indicates whether or not a response message is to be built.
static java.lang.String SCCSID
          CICS SCCSID String
 
Method Summary
 org.apache.axiom.soap.SOAPEnvelope invoke(org.apache.axis2.context.MessageContext msgCtx)
           
 

Field Detail

copyright_notice

static final java.lang.String copyright_notice
Comment for copyright notice

See Also:
Constant Field Values

SCCSID

static final java.lang.String SCCSID
CICS SCCSID String

See Also:
Constant Field Values

NORESPONSE_PROPERTY

static final java.lang.String NORESPONSE_PROPERTY
This property indicates whether or not a response message is to be built. The associated values are Boolean.TRUE and Boolean.FALSE. The Application Handler may set this property to Boolean.TRUE to tell CICS will not attempt to generate a response message.

See Also:
AbstractContext.setProperty(String property, Object value), Constant Field Values
Method Detail

invoke

org.apache.axiom.soap.SOAPEnvelope invoke(org.apache.axis2.context.MessageContext msgCtx)
                                          throws org.apache.axis2.AxisFault
Parameters:
msgCtx - The Axis2 MessageContext containing the request message and associated state.
Returns:
A SOAP Envelope to return. CICS only returns the Body section of this envelope.
Throws:
org.apache.axis2.AxisFault - If something goes wrong.
Since CICS TS version:
4.2
Since package version:
1.0