Package com.ibm.mq.exits
Class MQCD
java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.jmqi.internal.AbstractMqiStructure
com.ibm.mq.exits.MQCD
- All Implemented Interfaces:
com.ibm.mq.jmqi.internal.MqiStructure,Cloneable
MQCD structure
-
Field Summary
Fields inherited from class com.ibm.mq.jmqi.JmqiObject
COMP_JM, COMP_JN, COMP_JOFields inherited from interface com.ibm.mq.jmqi.internal.MqiStructure
sccsid -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Clone this object.booleanCompare two client MQCD structures to determine if they point at the same requested destination, with the same client connection parameters.intGet the limit, in kilobytes, of the amount of data that can be sent through a channel before taking a sync point.intGet the time interval that is used to trigger a batch heartbeat for the channelintGet the approximate time in milliseconds that a channel keeps a batch open, if fewer than BatchSize messages have been transmitted in the current batchintGet the maximum number of messages that can be sent through a channel before synchronizing the channelGet the details of the certificate label being usedintGet the current level of monitoring data collection for the channelGet the channel definition name.intGet the current level of statistics data collection for the channelintGet the type of channelintGet the weighting to influence which client-connection channel definition is usedintGetthe number of clusters to which the channel belongsintGet the cluster workload channel priorityintGet the cluster workload channel rankintGet the cluster workload channel weightintGet connection affinity.Get the connection name for the channelintintGet the data conversion value.intGet the default reconnection attribute value for a client connection channel.getDesc()Get the description of the channelintGet the maximum time in seconds for which the channel waits for a message to arrive on the transmission queue, before terminating the channelintGet the length in bytes of each of the user data items in the lists of exit user data items addressed by the MsgUserDataPtr, SendUserDataPtr, and ReceiveUserDataPtr fieldsintGet the length in bytes of each of the names in the lists of exit names addressed by the MsgExitPtr, SendExitPtr, and ReceiveExitPtr fieldsintint[]Get the list of header data compression techniques which are supported by the channelintGet the time in seconds between heartbeat flowsintGetthe value passed to the communications stack for keepalive timing for the channelGet the local TCP/IP address defined for the channel for outbound communicationsintGet the count used after the count specified by the ShortRetryCount has been exhaustedintGet the maximum number of seconds to wait before reattempting connection to the remote machineintGet the maximum number of simultaneous instances of an individual server-connection channel that can be started.intGet the maximum number of simultaneous instances of an individual server-connection channel that can be started from a single clientintGet the maximum message length that can be transmitted on the channelGet the MCA name.byte[]Get the security identifier for the MCAintGet the type of message channel agent programGet the user identifier for the message channel agent (MCA)Get the LU 6.2 mode nameint[]Get the list of message data compression techniques which are supported by the channelGet the channel message exit nameGet the address of the first MsgExit fieldintGet the number of channel message exits defined in the chainintGet the number of times MCA tries to put the message, after the first attempt has failedGet the channel message retry exit nameintGet the minimum interval in milliseconds after which the open or put operation is retriedGet the channel message retry exit user dataGet the channel message exit user dataGet the address of the first MsgUserData fieldintGet the priority of the network connection for the channelintGet the speed at which non-persistent messages travel through the channelGet the password used by the message channel agent when attempting to initiate a secure SNA session with a remote message channel agentintGet propertyControl.intGet the putAuthority - This field specifies whether the user identifier in the context information associated with a message is used to establish authority to put the message to the destination queueGet the name of the queue manager that an exit can connect toGet the channel receive exit nameGet the address of the first ReceiveExit fieldintGet the number of channel receive exits defined in the chainGet the channel receive exit user dataget the address of the first ReceiveUserData fieldGet the password from a partnerbyte[]Get the security identifier for the remote userGet the first 12 bytes of a user identifier from a partnerGet the channel security exit nameGet the channel security exit user dataGet the channel send exit name.Get the address of the first SendExit fieldintGet the number of channel send exits defined in the chainGet the channel send exit user dataGet the address of the SendUserData fieldintGet the highest allowable message sequence numberintGet the maximum number of conversations that can share a channel instance associated with this channelintGet the maximum number of attempts that are made to connect to a remote machineintGet the maximum number of seconds to wait before reattempting connection to the remote machinestatic intgetSizeV11(int ptrSize) Gets the size of MQCD v11 structurestatic intgetSizeV12(int ptrSize) Gets the size of MQCD v12 structureintGet the AMS security policy protection.Get the Cipher Spec that is in use when using TLSintGet the sslClientAuth - This attribute defines whether TLS client authentication is requiredGet the ssl peer nameintDeprecated.int[]Get the filtered list of supported Message compression techniques.Deprecated.intGet the transmission protocol to be usedGet the user identifier used by the message channel agent when attempting to initiate a secure SNA session with a remote message channel agentintGet the highest version number that you can set for the structureGet the name of the transmission queue from which messages are retrievedinthashCode()Generate a hashcode.voidsetBatchDataLimit(int batchDataLimit) Set the BatchDataLimitvoidsetCertificateLabel(String certificateLabel) Set the certificateLabelvoidsetSPLProtection(int splProtection) Set the AMS security policy protection.voidsetupForTest(int ptrSize) Methods inherited from class com.ibm.mq.jmqi.internal.AbstractMqiStructure
getMaximumRequiredBufferSize, getRequiredInputBufferSize, getSize, readFromBuffer, setVersion, toString, toStringMultiLine, toTraceString, writeToBuffer, writeToTraceBufferMethods inherited from class com.ibm.mq.jmqi.JmqiObject
getJmqiEnvironmentMethods inherited from interface com.ibm.mq.jmqi.internal.MqiStructure
addFieldsToFormatter, getRequiredBufferSize, readFromBuffer, writeToBuffer
-
Constructor Details
-
MQCD
public MQCD()
-
-
Method Details
-
getSizeV11
public static int getSizeV11(int ptrSize) Gets the size of MQCD v11 structure- Parameters:
ptrSize- The number of bytes to write for each pointer in the structure- Returns:
- The size of the Version 11 fields, including the end-of-structure alignment
-
getSizeV12
public static int getSizeV12(int ptrSize) Gets the size of MQCD v12 structure- Parameters:
ptrSize- The number of bytes to write for each pointer in the structure- Returns:
- The size of the Version 12 fields, including the end-of-structure alignment
-
clone
Clone this object. This method clones only those fields required when comparing two client MQCD structures to determine if they point at the same requested destination. e.g. newMQCD.equals(oldMQCD) == true Need to take a copy of the byte array data, otherwise the cloned object will reference the same byte array. Taking copies of the data means that if ones is updated, the other is untouched. This is useful when the MQCD is cloned for the negotiated channel in the RemoteConnection.- Returns:
- a clone of the original object
- Throws:
CloneNotSupportedException- for transport protocol types other than TCP.
-
hashCode
public int hashCode()Generate a hashcode. This hashcode is unique based upon the fields that are compared when comparing two client MQCD structures to determine if they point at the same requested destination. -
equals
Compare two client MQCD structures to determine if they point at the same requested destination, with the same client connection parameters. This is intended specifically to determine if an existing connection is suitable for a new conversation to be multiplexed over. Certain fields - maxMsgLength, heartbeatInterval and sharingConversations - are excluded as they don't preclude multiplexing -
getBatchHeartbeat
public int getBatchHeartbeat()Get the time interval that is used to trigger a batch heartbeat for the channel- Returns:
- the batchHeartbeat
-
getBatchInterval
public int getBatchInterval()Get the approximate time in milliseconds that a channel keeps a batch open, if fewer than BatchSize messages have been transmitted in the current batch- Returns:
- batch interval
-
getBatchSize
public int getBatchSize()Get the maximum number of messages that can be sent through a channel before synchronizing the channel- Returns:
- the batch size
-
getChannelMonitoring
public int getChannelMonitoring()Get the current level of monitoring data collection for the channel- Returns:
- channel monitoring
-
getChannelName
Get the channel definition name. There must be a channel definition of the same name at the remote machine to be able to communicate- Returns:
- channel name
-
getChannelStatistics
public int getChannelStatistics()Get the current level of statistics data collection for the channel- Returns:
- channel statistics
-
getChannelType
public int getChannelType()Get the type of channel- Returns:
- channel type
-
getClustersDefined
public int getClustersDefined()Getthe number of clusters to which the channel belongs- Returns:
- clusters defined value
-
getClwlChannelPriority
public int getClwlChannelPriority()Get the cluster workload channel priority- Returns:
- the clwlChannelPriority
-
getClwlChannelRank
public int getClwlChannelRank()Get the cluster workload channel rank- Returns:
- the clwlChannelRank
-
getClwlChannelWeight
public int getClwlChannelWeight()Get the cluster workload channel weight- Returns:
- the clwlChannelWeight
-
getConnectionName
Get the connection name for the channel- Returns:
- connection name
-
getDataConversion
public int getDataConversion()Get the data conversion value. The value specifies whether the sending message channel agent attempts conversion of the application message data if the receiving message channel agent is unable to perform this conversion.- Returns:
- the data conversion
-
getDefReconnect
public int getDefReconnect()Get the default reconnection attribute value for a client connection channel.- Returns:
- the defReconnect
-
getDesc
Get the description of the channel- Returns:
- the description
-
getDiscInterval
public int getDiscInterval()Get the maximum time in seconds for which the channel waits for a message to arrive on the transmission queue, before terminating the channel- Returns:
- the discInterval
-
getHdrCompList
public int[] getHdrCompList()Get the list of header data compression techniques which are supported by the channel- Returns:
- the hdrCompList
-
getHeartbeatInterval
public int getHeartbeatInterval()Get the time in seconds between heartbeat flows- Returns:
- heartbeat interval
-
getKeepAliveInterval
public int getKeepAliveInterval()Getthe value passed to the communications stack for keepalive timing for the channel- Returns:
- keepAlive Interval
-
getLocalAddress
Get the local TCP/IP address defined for the channel for outbound communications- Returns:
- the local address
-
getLongRetryCount
public int getLongRetryCount()Get the count used after the count specified by the ShortRetryCount has been exhausted- Returns:
- long retry count
-
getLongRetryInterval
public int getLongRetryInterval()Get the maximum number of seconds to wait before reattempting connection to the remote machine- Returns:
- long retry interval
-
getMaxMsgLength
public int getMaxMsgLength()Get the maximum message length that can be transmitted on the channel- Returns:
- maximum message length
-
getMcaName
Get the MCA name. This is a reserved field- Returns:
- MCA name
-
getMcaSecurityId
public byte[] getMcaSecurityId()Get the security identifier for the MCA- Returns:
- MCA SecurityId
-
getMcaType
public int getMcaType()Get the type of message channel agent program- Returns:
- MCA type
-
getMcaUserIdentifier
Get the user identifier for the message channel agent (MCA)- Returns:
- MCA UserIdentifier
-
getModeName
Get the LU 6.2 mode name- Returns:
- mode name
-
getSupportedMsgCompList
public int[] getSupportedMsgCompList()Get the filtered list of supported Message compression techniques.- Returns:
- tmsgCompList
-
getMsgCompList
public int[] getMsgCompList()Get the list of message data compression techniques which are supported by the channel- Returns:
- tmsgCompList
-
getMsgExitsDefined
public int getMsgExitsDefined()Get the number of channel message exits defined in the chain- Returns:
- msgExitsDefined
-
getMsgRetryCount
public int getMsgRetryCount()Get the number of times MCA tries to put the message, after the first attempt has failed- Returns:
- msgRetryCount
-
getMsgRetryExit
Get the channel message retry exit name- Returns:
- msgRetryExit
-
getMsgRetryInterval
public int getMsgRetryInterval()Get the minimum interval in milliseconds after which the open or put operation is retried- Returns:
- msgRetryInterval
-
getMsgRetryUserData
Get the channel message retry exit user data- Returns:
- msgRetryUserData
-
getNetworkPriority
public int getNetworkPriority()Get the priority of the network connection for the channel- Returns:
- networkPriority
-
getNonPersistentMsgSpeed
public int getNonPersistentMsgSpeed()Get the speed at which non-persistent messages travel through the channel- Returns:
- msgRetryUserData
-
getPassword
Get the password used by the message channel agent when attempting to initiate a secure SNA session with a remote message channel agent- Returns:
- password
-
getPutAuthority
public int getPutAuthority()Get the putAuthority - This field specifies whether the user identifier in the context information associated with a message is used to establish authority to put the message to the destination queue- Returns:
- the putAuthority
-
getQMgrName
Get the name of the queue manager that an exit can connect to- Returns:
- qMgrName
-
getReceiveExitsDefined
public int getReceiveExitsDefined()Get the number of channel receive exits defined in the chain- Returns:
- the receiveExitsDefined
-
getRemotePassword
Get the password from a partner- Returns:
- remotePassword
-
getRemoteSecurityId
public byte[] getRemoteSecurityId()Get the security identifier for the remote user- Returns:
- remoteSecurityId
-
getRemoteUserIdentifier
Get the first 12 bytes of a user identifier from a partner- Returns:
- remoteUserIdentifier
-
getSecurityExit
Get the channel security exit name- Returns:
- securityExit
-
getSecurityUserData
Get the channel security exit user data- Returns:
- securityUserData
-
getSendExitsDefined
public int getSendExitsDefined()Get the number of channel send exits defined in the chain- Returns:
- the sendExitsDefined
-
getSeqNumberWrap
public int getSeqNumberWrap()Get the highest allowable message sequence number- Returns:
- the seqNumberWrap
-
getShortRetryCount
public int getShortRetryCount()Get the maximum number of attempts that are made to connect to a remote machine- Returns:
- the shortRetryCount
-
getShortRetryInterval
public int getShortRetryInterval()Get the maximum number of seconds to wait before reattempting connection to the remote machine- Returns:
- the shortRetryInterval
-
getSPLProtection
public int getSPLProtection()Get the AMS security policy protection.- Returns:
- the value of the AMS security policy protection
-
setSPLProtection
public void setSPLProtection(int splProtection) Set the AMS security policy protection.- Parameters:
splProtection- the AMS security policy protection.
-
getSslCipherSpec
Get the Cipher Spec that is in use when using TLS- Returns:
- the sslCipherSpec
-
getSslClientAuth
public int getSslClientAuth()Get the sslClientAuth - This attribute defines whether TLS client authentication is required- Returns:
- the sslClientAuth
-
getSslPeerName
Get the ssl peer name- Returns:
- the sslPeerName
-
getStrucLength
public int getStrucLength()Deprecated.Get the structure length- Returns:
- strucLength
-
getTpName
Deprecated.Get the LU 6.2 transaction program name- Returns:
- the tpName
-
getTransportType
public int getTransportType()Get the transmission protocol to be used- Returns:
- the transportType
-
getUserIdentifier
Get the user identifier used by the message channel agent when attempting to initiate a secure SNA session with a remote message channel agent- Returns:
- the userIdentifier
-
getVersion
public int getVersion()Get the highest version number that you can set for the structure- Specified by:
getVersionin interfacecom.ibm.mq.jmqi.internal.MqiStructure- Overrides:
getVersionin classcom.ibm.mq.jmqi.internal.AbstractMqiStructure- Returns:
- the version
-
getXmitQName
Get the name of the transmission queue from which messages are retrieved- Returns:
- thexmitQName
-
getMsgExit
Get the channel message exit name- Returns:
- the msgExit
-
getMsgExitPtr
Get the address of the first MsgExit field- Returns:
- the msgExitPtr
-
getMsgUserData
Get the channel message exit user data- Returns:
- the msgUserData
-
getMsgUserDataPtr
Get the address of the first MsgUserData field- Returns:
- the msgUserDataPtr
-
getReceiveExit
Get the channel receive exit name- Returns:
- the receiveExit
-
getReceiveExitPtr
Get the address of the first ReceiveExit field- Returns:
- the receiveExitPtr
-
getReceiveUserData
Get the channel receive exit user data- Returns:
- the receiveUserData
-
getReceiveUserDataPtr
get the address of the first ReceiveUserData field- Returns:
- the receiveUserDataPtr
-
getSendExit
Get the channel send exit name.- Returns:
- the sendExit
-
getSendExitPtr
Get the address of the first SendExit field- Returns:
- the sendExitPtr
-
getSendUserData
Get the channel send exit user data- Returns:
- the sendUserData
-
getSendUserDataPtr
Get the address of the SendUserData field- Returns:
- the sendUserDataPtr
-
getExitDataLength
public int getExitDataLength()Get the length in bytes of each of the user data items in the lists of exit user data items addressed by the MsgUserDataPtr, SendUserDataPtr, and ReceiveUserDataPtr fields- Returns:
- the exitDataLength
-
getExitNameLength
public int getExitNameLength()Get the length in bytes of each of the names in the lists of exit names addressed by the MsgExitPtr, SendExitPtr, and ReceiveExitPtr fields- Returns:
- the exitNameLength
-
getSharingConversations
public int getSharingConversations()Get the maximum number of conversations that can share a channel instance associated with this channel- Returns:
- Returns the sharingConversations.
-
getClientChannelWeight
public int getClientChannelWeight()Get the weighting to influence which client-connection channel definition is used- Returns:
- clientChannelWeight
-
getConnectionAffinity
public int getConnectionAffinity()Get connection affinity. This field defines whether client applications that connect multiple times using the same queue manager name, use the same client channel- Returns:
- connectionAffinity
-
getBatchDataLimit
public int getBatchDataLimit()Get the limit, in kilobytes, of the amount of data that can be sent through a channel before taking a sync point.- Returns:
- batchDataLimit for this channel definition
-
setBatchDataLimit
public void setBatchDataLimit(int batchDataLimit) Set the BatchDataLimit- Parameters:
batchDataLimit- for this channel definition
-
getMaxInstances
public int getMaxInstances()Get the maximum number of simultaneous instances of an individual server-connection channel that can be started.- Returns:
- maxInstances
-
getMaxInstancesPerClient
public int getMaxInstancesPerClient()Get the maximum number of simultaneous instances of an individual server-connection channel that can be started from a single client- Returns:
- maxInstances
-
getPropertyControl
public int getPropertyControl()Get propertyControl. This field specifies what happens to properties of messages when the message is about to be sent to a V6 or prior queue manager (a queue manager that does not understand the concept of a property descriptor).- Returns:
- propertyControl
-
getCertificateLabel
Get the details of the certificate label being used- Returns:
- certificateLabel. Returned value is whitespace trimmed. Empty string when not set
-
setCertificateLabel
Set the certificateLabel- Parameters:
certificateLabel- for this channel definition
-
setupForTest
public void setupForTest(int ptrSize) - Specified by:
setupForTestin interfacecom.ibm.mq.jmqi.internal.MqiStructure- Overrides:
setupForTestin classcom.ibm.mq.jmqi.internal.AbstractMqiStructure- Parameters:
ptrSize- The number of bytes to write for each pointer in the structure
-
getFirstVersion
public int getFirstVersion()- Specified by:
getFirstVersionin interfacecom.ibm.mq.jmqi.internal.MqiStructure- Overrides:
getFirstVersionin classcom.ibm.mq.jmqi.internal.AbstractMqiStructure- Returns:
- the first version
-
getCurrentVersion
public int getCurrentVersion()- Specified by:
getCurrentVersionin interfacecom.ibm.mq.jmqi.internal.MqiStructure- Overrides:
getCurrentVersionin classcom.ibm.mq.jmqi.internal.AbstractMqiStructure- Returns:
- the current version
-