MQDLH

java.lang.Object
- com.ibm.mq.jmqi.JmqiObject
- - com.ibm.mq.headers.internal.Header
  - - com.ibm.mq.headers.MQDLH

All Implemented Interfaces:: MQChainable, MQData, MQHeader

public class MQDLH
extends com.ibm.mq.headers.internal.Header
implements MQChainable

MQDLH (dead-letter header) header class.

    struct tagMQDLH {
                MQCHAR4   StrucId;         // Structure identifier
                MQLONG    Version;         // Structure version number
                MQLONG    Reason;          // Reason message arrived on dead-letter (undelivered-message) queue
                MQCHAR48  DestQName;       // Name of original destination queue
                MQCHAR48  DestQMgrName;    // Name of original destination queue manager
                MQLONG    Encoding;        // Numeric encoding of data that follows MQDLH
                MQLONG    CodedCharSetId;  // Character set identifier of data that follows MQDLH
                MQCHAR8   Format;          // Format name of data that follows MQDLH
                MQLONG    PutApplType;     // Type of application that put message on dead-letter (undelivered-message) queue
                MQCHAR28  PutApplName;     // Name of application that put message on dead-letter (undelivered-message) queue
                MQCHAR8   PutDate;         // Date when message was put on dead-letter (undelivered-message) queue
                MQCHAR8   PutTime;         // Time when message was put on the dead-letter (undelivered-message) queue
        };

Nested Class Summary
- Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader
  MQHeader.Field

Field Summary

Fields
Modifier and Type Field and Description

static int SIZE
Size of the header in bytes
- Fields inherited from class com.ibm.mq.headers.internal.Header
  DEFAULT_CCSID, DEFAULT_ENCODING, delegate
- Fields inherited from class com.ibm.mq.jmqi.JmqiObject
  COMP_JM, COMP_JN, COMP_JO

Fields
Modifier and Type	Field and Description
`static int`	`SIZE` Size of the header in bytes

Constructor Summary

Constructors
Constructor and Description
`MQDLH()` Constructs an MQDLH instance with default field values.
`MQDLH(java.io.DataInput message)` Constructs an MQDLH instance populated from an MQMessage.
`MQDLH(java.io.DataInput message, int encoding, int characterSet)` Constructs an MQDLH instance populated from a DataInput source.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`format()`
`int`	`getCodedCharSetId()` Get the Character set identifier of data that follows.
`java.lang.String`	`getDestQMgrName()` get the Name of original destination queue manager
`java.lang.String`	`getDestQName()` get the Name of original destination queue
`int`	`getEncoding()` Get the numeric encoding of the data that follows.
`java.lang.String`	`getFormat()` get the Format name of data that follows MQDLH
`java.lang.String`	`getPutApplName()` get the Name of application that put message on dead-letter queue
`int`	`getPutApplType()` get the Type of application that put message on dead-letter queue
`java.lang.String`	`getPutDate()` get the Date when message was put on dead-letter queue
`java.lang.String`	`getPutTime()` get the Time when message was put on dead-letter queue
`int`	`getReason()` get the Reason message arrived on dead-letter queue
`java.lang.String`	`getStrucId()` Get the structure identifier; the value will be MQDLH_STRUC_ID
`int`	`getVersion()` Get the Structure version number
`int`	`nextCharacterSet()`
`void`	`nextCharacterSet(int value)` Sets the CCSID of the next header or message content.
`int`	`nextEncoding()`
`void`	`nextEncoding(int value)` Sets the numeric encoding of the next header or message content.
`java.lang.String`	`nextFormat()`
`void`	`nextFormat(java.lang.String value)` Sets the format of the next header or message content.
`void`	`setCodedCharSetId(int value)` Set the Character set identifier of data that follows.
`void`	`setDestQMgrName(java.lang.String value)` set the Name of original destination queue manager
`void`	`setDestQName(java.lang.String value)` set the Name of original destination queue
`void`	`setEncoding(int value)` Set the numeric encoding of the data that follows.
`void`	`setFormat(java.lang.String value)` set the Format name of data that follows MQDLH
`void`	`setPutApplName(java.lang.String value)` set the Name of application that put message on dead-letter queue
`void`	`setPutApplType(int value)` set the Type of application that put message on dead-letter queue
`void`	`setPutDate(java.lang.String value)` set the Date when message was put on dead-letter queue
`void`	`setPutTime(java.lang.String value)` set the Time when message was put on dead-letter queue
`void`	`setReason(int value)` set the Reason message arrived on dead-letter queue

