com.ibm.mq

Class MQExternalReceiveExit

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.MQExternalUserExit

com.ibm.mq.MQExternalReceiveExit

All Implemented Interfaces:

MQReceiveExit

public class MQExternalReceiveExit
extends MQExternalUserExit
implements MQReceiveExit

Enables Java code to call a non-Java receive exit. Chaining of exits is implemented by MQReceiveExitChain.

An MQExternalReceiveExit object holds all the information required to construct the MQCXP and MQCD structures that are required when calling the non-Java receive exit.

Field Summary

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

COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructors

Constructor and Description
MQExternalReceiveExit() The default constructor.
MQExternalReceiveExit(java.lang.String libraryName, java.lang.String entryPointName, java.lang.String userData) Constructs an object with an exit already defined.

Method Summary

Modifier and Type	Method and Description
byte[]	receiveExit(MQChannelExit exitParms, MQChannelDefinition channelParms, byte[] data) Calls the external user exit.

Methods inherited from class com.ibm.mq.MQExternalUserExit

getReasonCode, getUserData, setEntryPointName, setLibraryName, setNewBuffer, setUserData

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

getJmqiEnvironment

Methods inherited from class java.lang.Object

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

Constructor Detail

MQExternalReceiveExit

public MQExternalReceiveExit()

The default constructor.

MQExternalReceiveExit

public MQExternalReceiveExit(java.lang.String libraryName,
                             java.lang.String entryPointName,
                             java.lang.String userData)

Constructs an object with an exit already defined.

Parameters:

libraryName - the name of the library module that contains the exit.

entryPointName - the name of the entry point in libraryName used by the exit.

userData - the data defined by the user.

Method Detail

receiveExit

public byte[] receiveExit(MQChannelExit exitParms,
                          MQChannelDefinition channelParms,
                          byte[] data)

Calls the external user exit.

Specified by:

receiveExit in interface MQReceiveExit

Parameters:

exitParms - the data on the exit.

channelParms - the data on the channel.

data - the raw message data.

Returns:

the raw message data after processing by the exit.

See Also:

MQChannelExit, MQChannelDefinition