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

public class MQCD extends com.ibm.mq.jmqi.internal.AbstractMqiStructure implements Cloneable
MQCD structure
  • Field Summary

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

    COMP_JM, COMP_JN, COMP_JO

    Fields inherited from interface com.ibm.mq.jmqi.internal.MqiStructure

    sccsid
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Clone this object.
    boolean
    Compare two client MQCD structures to determine if they point at the same requested destination, with the same client connection parameters.
    int
    Get the limit, in kilobytes, of the amount of data that can be sent through a channel before taking a sync point.
    int
    Get the time interval that is used to trigger a batch heartbeat for the channel
    int
    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
    int
    Get the maximum number of messages that can be sent through a channel before synchronizing the channel
    Get the details of the certificate label being used
    int
    Get the current level of monitoring data collection for the channel
    Get the channel definition name.
    int
    Get the current level of statistics data collection for the channel
    int
    Get the type of channel
    int
    Get the weighting to influence which client-connection channel definition is used
    int
    Getthe number of clusters to which the channel belongs
    int
    Get the cluster workload channel priority
    int
    Get the cluster workload channel rank
    int
    Get the cluster workload channel weight
    int
    Get connection affinity.
    Get the connection name for the channel
    int
     
    int
    Get the data conversion value.
    int
    Get the default reconnection attribute value for a client connection channel.
    Get the description of the channel
    int
    Get the maximum time in seconds for which the channel waits for a message to arrive on the transmission queue, before terminating the channel
    int
    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
    int
    Get the length in bytes of each of the names in the lists of exit names addressed by the MsgExitPtr, SendExitPtr, and ReceiveExitPtr fields
    int
     
    int[]
    Get the list of header data compression techniques which are supported by the channel
    int
    Get the time in seconds between heartbeat flows
    int
    Getthe value passed to the communications stack for keepalive timing for the channel
    Get the local TCP/IP address defined for the channel for outbound communications
    int
    Get the count used after the count specified by the ShortRetryCount has been exhausted
    int
    Get the maximum number of seconds to wait before reattempting connection to the remote machine
    int
    Get the maximum number of simultaneous instances of an individual server-connection channel that can be started.
    int
    Get the maximum number of simultaneous instances of an individual server-connection channel that can be started from a single client
    int
    Get the maximum message length that can be transmitted on the channel
    Get the MCA name.
    byte[]
    Get the security identifier for the MCA
    int
    Get the type of message channel agent program
    Get the user identifier for the message channel agent (MCA)
    Get the LU 6.2 mode name
    int[]
    Get the list of message data compression techniques which are supported by the channel
    Get the channel message exit name
    Get the address of the first MsgExit field
    int
    Get the number of channel message exits defined in the chain
    int
    Get the number of times MCA tries to put the message, after the first attempt has failed
    Get the channel message retry exit name
    int
    Get the minimum interval in milliseconds after which the open or put operation is retried
    Get the channel message retry exit user data
    Get the channel message exit user data
    Get the address of the first MsgUserData field
    int
    Get the priority of the network connection for the channel
    int
    Get the speed at which non-persistent messages travel through the channel
    Get the password used by the message channel agent when attempting to initiate a secure SNA session with a remote message channel agent
    int
    Get propertyControl.
    int
    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
    Get the name of the queue manager that an exit can connect to
    Get the channel receive exit name
    Get the address of the first ReceiveExit field
    int
    Get the number of channel receive exits defined in the chain
    Get the channel receive exit user data
    get the address of the first ReceiveUserData field
    Get the password from a partner
    byte[]
    Get the security identifier for the remote user
    Get the first 12 bytes of a user identifier from a partner
    Get the channel security exit name
    Get the channel security exit user data
    Get the channel send exit name.
    Get the address of the first SendExit field
    int
    Get the number of channel send exits defined in the chain
    Get the channel send exit user data
    Get the address of the SendUserData field
    int
    Get the highest allowable message sequence number
    int
    Get the maximum number of conversations that can share a channel instance associated with this channel
    int
    Get the maximum number of attempts that are made to connect to a remote machine
    int
    Get the maximum number of seconds to wait before reattempting connection to the remote machine
    static int
    getSizeV11(int ptrSize)
    Gets the size of MQCD v11 structure
    static int
    getSizeV12(int ptrSize)
    Gets the size of MQCD v12 structure
    int
    Get the AMS security policy protection.
    Get the Cipher Spec that is in use when using TLS
    int
    Get the sslClientAuth - This attribute defines whether TLS client authentication is required
    Get the ssl peer name
    int
    Deprecated. 
    int[]
    Get the filtered list of supported Message compression techniques.
    Deprecated.
    int
    Get the transmission protocol to be used
    Get the user identifier used by the message channel agent when attempting to initiate a secure SNA session with a remote message channel agent
    int
    Get the highest version number that you can set for the structure
    Get the name of the transmission queue from which messages are retrieved
    int
    Generate a hashcode.
    void
    setBatchDataLimit(int batchDataLimit)
    Set the BatchDataLimit
    void
    setCertificateLabel(String certificateLabel)
    Set the certificateLabel
    void
    setSPLProtection(int splProtection)
    Set the AMS security policy protection.
    void
    setupForTest(int ptrSize)
     

    Methods inherited from class com.ibm.mq.jmqi.internal.AbstractMqiStructure

    getMaximumRequiredBufferSize, getRequiredInputBufferSize, getSize, readFromBuffer, setVersion, toString, toStringMultiLine, toTraceString, writeToBuffer, writeToTraceBuffer

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

    getJmqiEnvironment

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods 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

      public Object clone() throws CloneNotSupportedException
      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.
      Overrides:
      hashCode in class Object
      Returns:
      a unique hashcode
      See Also:
    • equals

      public boolean equals(Object x)
      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
      Overrides:
      equals in class Object
      Parameters:
      x - the MQCD object against which to compare
      Returns:
      'true' if the objects are equal
    • 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

      public String 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

      public String 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

      public String 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

      public String 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

      public String 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

      public String getMcaUserIdentifier()
      Get the user identifier for the message channel agent (MCA)
      Returns:
      MCA UserIdentifier
    • getModeName

      public String 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

      public String 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

      public String 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

      public String 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

      public String 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

      public String getRemotePassword()
      Get the password from a partner
      Returns:
      remotePassword
    • getRemoteSecurityId

      public byte[] getRemoteSecurityId()
      Get the security identifier for the remote user
      Returns:
      remoteSecurityId
    • getRemoteUserIdentifier

      public String getRemoteUserIdentifier()
      Get the first 12 bytes of a user identifier from a partner
      Returns:
      remoteUserIdentifier
    • getSecurityExit

      public String getSecurityExit()
      Get the channel security exit name
      Returns:
      securityExit
    • getSecurityUserData

      public String 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

      public String 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

      public String getSslPeerName()
      Get the ssl peer name
      Returns:
      the sslPeerName
    • getStrucLength

      public int getStrucLength()
      Deprecated.
      Get the structure length
      Returns:
      strucLength
    • getTpName

      public String 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

      public String 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:
      getVersion in interface com.ibm.mq.jmqi.internal.MqiStructure
      Overrides:
      getVersion in class com.ibm.mq.jmqi.internal.AbstractMqiStructure
      Returns:
      the version
    • getXmitQName

      public String getXmitQName()
      Get the name of the transmission queue from which messages are retrieved
      Returns:
      thexmitQName
    • getMsgExit

      public String getMsgExit()
      Get the channel message exit name
      Returns:
      the msgExit
    • getMsgExitPtr

      public String getMsgExitPtr()
      Get the address of the first MsgExit field
      Returns:
      the msgExitPtr
    • getMsgUserData

      public String getMsgUserData()
      Get the channel message exit user data
      Returns:
      the msgUserData
    • getMsgUserDataPtr

      public String getMsgUserDataPtr()
      Get the address of the first MsgUserData field
      Returns:
      the msgUserDataPtr
    • getReceiveExit

      public String getReceiveExit()
      Get the channel receive exit name
      Returns:
      the receiveExit
    • getReceiveExitPtr

      public String getReceiveExitPtr()
      Get the address of the first ReceiveExit field
      Returns:
      the receiveExitPtr
    • getReceiveUserData

      public String getReceiveUserData()
      Get the channel receive exit user data
      Returns:
      the receiveUserData
    • getReceiveUserDataPtr

      public String getReceiveUserDataPtr()
      get the address of the first ReceiveUserData field
      Returns:
      the receiveUserDataPtr
    • getSendExit

      public String getSendExit()
      Get the channel send exit name.
      Returns:
      the sendExit
    • getSendExitPtr

      public String getSendExitPtr()
      Get the address of the first SendExit field
      Returns:
      the sendExitPtr
    • getSendUserData

      public String getSendUserData()
      Get the channel send exit user data
      Returns:
      the sendUserData
    • getSendUserDataPtr

      public String 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

      public String getCertificateLabel()
      Get the details of the certificate label being used
      Returns:
      certificateLabel. Returned value is whitespace trimmed. Empty string when not set
    • setCertificateLabel

      public void setCertificateLabel(String certificateLabel)
      Set the certificateLabel
      Parameters:
      certificateLabel - for this channel definition
    • setupForTest

      public void setupForTest(int ptrSize)
      Specified by:
      setupForTest in interface com.ibm.mq.jmqi.internal.MqiStructure
      Overrides:
      setupForTest in class com.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:
      getFirstVersion in interface com.ibm.mq.jmqi.internal.MqiStructure
      Overrides:
      getFirstVersion in class com.ibm.mq.jmqi.internal.AbstractMqiStructure
      Returns:
      the first version
    • getCurrentVersion

      public int getCurrentVersion()
      Specified by:
      getCurrentVersion in interface com.ibm.mq.jmqi.internal.MqiStructure
      Overrides:
      getCurrentVersion in class com.ibm.mq.jmqi.internal.AbstractMqiStructure
      Returns:
      the current version