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 and Description

MQCXP()

Constructors
Constructor and Description
`MQCXP()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MQCSP`	`createMQCSP()` Creates and returns an instance of the MQCSP class.
`int`	`getCurrentVersion()`
`int`	`getExitId()`
`int`	`getExitReason()`
`int`	`getExitResponse()`
`int`	`getExitResponse2()`
`byte[]`	`getExitUserArea()`
`int`	`getFeedback()`
`int`	`getFirstVersion()`
`int`	`getMaxSegmentLength()`
`int`	`getMsgRetryInterval()`
`int`	`getMsgRetryReason()`
`int`	`getRequiredBufferSize(int ptrSize, com.ibm.mq.jmqi.system.JmqiCodepage cp)`
`MQCSP`	`getSecurityParms()` Get any security parameters
`int`	`getSize(int ptrSize)` The byte size of the structure
`static int`	`getSize(com.ibm.mq.jmqi.JmqiEnvironment env, int version, int ptrSize)` The byte size of the fixed part of the structure
`static int`	`getSizeV3(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`static int`	`getSizeV4(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`static int`	`getSizeV5(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`static int`	`getSizeV6(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`static int`	`getSizeV7(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`static int`	`getSizeV8(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`static int`	`getSizeV9(com.ibm.mq.jmqi.JmqiEnvironment env, int ptrSize)`
`void`	`setExitId(int exitId)`
`void`	`setExitReason(int exitReason)`
`void`	`setExitResponse(int exitResponse)`
`void`	`setExitResponse2(int exitResponse2)`
`void`	`setFeedback(int feedback)`
`void`	`setMaxSegmentLength(int maxSegmentLength)`
`void`	`setMsgRetryCount(int msgRetryCount)`
`void`	`setMsgRetryInterval(int msgRetryInterval)`
`void`	`setMsgRetryReason(int msgRetryReason)`
`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 Detail
  - MQCXP
```
public MQCXP()
```
- Method Detail
  - 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()
```
    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
  - getSizeV3
```
public static int getSizeV3(com.ibm.mq.jmqi.JmqiEnvironment env,
                            int ptrSize)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    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)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    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)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    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)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    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)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    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)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    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)
```
    Parameters:
    
    env -
    
    ptrSize -
    
    Returns:
    
    The size of the Version 9 fields, including the end-of-structure alignment
  - getSize
```
public int getSize(int ptrSize)
            throws JmqiException
```
    The byte size of the structure
    
    Specified by:
    
    getSize in interface com.ibm.mq.jmqi.internal.MqiStructure
    
    Overrides:
    
    getSize in class com.ibm.mq.jmqi.internal.AbstractMqiStructure
    
    Parameters:
    
    ptrSize -
    
    Returns:
    
    The byte size of the structure
    
    Throws:
    
    JmqiException
  - getSize
```
public static int getSize(com.ibm.mq.jmqi.JmqiEnvironment env,
                          int version,
                          int ptrSize)
                   throws JmqiException
```
    The byte size of the fixed part of the structure
    
    Parameters:
    
    env -
    
    version -
    
    ptrSize -
    
    Returns:
    
    The byte size of the structure in the specified environment
    
    Throws:
    
    JmqiException
  - getExitReason
```
public int getExitReason()
```
    Returns:
    
    exitReason
  - setExitReason
```
public void setExitReason(int exitReason)
```
    Parameters:
    
    exitReason -
  - getExitResponse
```
public int getExitResponse()
```
    Returns:
    
    exitResponse
  - setExitResponse
```
public void setExitResponse(int exitResponse)
```
    Parameters:
    
    exitResponse -
  - getExitResponse2
```
public int getExitResponse2()
```
    Returns:
    
    exitResponse2
  - setExitResponse2
```
public void setExitResponse2(int exitResponse2)
```
    Parameters:
    
    exitResponse2 -
  - getExitUserArea
```
public byte[] getExitUserArea()
```
    Returns:
    
    exitUserArea
  - getFeedback
```
public int getFeedback()
```
    Returns:
    
    feedback
  - setFeedback
```
public void setFeedback(int feedback)
```
    Parameters:
    
    feedback -
  - getSecurityParms
```
public MQCSP getSecurityParms()
```
    Get any security parameters
    
    Returns:
    
    Returns the mqCSP.
  - setMsgRetryCount
```
public void setMsgRetryCount(int msgRetryCount)
```
    Parameters:
    
    msgRetryCount -
  - getMsgRetryInterval
```
public int getMsgRetryInterval()
```
    Returns:
    
    msgRetryInterval
  - setMsgRetryInterval
```
public void setMsgRetryInterval(int msgRetryInterval)
```
    Parameters:
    
    msgRetryInterval -
  - getMsgRetryReason
```
public int getMsgRetryReason()
```
    Returns:
    
    msgRetryReason
  - setMsgRetryReason
```
public void setMsgRetryReason(int msgRetryReason)
```
    Parameters:
    
    msgRetryReason -
  - getMaxSegmentLength
```
public int getMaxSegmentLength()
```
    Returns:
    
    maxSegmentLength
  - setMaxSegmentLength
```
public void setMaxSegmentLength(int maxSegmentLength)
```
    Parameters:
    
    maxSegmentLength -
  - getExitId
```
public int getExitId()
```
    Returns:
    
    exitId
  - setExitId
```
public void setExitId(int exitId)
```
    Parameters:
    
    exitId -
  - getRequiredBufferSize
```
public int getRequiredBufferSize(int ptrSize,
                                 com.ibm.mq.jmqi.system.JmqiCodepage cp)
                          throws JmqiException
```
    Parameters:
    
    ptrSize -
    
    cp -
    
    Returns:
    
    required buffer size
    
    Throws:
    
    JmqiException
  - 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)

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

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

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

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

Methods inherited from class java.lang.Object

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

MQCXP

createMQCSP

getFirstVersion

getCurrentVersion

getSizeV3

getSizeV4

getSizeV5

getSizeV6

getSizeV7

getSizeV8

getSizeV9

getSize

getSize

getExitReason

setExitReason

getExitResponse

setExitResponse

getExitResponse2

setExitResponse2

getExitUserArea

getFeedback

setFeedback

getSecurityParms

setMsgRetryCount

getMsgRetryInterval

setMsgRetryInterval

getMsgRetryReason

setMsgRetryReason

getMaxSegmentLength

setMaxSegmentLength

getExitId

setExitId

getRequiredBufferSize

writeToBuffer