com.collation.platform.model.topology.app.messaging.mq
Interface MQApiExit

All Superinterfaces:

LogicalElement, ManagedElement, ManagedSystemElement, ModelObject, MQBase, java.io.Serializable

All Known Subinterfaces:

MQApiExitCommons, MQApiExitTemplates

public interface MQApiExit
extends LogicalElement, MQBase

API exits let you write code that changes the behavior of WebSphere MQ API calls, such as MQPUT and MQGET, and then insert that code immediately before or immediately after those calls.

Naming Rules:

0="installation,name"

Persistable:

true

Table Name:

MQAPIEXIT

Field Summary

static java.lang.String

IBM_COPYRIGHT

Method Summary

java.lang.String	getData() Data=data_name Data to be passed to the API exit in the ExitData field of the MQAXP structure.
java.lang.String	getFunction() The name of the function entry point into the module containing the API exit code.
MQInstallation	getInstallation()
java.lang.String	getName() The descriptive name of the API exit passed to it in the ExitInfoName field of the MQAXP structure.
int	getSequence() The sequence in which this API exit is called relative to other API exits.
SoftwareComponent[]	getSoftware()
boolean	hasData()
boolean	hasFunction()
boolean	hasInstallation()
boolean	hasName()
boolean	hasSequence()
boolean	hasSoftware()
void	setData(java.lang.String x)
void	setFunction(java.lang.String x)
void	setInstallation(MQInstallation x)
void	setName(java.lang.String x)
void	setSequence(int x)
void	setSoftware(SoftwareComponent[] x)

Methods inherited from interface com.collation.platform.model.topology.core.ManagedElement

getManagedSystemName, getRoles, hasManagedSystemName, hasRoles, setManagedSystemName, setRoles

Methods inherited from interface com.collation.platform.model.ModelObject

getAdminState, getAllAttributes, getBidiFlag, getBidiFormat, getCDMSource, getCmdbSource, getContextIp, getCreatedBy, getDescription, getDisplayName, getExtendedAttributes, getGuid, getLabel, getLastModifiedBy, getLastModifiedTime, getObjectType, getSourceToken, hasAdminState, hasBidiFlag, hasBidiFormat, hasCDMSource, hasCmdbSource, hasContextIp, hasDescription, hasDisplayName, hasExtendedAttributes, hasGuid, hasLabel, hasObjectType, hasSourceToken, setAdminState, setBidiFlag, setBidiFormat, setCDMSource, setCmdbSource, setContextIp, setDescription, setExtendedAttributes, setGuid, setLabel, setObjectType, setSourceToken

Methods inherited from interface com.collation.platform.model.topology.app.messaging.mq.MQBase

getDefault, getIsValid, getSystem, hasDefault, hasIsValid, hasSystem, setDefault, setIsValid, setSystem

Field Detail

IBM_COPYRIGHT

static final java.lang.String IBM_COPYRIGHT

See Also:

Constant Field Values

Method Detail

getSequence

int getSequence()
                throws AttributeNotSetException

The sequence in which this API exit is called relative to other API exits. An exit with a low sequence number is called before an exit with a higher sequence number. There is no need for the sequence numbering of exits to be contiguous - a sequence of 1, 2, 3 has the same result as a sequence of 7, 42, 1096. If two exits have the same sequence number, the queue manager decides which one to call first. You can tell which was called after the event by putting the time or a marker in ExitChainArea indicated by the ExitChainAreaPtr in MQAXP or by writing your own log file. This attribute is an unsigned numeric value.

Throws:

AttributeNotSetException

setSequence

void setSequence(int x)

hasSequence

boolean hasSequence()

getSoftware

SoftwareComponent[] getSoftware()
                                throws AttributeNotSetException

Throws:

AttributeNotSetException

Implicit Relationship Type:

name="com.collation.platform.model.topology.relation.InvokedThrough" reverse="true"

setSoftware

void setSoftware(SoftwareComponent[] x)

hasSoftware

boolean hasSoftware()

getName

java.lang.String getName()
                         throws AttributeNotSetException

The descriptive name of the API exit passed to it in the ExitInfoName field of the MQAXP structure. This name must be unique, no longer than 48 characters, and contain only valid characters for the names of WebSphere MQ objects (for example, queue names).

Throws:

AttributeNotSetException

setName

void setName(java.lang.String x)

hasName

boolean hasName()

getFunction

java.lang.String getFunction()
                             throws AttributeNotSetException

The name of the function entry point into the module containing the API exit code. This entry point is the MQ_INIT_EXIT function. Function=function_name The name of the function entry point into the module containing the API exit code. This entry point is the MQ_INIT_EXIT function. The length of this field is limited to MQ_EXIT_NAME_LENGTH. The length of this field is limited to MQ_EXIT_NAME_LENGTH.

Throws:

AttributeNotSetException

setFunction

void setFunction(java.lang.String x)

hasFunction

boolean hasFunction()

getInstallation

MQInstallation getInstallation()
                               throws AttributeNotSetException

Throws:

AttributeNotSetException

Implicit Relationship Type:

name="com.collation.platform.model.topology.relation.Contains" reverse="true"

setInstallation

void setInstallation(MQInstallation x)

hasInstallation

boolean hasInstallation()

getData

java.lang.String getData()
                         throws AttributeNotSetException

Data=data_name Data to be passed to the API exit in the ExitData field of the MQAXP structure. If you include this attribute, leading and trailing blanks are removed, the remaining string is truncated to 32 characters, and the result is passed to the exit. If you omit this attribute, the default value of 32 blanks is passed to the exit. The maximum length of this field is 32 characters.

Throws:

AttributeNotSetException

setData

void setData(java.lang.String x)

hasData

boolean hasData()