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	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 final int	MQXCC_CLOSE_CHANNEL	Deprecated. use MQConstants.MQXCC_CLOSE_CHANNELinstead.
static final int	MQXCC_OK	Deprecated. use MQConstants.MQXCC_OKinstead.
static final int	MQXCC_SEND_AND_REQUEST_SEC_MSG	Deprecated. use MQConstants.MQXCC_SEND_AND_REQUEST_SEC_MSG instead.
static final int	MQXCC_SEND_SEC_MSG	Deprecated. use MQConstants.MQXCC_SEND_SEC_MSGinstead.
static final int	MQXCC_SUPPRESS_EXIT	Deprecated. use MQConstants.MQXCC_SUPPRESS_EXITinstead.
static final int	MQXCC_SUPPRESS_FUNCTION	Deprecated. use MQConstants.MQXCC_SUPPRESS_FUNCTION instead.
static final int	MQXR_INIT	Deprecated. use MQConstants.MQXR_INITinstead.
static final int	MQXR_INIT_SEC	Deprecated. use MQConstants.MQXR_INTI_SECinstead.
static final int	MQXR_SEC_MSG	Deprecated. use MQConstants.MQXR_SEC_MSGinstead.
static final int	MQXR_TERM	Deprecated. use MQConstants.MQXR_TERMinstead.
static final int	MQXR_XMIT	Deprecated. use MQConstants.MQXR_XMITinstead.
static final int	MQXT_CHANNEL_RCV_EXIT	Deprecated. use MQConstants.MQXT_CHANNEL_RCV_EXITinstead.
static final int	MQXT_CHANNEL_SEC_EXIT	Deprecated. use MQConstants.MQXT_CHANNEL_SEC_EXITinstead.
static final int	MQXT_CHANNEL_SEND_EXIT	Deprecated. use MQConstants.MQXT_CHANNEL_SEND_EXITinstead.

Fields inherited from class com.ibm.mq.jmqi.JmqiObject

COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructors

Constructor	Description
MQChannelExit()	Package constructor

Method Summary

Modifier and Type	Method	Description
MQConnectionSecurityParameters	getMQCSP()	Gets an MQConnectionSecurityParameters object.
void	setMQCSP(MQConnectionSecurityParameters mqcsp)	Sets an MQConnectionSecurityParameters object.

Methods inherited from class com.ibm.mq.jmqi.JmqiObject

getJmqiEnvironment

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MQXT_CHANNEL_SEC_EXIT

public static final int MQXT_CHANNEL_SEC_EXIT

Deprecated.

use MQConstants.MQXT_CHANNEL_SEC_EXITinstead.

See Also:

• Constant Field Values

MQXT_CHANNEL_SEND_EXIT

public static final int MQXT_CHANNEL_SEND_EXIT

Deprecated.

use MQConstants.MQXT_CHANNEL_SEND_EXITinstead.

See Also:

• Constant Field Values

MQXT_CHANNEL_RCV_EXIT

public static final int MQXT_CHANNEL_RCV_EXIT

Deprecated.

use MQConstants.MQXT_CHANNEL_RCV_EXITinstead.

See Also:

• Constant Field Values

MQXR_INIT

public static final int MQXR_INIT

Deprecated.

use MQConstants.MQXR_INITinstead.

See Also:

• Constant Field Values

MQXR_TERM

public static final int MQXR_TERM

Deprecated.

use MQConstants.MQXR_TERMinstead.

See Also:

• Constant Field Values

MQXR_XMIT

public static final int MQXR_XMIT

Deprecated.

use MQConstants.MQXR_XMITinstead.

See Also:

• Constant Field Values

MQXR_SEC_MSG

public static final int MQXR_SEC_MSG

Deprecated.

use MQConstants.MQXR_SEC_MSGinstead.

See Also:

• Constant Field Values

MQXR_INIT_SEC

public static final int MQXR_INIT_SEC

Deprecated.

use MQConstants.MQXR_INTI_SECinstead.

See Also:

• Constant Field Values

MQXCC_OK

public static final int MQXCC_OK

Deprecated.

use MQConstants.MQXCC_OKinstead.

See Also:

• Constant Field Values

MQXCC_SUPPRESS_FUNCTION

public static final int MQXCC_SUPPRESS_FUNCTION

Deprecated.

use MQConstants.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.

use MQConstants.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.

use MQConstants.MQXCC_SEND_SEC_MSGinstead.

See Also:

• Constant Field Values

MQXCC_SUPPRESS_EXIT

public static final int MQXCC_SUPPRESS_EXIT

Deprecated.

use MQConstants.MQXCC_SUPPRESS_EXITinstead.

See Also:

• Constant Field Values

MQXCC_CLOSE_CHANNEL

public static final int MQXCC_CLOSE_CHANNEL

Deprecated.

use MQConstants.MQXCC_CLOSE_CHANNELinstead.

See Also:

• Constant Field Values

exitID

public int exitID

The type of exit that has been invoked. Possible values are:

• MQConstants.MQXT_CHANNEL_SEC_EXIT
• MQConstants.MQXT_CHANNEL_SEND_EXIT
• MQConstants.MQXT_CHANNEL_RCV_EXIT

exitReason

public int exitReason

The reason for invoking the exit. Possible values are:

• MQConstants.MQXR_INIT
• MQConstants.MQXR_TERM
• MQConstants.MQXR_XMIT
• MQConstants.MQXR_SEC_MSG
• MQConstants.MQXR_INIT_SEC
• MQConstants.MQXR_SEC_PARMS

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:

• MQConstants.MQXCC_OK
• MQConstants.MQXCC_SUPPRESS_FUNCTION
• MQConstants.MQXCC_SEND_AND_REQUEST_SEC_MSG
• MQConstants.MQXCC_SEND_SEC_MSG
• MQConstants.MQXCC_SUPPRESS_EXIT
• MQConstants.MQXCC_CLOSE_CHANNEL

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.

Constructor Details

MQChannelExit

public MQChannelExit()

Package constructor

Method Details

setMQCSP

public void setMQCSP(MQConnectionSecurityParameters mqcsp)

Sets an MQConnectionSecurityParameters object. If this object is created and set when a security exit is invoked with MQConstants.MQXR_SEC_PARMSthen 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 an MQConnectionSecurityParameters object. If no such object has been created, this method will return null.

Returns:

the MQConnectionSecurityParameters object.