Package com.ibm.mq.exits

Class MQCXP

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.jmqi.internal.AbstractMqiStructure
com.ibm.mq.exits.MQCXP
All Implemented Interfaces:
com.ibm.mq.jmqi.internal.MqiStructure
public class MQCXP extends com.ibm.mq.jmqi.internal.AbstractMqiStructure
MQCXP structure struct tagMQCXP { MQCHAR4 StrucId; MQLONG Version; MQLONG ExitId; MQLONG ExitReason; MQLONG ExitResponse; MQLONG ExitResponse2; MQLONG Feedback; MQLONG MaxSegmentLength; MQBYTE16 ExitUserArea; MQCHAR32 ExitData; MQLONG MsgRetryCount; MQLONG MsgRetryInterval; MQLONG MsgRetryReason; MQLONG HeaderLength; MQCHAR48 PartnerName; MQLONG FAPLevel; MQLONG CapabilityFlags; MQLONG ExitNumber; MQLONG ExitSpace; MQCHAR12 SSLCertUserid; MQLONG SSLRemCertIssNameLength; MQPTR SSLRemCertIssNamePtr; PMQCSP SecurityParms; MQLONG CurHdrCompression; MQLONG CurMsgCompression; MQHCONN Hconn; MQBOOL SharingConversations; MQLONG UserSource; PMQIEP pEntryPoints; MQCHAR4 RemoteProduct; MQCHAR8 RemoteVersion; };

  • 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
    MQCXP()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    MQCSP
    createMQCSP()
    Creates and returns an instance of the MQCSP class.
    int
    getCurrentVersion()
    Get the current version of channel exit parameter class
    int
    getExitId()
    Get the type of exit being called
    int
    getExitReason()
    Get the exitReason.
    int
    getExitResponse()
    Get exitReasonse.
    int
    getExitResponse2()
    Get exitResponse2.
    byte[]
    getExitUserArea()
    Specifies the exit user area - a field available for the exit to use.
    int
    getFeedback()
    Get feedback code from exit
    int
    getFirstVersion()
    Get version 1 channel exit parameter class
    int
    getMaxSegmentLength()
    Get the maximum length in bytes that can be sent in a single transmission
    int
    getMsgRetryInterval()
    Get the minimum interval in milliseconds after which the put operation is retried.
    int
    getMsgRetryReason()
    Get the reason code from the previous attempt to put the message
    int
    getRequiredBufferSize(int ptrSize, com.ibm.mq.jmqi.system.JmqiCodepage cp)
    Get the required buffer size
    MQCSP
    getSecurityParms()
    Get the security parameters from this class
    int
    getSize(int ptrSize)
    Get the byte size of the MQCXP class
    static int
    getSize(com.ibm.mq.jmqi.JmqiEnvironment env, int version, int ptrSize)
    Get the byte size of the fixed part of the structure
    static int
    getSizeV3(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 3 of MQCXP class
    static int
    getSizeV4(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 4 of MQCXP class
    static int
    getSizeV5(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 5 of MQCXP class
    static int
    getSizeV6(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 6 of MQCXP class
    static int
    getSizeV7(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 7 of MQCXP class
    static int
    getSizeV8(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 8 of MQCXP class
    static int
    getSizeV9(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
    Get the size of version 9 of MQCXP class
    void
    setExitId(int exitId)
    Set the type of exit being called
    void
    setExitReason(int exitReason)
    Set exitReason.
    void
    setExitResponse(int exitResponse)
    Set the exitResponse.
    void
    setExitResponse2(int exitResponse2)
    Set the secondary response
    void
    setFeedback(int feedback)
    Set the feedback code to exit
    void
    setMaxSegmentLength(int maxSegmentLength)
    Set the maximum length in bytes that can be sent in a single transmission
    void
    setMsgRetryCount(int msgRetryCount)
    Set the number of times the message has to be retried
    void
    setMsgRetryInterval(int msgRetryInterval)
    Set the minimum interval in milliseconds after which the put operation is retried.
    void
    setMsgRetryReason(int msgRetryReason)
    Set the reason code from the previous attempt to put the message
    int
    writeToBuffer(byte[] buffer, int offset, int ptrSize, boolean swap, com.ibm.mq.jmqi.system.JmqiCodepage cp, com.ibm.mq.jmqi.system.JmqiTls tls)
     

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

    getMaximumRequiredBufferSize, getRequiredInputBufferSize, getVersion, readFromBuffer, setupForTest, setVersion, toString, toStringMultiLine, toTraceString, writeToBuffer, writeToTraceBuffer

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

    getJmqiEnvironment

    Methods inherited from class java.lang.Object

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

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

    addFieldsToFormatter, readFromBuffer

  • Constructor Details

    • MQCXP

      public MQCXP()

  • Method Details

    • createMQCSP

      public MQCSP createMQCSP()
      Creates and returns an instance of the MQCSP class. This instance can be used set the user credentials and authentication type. Once the parameters are set, ensure that the method #setSecurityParms() is used to pass the MQCSP object.
      Returns:
      A new instance of MQCSP

    • getFirstVersion

      public int getFirstVersion()
      Get version 1 channel exit parameter class
      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()
      Get the current version of channel exit parameter class
      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

    • getSizeV3

      public static int getSizeV3(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 3 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the version 3 fields, including the end-of-structure alignment

    • getSizeV4

      public static int getSizeV4(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 4 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the Version 4 fields, including the end-of-structure alignment

    • getSizeV5

      public static int getSizeV5(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 5 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the Version 5 fields, including the end-of-structure alignment

    • getSizeV6

      public static int getSizeV6(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 6 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the Version 6 fields, including the end-of-structure alignment

    • getSizeV7

      public static int getSizeV7(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 7 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the Version 7 fields, including the end-of-structure alignment

    • getSizeV8

      public static int getSizeV8(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 8 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the Version 8 fields, including the end-of-structure alignment

    • getSizeV9

      public static int getSizeV9(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)
      Get the size of version 9 of MQCXP class
      Parameters:
      env - An instance of JmqiEnvironment class
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The size of the Version 9 fields, including the end-of-structure alignment

    • getSize

      public int getSize(int ptrSize) throws JmqiException
      Get the byte size of the MQCXP class
      Specified by:
      getSize in interface com.ibm.mq.jmqi.internal.MqiStructure
      Overrides:
      getSize in class com.ibm.mq.jmqi.internal.AbstractMqiStructure
      Parameters:
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The byte size of the structure
      Throws:
      JmqiException - in case of any error

    • getSize

      public static int getSize(com.ibm.mq.jmqi.JmqiEnvironment env, int version, int ptrSize) throws JmqiException
      Get the byte size of the fixed part of the structure
      Parameters:
      env - An instance of JmqiEnvironment class
      version - of the MQCXP structure
      ptrSize - The number of bytes to write for each pointer in the structure
      Returns:
      The byte size of the structure in the specified environment
      Throws:
      JmqiException - in case of any error

    • getExitReason

      public int getExitReason()
      Get the exitReason. Specifies the reason why the exit is called
      Returns:
      exitReason the reason why the exit was called

    • setExitReason

      public void setExitReason(int exitReason)
      Set exitReason. Specified the reason why the exit is being called and is set on entry to the exit routine
      Parameters:
      exitReason - Specifies the reason why the exit is called

    • getExitResponse

      public int getExitResponse()
      Get exitReasonse. Specifies the response from the exit
      Returns:
      exitResponse specifies the response from the exit

    • setExitResponse

      public void setExitResponse(int exitResponse)
      Set the exitResponse. Specifies the response from the exit
      Parameters:
      exitResponse - set the response from the exit.

    • getExitResponse2

      public int getExitResponse2()
      Get exitResponse2. Specifies the secondary response from exit
      Returns:
      exitResponse2 specifies the secondary response from the exit

    • setExitResponse2

      public void setExitResponse2(int exitResponse2)
      Set the secondary response
      Parameters:
      exitResponse2 - specifies the secondary response to the exit

    • getExitUserArea

      public byte[] getExitUserArea()
      Specifies the exit user area - a field available for the exit to use.
      Returns:
      exitUserArea

    • getFeedback

      public int getFeedback()
      Get feedback code from exit
      Returns:
      feedback code from the exit

    • setFeedback

      public void setFeedback(int feedback)
      Set the feedback code to exit
      Parameters:
      feedback - code

    • getSecurityParms

      public MQCSP getSecurityParms()
      Get the security parameters from this class
      Returns:
      the instance of MQCSP from this class.

    • setMsgRetryCount

      public void setMsgRetryCount(int msgRetryCount)
      Set the number of times the message has to be retried
      Parameters:
      msgRetryCount - specifies the number of times the message has been retried

    • getMsgRetryInterval

      public int getMsgRetryInterval()
      Get the minimum interval in milliseconds after which the put operation is retried.
      Returns:
      msgRetryInterval specifies the minimum interval in milliseconds after which the put operation is retried

    • setMsgRetryInterval

      public void setMsgRetryInterval(int msgRetryInterval)
      Set the minimum interval in milliseconds after which the put operation is retried.
      Parameters:
      msgRetryInterval - specifies the minimum interval in milliseconds after which the put operation is retried.

    • getMsgRetryReason

      public int getMsgRetryReason()
      Get the reason code from the previous attempt to put the message
      Returns:
      msgRetryReason specifies the reason code from the previous attempt to put the message

    • setMsgRetryReason

      public void setMsgRetryReason(int msgRetryReason)
      Set the reason code from the previous attempt to put the message
      Parameters:
      msgRetryReason - specifies the reason code from the previous attempt to put the message

    • getMaxSegmentLength

      public int getMaxSegmentLength()
      Get the maximum length in bytes that can be sent in a single transmission
      Returns:
      maxSegmentLength in bytes

    • setMaxSegmentLength

      public void setMaxSegmentLength(int maxSegmentLength)
      Set the maximum length in bytes that can be sent in a single transmission
      Parameters:
      maxSegmentLength - in bytes

    • getExitId

      public int getExitId()
      Get the type of exit being called
      Returns:
      exitId type of exit

    • setExitId

      public void setExitId(int exitId)
      Set the type of exit being called
      Parameters:
      exitId - type of exit

    • getRequiredBufferSize

      public int getRequiredBufferSize(int ptrSize, com.ibm.mq.jmqi.system.JmqiCodepage cp) throws JmqiException
      Get the required buffer size
      Parameters:
      ptrSize - The number of bytes to write for each pointer in the structure
      cp - JmqiCodepage unused
      Returns:
      required buffer size
      Throws:
      JmqiException - if an error occurs

    • writeToBuffer

      public int writeToBuffer(byte[] buffer, int offset, int ptrSize, boolean swap, com.ibm.mq.jmqi.system.JmqiCodepage cp, com.ibm.mq.jmqi.system.JmqiTls tls) throws JmqiException
      Throws:
      JmqiException
      See Also:
      • MqiStructure.writeToBuffer(byte[], int, int, boolean, JmqiCodepage, JmqiTls)