MQChannelExit

 

---

java.lang.Object | *- com.ibm.mq.MQChannelExit

public class MQChannelExit
extends Object

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 WebSphere MQ Client for Java should take next.

Note:

This class does not apply when connecting directly to WebSphere MQ in bindings mode.

 

Variables

MQXCC_CLOSE_CHANNEL

public final static int MQXCC_CLOSE_CHANNEL

MQXCC_OK

public final static int MQXCC_OK

MQXCC_SUPPRESS_FUNCTION

public final static int MQXCC_SUPPRESS_FUNCTION

MQXCC_SEND_AND_REQUEST_SEC_MSG

public final static int MQXCC_SEND_AND_REQUEST_SEC_MSG

MQXCC_SEND_SEC_MSG

public final static int MQXCC_SEND_SEC_MSG

MQXCC_SUPPRESS_EXIT

public final static int MQXCC_SUPPRESS_EXIT

MQXR_INIT

public final static int MQXR_INIT

MQXR_INIT_SEC

public final static int MQXR_INIT_SEC

MQXR_SEC_MSG

public final static int MQXR_SEC_MSG

MQXR_TERM

public final static int MQXR_TERM

MQXR_XMIT

public final static int MQXR_XMIT

MQXT_CHANNEL_SEC_EXIT

public final static int MQXT_CHANNEL_SEC_EXIT

MQXT_CHANNEL_SEND_EXIT

public final static int MQXT_CHANNEL_SEND_EXIT

MQXT_CHANNEL_RCV_EXIT

public final static int MQXT_CHANNEL_RCV_EXIT

capabilityFlags

public static final int capabilityFlags

Indicates the capability of the queue manager.

Only the MQC.MQCF_DIST_LISTS flag is supported.

exitID

public int exitID

The type of exit that has been invoked. For an MQSecurityExit this is always MQXT_CHANNEL_SEC_EXIT; for an MQSendExit this is always MQXT_CHANNEL_SEND_EXIT; for an MQReceiveExit this is always MQXT_CHANNEL_RCV_EXIT.

exitReason

public int exitReason

The reason for invoking the exit. Possible values are:

MQXR_INIT

Exit initialization; called after the channel connection conditions have been negotiated, but before any security flows have been sent.

MQXR_INIT_SEC

Indicates that the exit is to initiate the security dialog with the queue manager.

MQXR_SEC_MSG

Indicates to the security exit that a security message has been received from the queue manager.

MQXR_TERM

Exit termination; called after the disconnect flows have been sent but before the socket connection is destroyed.

MQXR_XMIT

For a send exit, indicates that data is to be transmitted to the queue manager.

For a receive exit, indicates that data has been received from the queue manager.

exitResponse

public int exitResponse

Set by the exit to indicate the action that WebSphere MQ classes for Java should take next. Valid values are:

MQXCC_CLOSE_CHANNEL

Set by any exit to indicate that the connection to the queue manager should be closed.

MQXCC_OK

Set by the security exit to indicate that security exchanges are complete.

Set by send exit to indicate that the returned data is to be transmitted to the queue manager.

Set by the receive exit to indicate that the returned data is available for processing by the WebSphere MQ Client for Java.

MQXCC_SEND_AND_REQUEST_SEC_MSG

Set by the security exit to indicate that the returned data is to be transmitted to the queue manager, and that a response is expected from the queue manager.

MQXCC_SEND_SEC_MSG

Set by the security exit to indicate that the returned data is to be transmitted to the queue manager, and that no response is expected.

MQXCC_SUPPRESS_EXIT

Set by any exit to indicate that it should no longer be called.

MQXCC_SUPPRESS_FUNCTION

Set by the security exit to indicate that communications with the queue manager should be shut down.

exitUserArea

public byte exitUserArea[]

A storage area available for the exit to use.

Any data placed in the exitUserArea is preserved by the WebSphere MQ Client for Java across exit invocations with the same exitID. (That is, the send, receive, and security exits each have their own, independent, user areas.)

fapLevel

public static final int fapLevel

The negotiated Format and Protocol (FAP) level.

maxSegmentLength

public int maxSegmentLength

The maximum length for any one transmission to a queue manager.

If the exit returns data that is to be sent to the queue manager, the length of the returned data must not exceed this value.

 

Constructors

MQChannelExit

public MQChannelExit()

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.