Methods inherited from class com.ibm.mq.headers.internal.Header
characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, size, store, store, toString, type, validate, write, write

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SIZE
```
public static final int SIZE
```
    Size of the header in bytes
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MQDLH
```
public MQDLH()
```
    Constructs an MQDLH instance with default field values.
  - MQDLH
```
public MQDLH(java.io.DataInput message)
      throws MQDataException,
             java.io.IOException
```
    Constructs an MQDLH instance populated from an MQMessage.
    
    Parameters:
    message - the message to read
    
    Throws:
    
    MQDataException - if the message content does not yield a valid MQDLH stucture
    
    java.io.IOException - if there is a problem reading the message content
  - MQDLH
```
public MQDLH(java.io.DataInput message,
     int encoding,
     int characterSet)
      throws MQDataException,
             java.io.IOException
```
    Constructs an MQDLH instance populated from a DataInput source.
    
    Parameters:
    message - the MQMessage or other DataInput source to read
    encoding - the initial numeric encoding of the data in the message
    characterSet - the initial CCSID of the data in the message
    
    Throws:
    
    MQDataException - if the message content does not yield a valid MQDLH stucture
    
    java.io.IOException - if there is a problem reading the message content
- Method Detail
  - getStrucId
```
public java.lang.String getStrucId()
```
    Get the structure identifier; the value will be MQDLH_STRUC_ID
    
    Returns:
    the structure identifier
  - getVersion
```
public int getVersion()
```
    Get the Structure version number
    
    Returns:
    the Structure version number
  - getReason
```
public int getReason()
```
    get the Reason message arrived on dead-letter queue
    
    Returns:
    the Reason message arrived on dead-letter queue
  - setReason
```
public void setReason(int value)
```
    set the Reason message arrived on dead-letter queue
    
    Parameters:
    value - the Reason message arrived on dead-letter queue
  - getDestQName
```
public java.lang.String getDestQName()
```
    get the Name of original destination queue
    
    Returns:
    the Name of original destination queue
  - setDestQName
```
public void setDestQName(java.lang.String value)
```
    set the Name of original destination queue
    
    Parameters:
    value - the Name of original destination queue
  - getDestQMgrName
```
public java.lang.String getDestQMgrName()
```
    get the Name of original destination queue manager
    
    Returns:
    the Name of original destination queue manager
  - setDestQMgrName
```
public void setDestQMgrName(java.lang.String value)
```
    set the Name of original destination queue manager
    
    Parameters:
    value - the Name of original destination queue manager
  - getEncoding
```
public int getEncoding()
```
    Get the numeric encoding of the data that follows.
    
    Returns:
    the numeric encoding. A combination of MQENC_* values.
  - setEncoding
```
public void setEncoding(int value)
```
    Set the numeric encoding of the data that follows.
    
    Parameters:
    value - the numeric encoding. A combination of MQENC_* values.
  - getCodedCharSetId
```
public int getCodedCharSetId()
```
    Get the Character set identifier of data that follows.
    
    Returns:
    the Character set identifier.
  - setCodedCharSetId
```
public void setCodedCharSetId(int value)
```
    Set the Character set identifier of data that follows.
    
    Parameters:
    value - the Character set identifier.
  - getFormat
```
public java.lang.String getFormat()
```
    get the Format name of data that follows MQDLH
    
    Returns:
    the Format name of data that follows MQDLH
  - setFormat
```
public void setFormat(java.lang.String value)
```
    set the Format name of data that follows MQDLH
    
    Parameters:
    value - the Format name of data that follows MQDLH
  - getPutApplType
