com.ibm.mq
Class MQChannelExit
- java.lang.Object
-
- com.ibm.mq.jmqi.JmqiObject
-
- com.ibm.mq.MQChannelExit
-
public class MQChannelExit extends com.ibm.mq.jmqi.JmqiObject
This class defines context information passed to the send, receive and security exits when they are invoked. The exit must set the exitResponse member variable to indicate what action the IBM MQ Client for Java should take next.Note: This class is not used when connecting directly to IBM MQ in bindings mode.
-
-
Field Summary
Fields Modifier and Type Field and Description int
capabilityFlags
Capabilities of the queue manager.int
CurHdrCompression
The technique currently being used to compress header data.int
CurMsgCompression
The technique currently being used to compress message data.int
exitID
The type of exit that has been invoked.int
exitReason
The reason for invoking the exit.int
exitResponse
Set by the exit to indicate the action that the IBM MQ Client for Java should take next.byte[]
exitUserArea
A storage area available for the exit to use.int
fapLevel
The negotiated Format and Protocol (FAP) level.int
maxSegmentLength
The maximum length for a simple transmission to a queue manager.static int
MQXCC_CLOSE_CHANNEL
Deprecated.useMQConstants.MQXCC_CLOSE_CHANNEL
instead.static int
MQXCC_OK
Deprecated.useMQConstants.MQXCC_OK
instead.static int
MQXCC_SEND_AND_REQUEST_SEC_MSG
Deprecated.useMQConstants.MQXCC_SEND_AND_REQUEST_SEC_MSG
instead.static int
MQXCC_SEND_SEC_MSG
Deprecated.useMQConstants.MQXCC_SEND_SEC_MSG
instead.static int
MQXCC_SUPPRESS_EXIT
Deprecated.useMQConstants.MQXCC_SUPPRESS_EXIT
instead.static int
MQXCC_SUPPRESS_FUNCTION
Deprecated.useMQConstants.MQXCC_SUPPRESS_FUNCTION
instead.static int
MQXR_INIT
Deprecated.useMQConstants.MQXR_INIT
instead.static int
MQXR_INIT_SEC
Deprecated.useMQConstants.MQXR_INTI_SEC
instead.static int
MQXR_SEC_MSG
Deprecated.useMQConstants.MQXR_SEC_MSG
instead.static int
MQXR_TERM
Deprecated.useMQConstants.MQXR_TERM
instead.static int
MQXR_XMIT
Deprecated.useMQConstants.MQXR_XMIT
instead.static int
MQXT_CHANNEL_RCV_EXIT
Deprecated.useMQConstants.MQXT_CHANNEL_RCV_EXIT
instead.static int
MQXT_CHANNEL_SEC_EXIT
Deprecated.useMQConstants.MQXT_CHANNEL_SEC_EXIT
instead.static int
MQXT_CHANNEL_SEND_EXIT
Deprecated.useMQConstants.MQXT_CHANNEL_SEND_EXIT
instead.
-
Constructor Summary
Constructors Constructor and Description MQChannelExit()
Package constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description MQConnectionSecurityParameters
getMQCSP()
Gets anMQConnectionSecurityParameters
object.void
setMQCSP(MQConnectionSecurityParameters mqcsp)
Sets anMQConnectionSecurityParameters
object.
-
-
-
Field Detail
-
MQXT_CHANNEL_SEC_EXIT
public static final int MQXT_CHANNEL_SEC_EXIT
Deprecated. useMQConstants.MQXT_CHANNEL_SEC_EXIT
instead.- See Also:
- Constant Field Values
-
MQXT_CHANNEL_SEND_EXIT
public static final int MQXT_CHANNEL_SEND_EXIT
Deprecated. useMQConstants.MQXT_CHANNEL_SEND_EXIT
instead.- See Also:
- Constant Field Values
-
MQXT_CHANNEL_RCV_EXIT
public static final int MQXT_CHANNEL_RCV_EXIT
Deprecated. useMQConstants.MQXT_CHANNEL_RCV_EXIT
instead.- See Also:
- Constant Field Values
-
MQXR_INIT
public static final int MQXR_INIT
Deprecated. useMQConstants.MQXR_INIT
instead.- See Also:
- Constant Field Values
-
MQXR_TERM
public static final int MQXR_TERM
Deprecated. useMQConstants.MQXR_TERM
instead.- See Also:
- Constant Field Values
-
MQXR_XMIT
public static final int MQXR_XMIT
Deprecated. useMQConstants.MQXR_XMIT
instead.- See Also:
- Constant Field Values
-
MQXR_SEC_MSG
public static final int MQXR_SEC_MSG
Deprecated. useMQConstants.MQXR_SEC_MSG
instead.- See Also:
- Constant Field Values
-
MQXR_INIT_SEC
public static final int MQXR_INIT_SEC
Deprecated. useMQConstants.MQXR_INTI_SEC
instead.- See Also:
- Constant Field Values
-
MQXCC_OK
public static final int MQXCC_OK
Deprecated. useMQConstants.MQXCC_OK
instead.- See Also:
- Constant Field Values
-
MQXCC_SUPPRESS_FUNCTION
public static final int MQXCC_SUPPRESS_FUNCTION
Deprecated. useMQConstants.MQXCC_SUPPRESS_FUNCTION
instead.- See Also:
- Constant Field Values
-
MQXCC_SEND_AND_REQUEST_SEC_MSG
public static final int MQXCC_SEND_AND_REQUEST_SEC_MSG
Deprecated. useMQConstants.MQXCC_SEND_AND_REQUEST_SEC_MSG
instead.- See Also:
- Constant Field Values
-
MQXCC_SEND_SEC_MSG
public static final int MQXCC_SEND_SEC_MSG
Deprecated. useMQConstants.MQXCC_SEND_SEC_MSG
instead.- See Also:
- Constant Field Values
-
MQXCC_SUPPRESS_EXIT
public static final int MQXCC_SUPPRESS_EXIT
Deprecated. useMQConstants.MQXCC_SUPPRESS_EXIT
instead.- See Also:
- Constant Field Values
-
MQXCC_CLOSE_CHANNEL
public static final int MQXCC_CLOSE_CHANNEL
Deprecated. useMQConstants.MQXCC_CLOSE_CHANNEL
instead.- See Also:
- Constant Field Values
-
exitID
public int exitID
The type of exit that has been invoked. Possible values are:
-
exitReason
public int exitReason
The reason for invoking the exit. Possible values are:
-
exitResponse
public int exitResponse
Set by the exit to indicate the action that the IBM MQ Client for Java should take next. Valid values are:
-
maxSegmentLength
public int maxSegmentLength
The maximum length for a simple transmission to a queue manager. If the exit returns data which is to be sent to the queue manager, the length of the returned data must not exceed this value.
-
exitUserArea
public byte[] exitUserArea
A storage area available for the exit to use. Any data placed here is preserved by the IBM MQ Client for Java across exit invocations with the same exitID; that is, each send, receive or security exit has its own independent user area.
-
fapLevel
public int fapLevel
The negotiated Format and Protocol (FAP) level. The default level is 9.
-
capabilityFlags
public int capabilityFlags
Capabilities of the queue manager.Only the MQConstants.MQCF_DIST_LISTS flag is supported.
-
CurHdrCompression
public int CurHdrCompression
The technique currently being used to compress header data.
-
CurMsgCompression
public int CurMsgCompression
The technique currently being used to compress message data.
-
-
Method Detail
-
setMQCSP
public void setMQCSP(MQConnectionSecurityParameters mqcsp)
Sets anMQConnectionSecurityParameters
object. If this object is created and set when a security exit is invoked withMQConstants.MQXR_SEC_PARMS
then any supplied information will be sent to the Queue Manager.This applies to channel security exits only.
- Parameters:
mqcsp
- the MQConnectionSecurityParameters object.
-
getMQCSP
public MQConnectionSecurityParameters getMQCSP()
Gets anMQConnectionSecurityParameters
object. If no such object has been created, this method will return null.- Returns:
- the MQConnectionSecurityParameters object.
-
-