JMSData (Maximo API)

java.lang.Object
- psdi.iface.jms.JMSData

public class JMSData
extends java.lang.Object

Represents a JMS Bytes or Text Message.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTIONTYPE` The message property name to indicate MIF Inbound Action Type.
`static java.lang.String`	`ALTKEY` Alternate index name to process inbound transaction.
`static java.lang.String`	`DELIVERY_COUNT` The key for holding the number of times the messages has been delivered.
`static java.lang.String`	`DESTINATION_JNDI_NAME` The key for holding the JNDI name of the Destination.
`static java.lang.String`	`EXTRACTFILEID` The key for holding extract file id.
`static java.lang.String`	`EXTRACTFILESEQ` The key for holding extract file sequence.
`static java.lang.String`	`JMS_MESSAGEID` The key for holding the JMS provider generated message id.
`static java.lang.String`	`MAPPINGID` The message property name to indicate ID to be used in JSON Map name.
`static java.lang.String`	`MESSAGE_COMPRESSED` The key for storing in message properties whether a message body is compressed.
`static java.lang.String`	`MESSAGE_REDELIVERED` The key for holding if the message has been redelivered.
`static java.lang.String`	`MESSAGE_UNCOMPRESSED_LENGTH` The key for storing the uncompressed length of the messages in the message properties.
`static java.lang.String`	`MESSAGE_UNIQUEID` The key for holding the generated internal unique id for a JMS message.
`static java.lang.String`	`MIMETYPE` The message property name to indicate Mime Type.
`static java.lang.String`	`MSGTYPE_TEXT` The message property name to indicate Text message.
`static java.lang.String`	`RECOVERY_STATUS` The key for holding extract file id.
`static java.lang.String`	`TEXT_ENCODING` The message property name to indicate Text message encoding.

Constructor Summary

Constructors
Constructor and Description
`JMSData(byte[] msgBody, java.util.Map msgHeaders)`
`JMSData(byte[] msgBody, java.util.Map msgHeaders, boolean compress)`
`JMSData(java.lang.String textMsgBody, java.util.Map msgHeaders)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getMessageBody()`
`java.util.Map`	`getMessageProperties()`
`java.lang.String`	`getTextMessageBody()`
`boolean`	`isCompress()`
`boolean`	`isTextMessage()`

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

- Field Detail
  - MESSAGE_UNCOMPRESSED_LENGTH
```
public static final java.lang.String MESSAGE_UNCOMPRESSED_LENGTH
```
    The key for storing the uncompressed length of the messages in the message properties. [For internal use only]
    
    See Also:
    
    Constant Field Values
  - MESSAGE_COMPRESSED
```
public static final java.lang.String MESSAGE_COMPRESSED
```
    The key for storing in message properties whether a message body is compressed.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_UNIQUEID
```
public static final java.lang.String MESSAGE_UNIQUEID
```
    The key for holding the generated internal unique id for a JMS message. This id is made numeric characters [0..9].
    
    See Also:
    
    Constant Field Values
  - JMS_MESSAGEID
```
public static final java.lang.String JMS_MESSAGEID
```
    The key for holding the JMS provider generated message id.
    
    See Also:
    
    Constant Field Values
  - DESTINATION_JNDI_NAME
```
public static final java.lang.String DESTINATION_JNDI_NAME
```
    The key for holding the JNDI name of the Destination.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_REDELIVERED
```
public static final java.lang.String MESSAGE_REDELIVERED
```
    The key for holding if the message has been redelivered.
    
    See Also:
    
    Constant Field Values
  - DELIVERY_COUNT
```
public static final java.lang.String DELIVERY_COUNT
```
    The key for holding the number of times the messages has been delivered.
    
    See Also:
    
    Constant Field Values
  - EXTRACTFILEID
```
public static final java.lang.String EXTRACTFILEID
```
    The key for holding extract file id.
    
    See Also:
    
    Constant Field Values
  - RECOVERY_STATUS
```
public static final java.lang.String RECOVERY_STATUS
```
    The key for holding extract file id.
    
    See Also:
    
    Constant Field Values
  - EXTRACTFILESEQ
```
public static final java.lang.String EXTRACTFILESEQ
```
    The key for holding extract file sequence.
    
    See Also:
    
    Constant Field Values
  - MSGTYPE_TEXT
```
public static final java.lang.String MSGTYPE_TEXT
```
    The message property name to indicate Text message.
    
    See Also:
    
    Constant Field Values
  - TEXT_ENCODING
```
public static final java.lang.String TEXT_ENCODING
```
    The message property name to indicate Text message encoding.
    
    See Also:
    
    Constant Field Values
  - MIMETYPE
```
public static final java.lang.String MIMETYPE
```
    The message property name to indicate Mime Type.
    
    See Also:
    
    Constant Field Values
  - ACTIONTYPE
```
public static final java.lang.String ACTIONTYPE
```
    The message property name to indicate MIF Inbound Action Type.
    
    See Also:
    
    Constant Field Values
  - MAPPINGID
```
public static final java.lang.String MAPPINGID
```
    The message property name to indicate ID to be used in JSON Map name.
    
    See Also:
    
    Constant Field Values
  - ALTKEY
```
public static final java.lang.String ALTKEY
```
    Alternate index name to process inbound transaction.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JMSData
```
public JMSData(byte[] msgBody,
               java.util.Map msgHeaders,
               boolean compress)
```
    Parameters:
    
    msgBody - the message body content.
    
    msgHeaders - the Map of message properties.
    
    compress - indicates whether to compress the message body.
  - JMSData
```
public JMSData(byte[] msgBody,
               java.util.Map msgHeaders)
```
    Parameters:
    
    msgBody - the message body content.
    
    msgHeaders - the Map of message properties.
  - JMSData
```
public JMSData(java.lang.String textMsgBody,
               java.util.Map msgHeaders)
```
    Parameters:
    
    msgBody - the message body content.
    
    msgHeaders - the Map of message properties.
- Method Detail
  - getMessageProperties
```
public java.util.Map getMessageProperties()
```
    Returns:
    
    the message properties.
  - getMessageBody
```
public byte[] getMessageBody()
```
    Returns:
    
    the message body.
  - getTextMessageBody
```
public java.lang.String getTextMessageBody()
```
    Returns:
    
    the message body.
  - isCompress
```
public boolean isCompress()
```
    Returns:
    
    whether to compress the message body.
  - isTextMessage
```
public boolean isTextMessage()
```

Methods inherited from class java.lang.Object

MESSAGE_UNCOMPRESSED_LENGTH

MESSAGE_COMPRESSED

MESSAGE_UNIQUEID

JMS_MESSAGEID

DESTINATION_JNDI_NAME

MESSAGE_REDELIVERED

DELIVERY_COUNT

EXTRACTFILEID

RECOVERY_STATUS

EXTRACTFILESEQ

MSGTYPE_TEXT

TEXT_ENCODING

MIMETYPE

ACTIONTYPE

MAPPINGID

ALTKEY

JMSData

JMSData

JMSData

getMessageProperties

getMessageBody

getTextMessageBody

isCompress

isTextMessage