```
public int getPutApplType()
```
    get the Type of application that put message on dead-letter queue
    
    Returns:
    the Type of application that put message on dead-letter queue
  - setPutApplType
```
public void setPutApplType(int value)
```
    set the Type of application that put message on dead-letter queue
    
    Parameters:
    value - the Type of application that put message on dead-letter queue
  - getPutApplName
```
public java.lang.String getPutApplName()
```
    get the Name of application that put message on dead-letter queue
    
    Returns:
    the Name of application that put message on dead-letter queue
  - setPutApplName
```
public void setPutApplName(java.lang.String value)
```
    set the Name of application that put message on dead-letter queue
    
    Parameters:
    value - the Name of application that put message on dead-letter queue
  - getPutDate
```
public java.lang.String getPutDate()
```
    get the Date when message was put on dead-letter queue
    
    Returns:
    the Date when message was put on dead-letter queue
  - setPutDate
```
public void setPutDate(java.lang.String value)
```
    set the Date when message was put on dead-letter queue
    
    Parameters:
    value - the Date when message was put on dead-letter queue
  - getPutTime
```
public java.lang.String getPutTime()
```
    get the Time when message was put on dead-letter queue
    
    Returns:
    the Time when message was put on dead-letter queue
  - setPutTime
```
public void setPutTime(java.lang.String value)
```
    set the Time when message was put on dead-letter queue
    
    Parameters:
    value - the Time when message was put on dead-letter queue
  - nextEncoding
```
public int nextEncoding()
```
    Specified by:
    
    nextEncoding in interface MQChainable
    
    Returns:
    the numeric encoding of the next header or message content.
    See Also:
    MQChainable.nextEncoding()
  - nextEncoding
```
public void nextEncoding(int value)
```
    Description copied from interface: MQChainable
    
    Sets the numeric encoding of the next header or message content.
    
    Specified by:
    
    nextEncoding in interface MQChainable
    
    See Also:
    MQChainable.nextEncoding(int)
  - nextCharacterSet
```
public int nextCharacterSet()
```
    Specified by:
    
    nextCharacterSet in interface MQChainable
    
    Returns:
    the CCSID of the next header or message content.
    See Also:
    MQChainable.nextCharacterSet()
  - nextCharacterSet
```
public void nextCharacterSet(int value)
```
    Description copied from interface: MQChainable
    
    Sets the CCSID of the next header or message content.
    
    Specified by:
    
    nextCharacterSet in interface MQChainable
    
    See Also:
    MQChainable.nextCharacterSet(int)
  - nextFormat
```
public java.lang.String nextFormat()
```
    Specified by:
    
    nextFormat in interface MQChainable
    
    Returns:
    the format of the next header or message content.
    See Also:
    MQChainable.nextFormat()
  - nextFormat
```
public void nextFormat(java.lang.String value)
```
    Description copied from interface: MQChainable
    
    Sets the format of the next header or message content.
    
    Specified by:
    
    nextFormat in interface MQChainable
    
    See Also:
    MQChainable.nextFormat(java.lang.String)
  - format
```
public java.lang.String format()
```
    Specified by:
    
    format in interface MQChainable
    
    Returns:
    the format associated with this header object or message content.
    See Also:
    MQChainable.format()

Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader

Fields inherited from class com.ibm.mq.headers.internal.Header

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

Methods inherited from class com.ibm.mq.headers.internal.Header

Methods inherited from class java.lang.Object

SIZE

MQDLH

MQDLH

MQDLH

getStrucId

getVersion

getReason

setReason

getDestQName

setDestQName

getDestQMgrName

setDestQMgrName

getEncoding

setEncoding

getCodedCharSetId

setCodedCharSetId

getFormat

setFormat

getPutApplType

setPutApplType

getPutApplName

setPutApplName

getPutDate

setPutDate

getPutTime

setPutTime

nextEncoding

nextEncoding

nextCharacterSet

nextCharacterSet

nextFormat

nextFormat

format