CacheEventMessageImpl (Solace JMS API v10.10.2)

java.lang.Object
- com.solacesystems.jcsmp.impl.solcache.CacheEventMessageImpl

All Implemented Interfaces:

BytesXMLMessage, CacheEventMessage, EventMessage, XMLMessage
```
public class CacheEventMessageImpl
extends Object
implements CacheEventMessage
```

Field Summary
- Fields inherited from interface com.solacesystems.jcsmp.XMLMessage
  MSGDUMP_BRIEF, MSGDUMP_FULL, SDK_BINARY_METADATA_PORTION, STRUCTURED_MAP_MESSAGE, STRUCTURED_STREAM_MESSAGE, STRUCTURED_TEXT_MESSAGE, UNSTRUCTURED_JMS_BYTES_MESSAGE, UNSTRUCTURED_JMS_OBJECT_MESSAGE, UNSTRUCTURED_JMS_PROPERTIES_MESSAGE, UNSTRUCTURED_MESSAGE, UNSTRUCTURED_XML_MESSAGE

Constructor Summary

Constructors
Constructor and Description
`CacheEventMessageImpl(Long id, Topic topic, CacheRequestResult result)`
`CacheEventMessageImpl(Long id, Topic topic, JCSMPException ex)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`ackMessage()` Acknowledges the message.
`void`	`clearAttachment()` Deletes the attachment to the message.
`void`	`clearBinaryMetadataBytes(int type)` Clears any existing binary metadata.
`void`	`clearContent()` Clears the message content.
`void`	`clearMetadata()`
`void`	`clearQueueNameLocation()`
`void`	`clearTopicNameLocation()`
`void`	`deletePriority()`
`String`	`dump()` Produces a human-readable dump of the message properties and its contents (can be quite large).
`String`	`dump(int flags)` Produces a human-readable dump of the message properties and its contents.
`long`	`getAckMessageId()`
`String`	`getApplicationMessageId()` Gets the application message ID, a string for an application-specific message identifier.
`String`	`getApplicationMessageType()` Gets the application message type.
`String`	`getAppMessageID()`
`String`	`getAppMessageType()`
`ByteBuffer`	`getAttachmentByteBuffer()` Gets a `ByteBuffer` containing the message's binary attachment.
`int`	`getAttachmentContentLength()` Gets the length of the attachment.
`int`	`getBinaryMetadataContentLength(int type)`
`Collection<Integer>`	`getBinaryMetadataTypes()`
`byte[]`	`getBytes()` Gets a byte array with the message content of the XML part.
`JCSMPException`	`getCacheRequestException()` Returns the exception that occurred when a cache request failed.
`Long`	`getCacheRequestId()` Return the request ID set in the cache request.
`CacheRequestResult`	`getCacheRequestResult()` Returns the result of the cache request.
`Topic`	`getCacheRequestTopic()` Returns the topic the cache data was for.
`List<Long>`	`getConsumerIdList()` Gets a read-only list of consumer IDs set on this message.
`int`	`getContentLength()` The length of the message content.
`String`	`getCorrelationId()` Gets the correlation ID.
`Object`	`getCorrelationKey()` Gets the correlation key for the message.
`User_Cos`	`getCos()` Gets the Class of Service (CoS) value for this message.
`boolean`	`getDeliverToOne()` Gets whether this message is configured for delivering to one client only.
`int`	`getDeliveryCount()` Get message delivery count.
`DeliveryMode`	`getDeliveryMode()` Gets the delivery mode of the message.
`Destination`	`getDestination()` Gets the destination this message was published to.
`String`	`getDestinationName()`
`String`	`getDestinationTopicSuffix()` Returns the string, without a leading delimiter, that is found after the session's default ReplyTo base topic in an incoming message.
`boolean`	`getDiscardIndication()` Returns `true` if one or more messages have been discarded prior to the current message, else `false`.
`long`	`getExpiration()` The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
`String`	`getHTTPContentEncoding()` Gets the HTTP content encoding header value from interaction with an HTTP client.
`String`	`getHTTPContentType()` Gets the HTTP content type header value from interaction with an HTTP client.
`String`	`getMessageId()` Returns the message ID set by JCSMP during send or reception.
`long`	`getMessageIdLong()` Returns the message ID set by JCSMP during send or reception.
`MessageType`	`getMessageType()`
`int`	`getMetadataContentLength()`
`int`	`getPriority()` Returns priority value in the range of 0–255, or -1 if it is not set.
`SDTMap`	`getProperties()` Gets the user properties map.
`int`	`getQueueNameLength()`
`int`	`getQueueNameOffset()`
`long`	`getReceiveTimestamp()` Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`boolean`	`getRedelivered()` Indicates if the message has been delivered by the appliance to the API before.
`Destination`	`getReplyTo()` Gets the replyTo destination
`String`	`getReplyToSuffix()` Returns the appended suffix to the session's default ReplyTo base topic set as part of this message's ReplyTo topic destination.
`String`	`getSenderId()` Returns the Sender's ID.
`String`	`getSenderID()`
`Long`	`getSenderTimestamp()` Gets the send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`Long`	`getSendTimestamp()`
`Long`	`getSequenceNumber()` Gets the sequence number.
`byte`	`getStructuredMsgType()` Gets the structured message type.
`long`	`getTimeToLive()` The number of milliseconds before the message is discarded or moved to Dead Message Queue.
`int`	`getTopicNameLength()`
`int`	`getTopicNameOffset()`
`Long`	`getTopicSequenceNumber()` Gets the topic sequence number generated by the appliance.
`boolean`	`getTQDiscardIndication()`
`byte[]`	`getUserData()` When an application sends a message, it can optionally attach application-specific data along with the message, such as user data.
`boolean`	`hasAttachment()` Checks whether the message has an attachment.
`boolean`	`hasBinaryMetadata(int type)`
`boolean`	`hasContent()` Checks whether the message has content.
`boolean`	`hasMetadata()`
`boolean`	`hasUserData()` Checks whether a received message includes user data.
`boolean`	`isAckImmediately()` Test if the ACK Immediately message property is set or not.
`boolean`	`isCacheMessage()` Returns `true` if this message was part of a cache reply.
`boolean`	`isDeliveryCountSupported()` Returns `true` if Delivery Count is supported.
`boolean`	`isDMQEligible()` The method returns whether the message is eligible to be moved to a Dead Message Queue (DMQ) upon expiration.
`boolean`	`isElidingEligible()` Checks whether the message is eligible for eliding.
`boolean`	`isPrioritySet()`
`boolean`	`isReadOnly()` Tests if the message is read only.
`boolean`	`isReplyMessage()` Returns whether the message's reply field is set, indicating that this message is a reply.
`boolean`	`isStructuredMsg()` Returns whether the message is a structured message.
`boolean`	`isSuspect()` Return `true` if this message was part of a cache reply that had the suspect flag set.
`int`	`readAttachmentBytes(byte[] byteOutputBuffer)` Reads bytes from an attachment, copying the data to the supplied byte array.
`int`	`readAttachmentBytes(byte[] byteOutputBuffer, int length)` Reads `length` bytes from an attachment, copying the data to the supplied byte array.
`int`	`readAttachmentBytes(int srcPos, byte[] byteOutputBuffer, int destPos, int length)` Reads `length` bytes from an attachment, copying the data to the supplied byte array.
`int`	`readBinaryMetadataBytes(int type, byte[] byteOutputBuffer)`
`int`	`readBytes(byte[] value)` Reads a byte array from the message content and copies the data read to the supplied byte array.
`int`	`readBytes(byte[] value, int length)` Reads `length` bytes from the message content, and copies the data read to the supplied byte array.
`int`	`readContentBytes(byte[] byteOutputBuffer)` Reads from the message content, copying the data to the supplied byte array.
`int`	`readContentBytes(byte[] byteOutputBuffer, int length)` Reads `length` bytes from the message content, copying the data to the supplied byte array.
`int`	`readContentBytes(int srcPos, byte[] byteOutputBuffer, int destPos, int length)` Reads `length` bytes from the message content, copying the data to the supplied byte array.
`int`	`readMetadataBytes(byte[] byteOutputBuffer)`
`int`	`readMetadataBytes(byte[] byteOutputBuffer, int length)`
`int`	`readMetadataBytes(int srcPos, byte[] byteOutputBuffer, int destPos, int length)`
`void`	`rejectMessage()`
`void`	`reset()` Resets the message, clearing all fields, preparing it for publishing again.
`void`	`rewindAttachment()` Resets the read mark for attachment to 0.
`void`	`rewindContent()` Resets the read mark for the message content to 0.
`void`	`rewindMetadata()`
`void`	`setAckImmediately(boolean ackImmediately)` Set the ACK Immediately message property.
`void`	`setApplicationMessageId(String msgId)` Sets the message ID (a string for an application-specific message identifier).
`void`	`setApplicationMessageType(String appMsgType)` Sets the application message type.
`void`	`setAppMessageID(String msgId)`
`void`	`setAppMessageType(String appMsgType)`
`void`	`setAsReplyMessage(boolean isReply)` Sets the reply field of the message.
`void`	`setCorrelationId(String id)` Sets the correlation ID.
`void`	`setCorrelationKey(Object key)` Sets the correlation key for the message.
`void`	`setCos(User_Cos cosValue)` Sets the Class of Service (CoS) value for this message.
`void`	`setDeliverToOne(boolean deliverToOne)` Configures this message to be delivered to one client only.
`void`	`setDeliveryMode(DeliveryMode mode)` Sets the delivery mode of the message.
`void`	`setDMQEligible(boolean dmqEligible)` Set the message to be eligible to be moved to a Dead Message Queue.
`void`	`setElidingEligible(boolean eliding)` Sets whether the message is eligible for eliding.
`void`	`setExpiration(long expiration)` The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
`void`	`setHTTPContentEncoding(String contentEncoding)` Sets the HTTP content type encoding value for interaction with an HTTP client.
`void`	`setHTTPContentType(String contentType)` Sets the HTTP content type header value for interaction with an HTTP client.
`void`	`setMessageType(MessageType msgType)`
`void`	`setPriority(int priority)` A message can optionally have priority set.
`void`	`setProperties(SDTMap props)` This method allows users to specify their own user properties to be carried in the message separate from the payload.
`void`	`setQueueNameLocation(int offset, int length)`
`void`	`setReadOnly()` The message can be set as read only.
`void`	`setReplyTo(Destination destination)` Sets the replyTo destination for the message.
`void`	`setReplyToSuffix(String suffix)` Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination.
`void`	`setSenderId(String senderId)` Sets the Sender ID for the message.
`void`	`setSenderID(String senderID)`
`void`	`setSenderTimestamp(long ts)` Allows the application to set the send timestamp overriding the API's generated value.
`void`	`setSendTimestamp(long ts)`
`void`	`setSequenceNumber(long seqNum)` Sets the sequence number.
`void`	`setStructuredMsg(boolean isStructured)` Sets the message as a structured message.
`void`	`setStructuredMsgType(byte value)` Sets the structured message type.
`void`	`setTimeToLive(long ttl)` The number of milliseconds before the message is discarded or moved to a Dead Message Queue.
`void`	`setTopicNameLocation(int offset, int length)`
`void`	`setUserData(byte[] userData)` When an application sends a message, it can optionally attach application-specific data along with the message as user data.
`int`	`writeAttachment(byte[] byteInputBuffer)` Writes a new attachment to the message.
`int`	`writeAttachment(byte[] byteInputBuffer, int offset, int length)` Writes a new attachment to the message.
`int`	`writeAttachment(InputStream stream)` Writes a new attachment to the message.
`int`	`writeBinaryMetadataBytes(int type, byte[] byteInputBuffer)`
`int`	`writeBinaryMetadataBytes(int type, byte[] byteInputBuffer, int offset, int length)`
`void`	`writeBytes(byte[] value)` Writes a byte array to the message content of the XML part, appending to existing content if present.
`void`	`writeBytes(byte[] value, int offset, int length)` Writes a partial byte array to the message content of the XML part, appending to existing content if present.
`int`	`writeMetadata(byte[] byteInputBuffer)`
`int`	`writeMetadata(byte[] byteInputBuffer, int offset, int length)`
`int`	`writeMetadata(InputStream stream)`
`int`	`writeNewAttachment(byte[] byteInputBuffer)` Writes a new attachment to the message.
`int`	`writeNewAttachment(byte[] byteInputBuffer, int offset, int length)` Writes a new attachment to the message.
`int`	`writeNewAttachment(InputStream stream)` Writes a new attachment to the message.
`int`	`writeNewAttachment(InputStream stream, int offset, int length)` Writes a new attachment to the message.

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

- Constructor Detail
  - CacheEventMessageImpl
```
public CacheEventMessageImpl(Long id,
                             Topic topic,
                             CacheRequestResult result)
```
  - CacheEventMessageImpl
```
public CacheEventMessageImpl(Long id,
                             Topic topic,
                             JCSMPException ex)
```
- Method Detail
  - getBytes
```
public byte[] getBytes()
```
    Description copied from interface: BytesXMLMessage
    
    Gets a byte array with the message content of the XML part.
    The message content is returned when the message is read-only. Otherwise, the method returns an empty byte array.
    Note that there is no guarantee that the array will have the same length as the content; it may in fact be larger. Applications should only read the number of bytes returned by XMLMessage.getContentLength().
    
    Specified by:
    
    getBytes in interface BytesXMLMessage
    
    Returns:
    
    A byte array with the message content of the XML part.
  - readBytes
```
public int readBytes(byte[] value)
```
    Description copied from interface: BytesXMLMessage
    
    Reads a byte array from the message content and copies the data read to the supplied byte array.
    If the length of array value is less than the number of bytes remaining to be read from the message content, the array is filled. The read mark for the message content is incremented by the number of bytes read. A subsequent call reads from the read mark, and so on.
    If the number of bytes remaining in the message content is less than the length of array value, the bytes are read into the array. The read mark for the message content is incremented by the number of bytes read. The return value of the total number of bytes read is less than the length of the array, which indicates that there are no more bytes left to be read from the message content. The next read would then return -1.
    
    Specified by:
    
    readBytes in interface BytesXMLMessage
    
    Parameters:
    
    value - The buffer into which the data is read.
    
    Returns:
    
    The total number of bytes read into the buffer, or -1 if there is no more data.
  - readBytes
```
public int readBytes(byte[] value,
                     int length)
```
    Description copied from interface: BytesXMLMessage
    
    Reads length bytes from the message content, and copies the data read to the supplied byte array.
    If length is less than the number of bytes remaining to be read from the message content, length bytes are read. The read mark for the message content is incremented by the number of bytes read. A subsequent call reads from the read mark, and so on.
    If the number of bytes remaining to be read in the message content is less than length, the remaining bytes are read into the array. The read mark for the message content is incremented by the number of bytes read. The return value of the total number of bytes read is less than length, which indicates that there are no more bytes left to be read from the message content. The next read of the message returns -1.
    If length is greater than the length of the array value, an IndexOutOfBoundsException is thrown. No bytes are read from the message content for this exception case.
    
    Specified by:
    
    readBytes in interface BytesXMLMessage
    
    Parameters:
    
    value - The buffer into which the data is read.
    
    length - The number of bytes to read; this must be less than or equal to value.length.
    
    Returns:
    
    The total number of bytes read into the buffer, or -1 if there is no more data.
  - rewindContent
```
public void rewindContent()
```
    Description copied from interface: BytesXMLMessage
    
    Resets the read mark for the message content to 0. The next call to BytesXMLMessage.readBytes(byte[]) or BytesXMLMessage.readBytes(byte[], int) reads from the beginning of the message content.
    
    Specified by:
    
    rewindContent in interface BytesXMLMessage
  - writeBytes
```
public void writeBytes(byte[] value)
```
    Description copied from interface: BytesXMLMessage
    
    Writes a byte array to the message content of the XML part, appending to existing content if present.
    An application that wants to replace content, for example when publishing the same message again with different content, can call XMLMessage.clearContent(), then write the new data.
    This method copies the input bytes into the message.
    
    Specified by:
    
    writeBytes in interface BytesXMLMessage
    
    Parameters:
    
    value - The byte array to be written (by appending to existing data).
  - writeBytes
```
public void writeBytes(byte[] value,
                       int offset,
                       int length)
```
    Description copied from interface: BytesXMLMessage
    
    Writes a partial byte array to the message content of the XML part, appending to existing content if present.
    An application that wants to replace content, for example when publishing the same message again with different content, can call XMLMessage.clearContent(), then write the new data.
    This method copies the input bytes into the message.
    
    Specified by:
    
    writeBytes in interface BytesXMLMessage
    
    Parameters:
    
    value - The byte array to be written.
    
    offset - The initial offset within the byte array.
    
    length - The number of bytes to use.
  - ackMessage
```
public void ackMessage()
```
    Description copied from interface: XMLMessage
    
    Acknowledges the message.
    If a JCSMPSession is configured to use SUPPORTED_MESSAGE_ACK_CLIENT, when a message is successfully received by an application, the application must call this method to explicitly acknowledge reception of the message in order to free system resources associated with an unacknowledged message.
    Note: If a JCSMPSession is configured to use JCSMPProperties.SUPPORTED_MESSAGE_ACK_AUTO (the default behaviour), the call to this method is ignored and a warning log is generated.
    
    Acknowledged messages are removed from the appliance's message spool.
    
    Specified by:
    
    ackMessage in interface XMLMessage
  - clearAttachment
```
public void clearAttachment()
```
    Description copied from interface: XMLMessage
    
    Deletes the attachment to the message. This method can only be called on a message that is not read-only. An incoming message from the appliance is read-only, as is an outgoing producer-dependent message after being sent.
    
    Specified by:
    
    clearAttachment in interface XMLMessage
  - clearBinaryMetadataBytes
```
public void clearBinaryMetadataBytes(int type)
```
    Description copied from interface: XMLMessage
    
    Clears any existing binary metadata. This method may only be called on a message that is not read-only. An incoming message from the appliance is read-only, as is an outgoing producer-dependent message after being sent.
    
    Specified by:
    
    clearBinaryMetadataBytes in interface XMLMessage
    
    Parameters:
    
    type - Type of binary metadata to clear.
  - clearContent
```
public void clearContent()
```
    Description copied from interface: XMLMessage
    
    Clears the message content. This method can only be called on a message that is not read-only. An incoming message from the appliance is read-only, as is an outgoing producer-dependent message after being sent.
    
    Specified by:
    
    clearContent in interface XMLMessage
  - clearMetadata
```
public void clearMetadata()
```
  - clearQueueNameLocation
```
public void clearQueueNameLocation()
```
    Specified by:
    
    clearQueueNameLocation in interface XMLMessage
  - clearTopicNameLocation
```
public void clearTopicNameLocation()
```
    Specified by:
    
    clearTopicNameLocation in interface XMLMessage
  - getAppMessageID
```
public String getAppMessageID()
```
    Specified by:
    
    getAppMessageID in interface XMLMessage
  - getApplicationMessageId
```
public String getApplicationMessageId()
```
    Description copied from interface: XMLMessage
    
    Gets the application message ID, a string for an application-specific message identifier.
    
    Specified by:
    
    getApplicationMessageId in interface XMLMessage
    
    Returns:
    
    the message ID. null if it was not set on send.
  - getAppMessageType
```
public String getAppMessageType()
```
    Specified by:
    
    getAppMessageType in interface XMLMessage
  - getApplicationMessageType
```
public String getApplicationMessageType()
```
    Description copied from interface: XMLMessage
    
    Gets the application message type. This value is used by applications only, and is passed through the API untouched.
    
    Specified by:
    
    getApplicationMessageType in interface XMLMessage
    
    Returns:
    
    The application message type.
  - getAttachmentContentLength
```
public int getAttachmentContentLength()
```
    Description copied from interface: XMLMessage
    
    Gets the length of the attachment.
    
    Specified by:
    
    getAttachmentContentLength in interface XMLMessage
    
    Returns:
    
    The number of bytes comprising the attachment content.
  - getAttachmentByteBuffer
```
public ByteBuffer getAttachmentByteBuffer()
```
    Description copied from interface: XMLMessage
    
    Gets a ByteBuffer containing the message's binary attachment. The buffer's position is set to the beginning of the attachment, its limit set to the length of the attachment, and its mark is undefined.
    
    Specified by:
    
    getAttachmentByteBuffer in interface XMLMessage
    
    Returns:
    
    A new ByteBuffer view wrapping a byte array owned by this message. If no attachment is present in this message, returns null.
  - getBinaryMetadataContentLength
```
public int getBinaryMetadataContentLength(int type)
```
    Specified by:
    
    getBinaryMetadataContentLength in interface XMLMessage
    
    Parameters:
    
    type - The type of binary metadata to check length for.
    
    Returns:
    
    The number of bytes of binary metadata present for the given type.
  - getBinaryMetadataTypes
```
public Collection<Integer> getBinaryMetadataTypes()
```
    Specified by:
    
    getBinaryMetadataTypes in interface XMLMessage
    
    Returns:
    
    A list of binary metadata types (Integers) set on the message.
  - getCacheRequestId
```
public Long getCacheRequestId()
```
    Description copied from interface: XMLMessage
    
    Return the request ID set in the cache request. Always null if isCacheMessage() is false.
    
    Specified by:
    
    getCacheRequestId in interface XMLMessage
    
    Returns:
    
    The request ID set in the cache request.
  - getCacheRequestResult
```
public CacheRequestResult getCacheRequestResult()
```
    Description copied from interface: CacheEventMessage
    
    Returns the result of the cache request. Null if an error occurred.
    
    Specified by:
    
    getCacheRequestResult in interface CacheEventMessage
    
    Returns:
    
    The result of the cache request. Null if an error occurred.
  - getCacheRequestTopic
```
public Topic getCacheRequestTopic()
```
    Description copied from interface: CacheEventMessage
    
    Returns the topic the cache data was for.
    
    Specified by:
    
    getCacheRequestTopic in interface CacheEventMessage
    
    Returns:
    
    The topic the cache data was for.
  - getCacheRequestException
```
public JCSMPException getCacheRequestException()
```
    Description copied from interface: CacheEventMessage
    
    Returns the exception that occurred when a cache request failed. Null if the cache request was successful.
    
    Specified by:
    
    getCacheRequestException in interface CacheEventMessage
    
    Returns:
    
    The exception that occurred when a cache request failed. Null if the cache request was successful.
  - getConsumerIdList
```
public List<Long> getConsumerIdList()
```
    Description copied from interface: XMLMessage
    
    Gets a read-only list of consumer IDs set on this message. A consumer ID is an integer in the range 0x00000000 - 0xFFFFFFFE, and each one indicates that the received message matched at least one subscription with that consumer ID on the appliance.
    Consumer IDs are only present once, even if multiple subscriptions with that consumer ID each have caused a match.
    The return value is null if no consumer IDs are set on the message.
    
    Specified by:
    
    getConsumerIdList in interface XMLMessage
    
    Returns:
    
    Read-only list of consumerIDs on this message.
  - getContentLength
```
public int getContentLength()
```
    Description copied from interface: XMLMessage
    
    The length of the message content. If content is not set, 0 is returned.
    
    Specified by:
    
    getContentLength in interface XMLMessage
    
    Returns:
    
    The length of the message content, 0 when content is not set.
  - getCorrelationId
```
public String getCorrelationId()
```
    Description copied from interface: XMLMessage
    
    Gets the correlation ID. The correlation ID is used for correlating a request to a reply.
    
    Specified by:
    
    getCorrelationId in interface XMLMessage
    
    Returns:
    
    The correlation ID associated with this message, or null, if unset.
  - getCorrelationKey
```
public Object getCorrelationKey()
```
    Description copied from interface: XMLMessage
    
    Gets the correlation key for the message. A correlation key is used for asynchronous message acknowledgement notification by JCSMPStreamingPublishCorrelatingEventHandler.
    
    Specified by:
    
    getCorrelationKey in interface XMLMessage
    
    Returns:
    
    The correlation key associated with this message, or null if unset.
  - getCos
```
public User_Cos getCos()
```
    Description copied from interface: XMLMessage
    
    Gets the Class of Service (CoS) value for this message.
    
    Specified by:
    
    getCos in interface XMLMessage
    
    Returns:
    
    The Class of Service (CoS) set on this message.
  - getDeliverToOne
```
public boolean getDeliverToOne()
```
    Description copied from interface: XMLMessage
    
    Gets whether this message is configured for delivering to one client only. Deliver to one is False by default.
    
    Specified by:
    
    getDeliverToOne in interface XMLMessage
    
    Returns:
    
    true if this message was configured to deliver to one client only.
  - getDeliveryMode
```
public DeliveryMode getDeliveryMode()
```
    Description copied from interface: XMLMessage
    
    Gets the delivery mode of the message.
    
    Specified by:
    
    getDeliveryMode in interface XMLMessage
    
    Returns:
    
    An enumerated type (DeliveryMode) representing one of the CSMP delivery modes.
  - getDestination
```
public Destination getDestination()
```
    Description copied from interface: XMLMessage
    
    Gets the destination this message was published to. The destination is returned as a Queue or Topic instance.
    
    Specified by:
    
    getDestination in interface XMLMessage
    
    Returns:
    
    The destination this message was published to, or null if unavailable.
  - getDestinationName
```
public String getDestinationName()
```
  - getDestinationTopicSuffix
```
public String getDestinationTopicSuffix()
```
    Description copied from interface: XMLMessage
    
    Returns the string, without a leading delimiter, that is found after the session's default ReplyTo base topic in an incoming message. This is intended to allow a receiving application to demultiplex incoming replies addressed to several ReplyTo topics. If the Destination in the message (as returned by getDestination()) does not begin with the session's default ReplyTo base topic, then null is returned.
    
    Specified by:
    
    getDestinationTopicSuffix in interface XMLMessage
    
    Returns:
    
    The suffix appended to the incoming message's topic destination.
  - getDiscardIndication
```
public boolean getDiscardIndication()
```
    Description copied from interface: XMLMessage
    
    Returns true if one or more messages have been discarded prior to the current message, else false. This indicates congestion discards only and is not affected by message eliding.
    
    Specified by:
    
    getDiscardIndication in interface XMLMessage
    
    Returns:
    
    True if prior messages have been discarded, else false.
    
    See Also:
    
    XMLMessage.isElidingEligible()
  - getMessageId
```
public String getMessageId()
```
    Description copied from interface: XMLMessage
    
    Returns the message ID set by JCSMP during send or reception. The message ID is the String representation of a 64-bit unsigned integer value identifying the message.
    On the receiving side, if messages received do not have message ID set by the appliance, JCSMP automatically assigns one and guarantees its uniqueness for a particular <subscriber; message type>.
    Guaranteed messages delivered from the appliance have a appliance-assigned message ID. Messages sent or received over the Direct delivery mode are assigned a message ID by the API, but its value is not meaningful.
    
    Specified by:
    
    getMessageId in interface XMLMessage
    
    Returns:
    
    The message ID.
  - getMessageIdLong
```
public long getMessageIdLong()
```
    Description copied from interface: XMLMessage
    
    Returns the message ID set by JCSMP during send or reception. For discussion of message ID assignment, see XMLMessage.getMessageId().
    
    Specified by:
    
    getMessageIdLong in interface XMLMessage
    
    Returns:
    
    The message ID.
  - getMessageType
```
public MessageType getMessageType()
```
    Specified by:
    
    getMessageType in interface XMLMessage
    
    Returns:
    
    An enumerated type MessageType representing one of the four message types.
  - getMetadataContentLength
```
public int getMetadataContentLength()
```
  - getPriority
```
public int getPriority()
```
    Description copied from interface: XMLMessage
    
    Returns priority value in the range of 0–255, or -1 if it is not set.
    
    Specified by:
    
    getPriority in interface XMLMessage
    
    Returns:
    
    The message priority.
  - getProperties
```
public SDTMap getProperties()
```
    Description copied from interface: XMLMessage
    
    Gets the user properties map. For a received message the user properties can be retrieved from this map. For a message to be sent, the user properties can be added to this map.
    
    Specified by:
    
    getProperties in interface XMLMessage
    
    Returns:
    
    The user properties map, or null if no user properties map has been set on this message.
  - getQueueNameLength
```
public int getQueueNameLength()
```
    Specified by:
    
    getQueueNameLength in interface XMLMessage
    
    Returns:
    
    the number of bytes in the queue name.
  - getQueueNameOffset
```
public int getQueueNameOffset()
```
    Specified by:
    
    getQueueNameOffset in interface XMLMessage
    
    Returns:
    
    the number of bytes from the the start of the metadata.
  - getReceiveTimestamp
```
public long getReceiveTimestamp()
```
    Description copied from interface: XMLMessage
    
    Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
    
    Specified by:
    
    getReceiveTimestamp in interface XMLMessage
    
    Returns:
    
    The receive timestamp, or 0, if unset.
  - getRedelivered
```
public boolean getRedelivered()
```
    Description copied from interface: XMLMessage
    
    Indicates if the message has been delivered by the appliance to the API before.
    
    Specified by:
    
    getRedelivered in interface XMLMessage
    
    Returns:
    
    A boolean indicating if the message has been delivered before.
  - getReplyTo
```
public Destination getReplyTo()
```
    Description copied from interface: XMLMessage
    
    Gets the replyTo destination
    
    Specified by:
    
    getReplyTo in interface XMLMessage
    
    Returns:
    
    The replyTo destination or NULL if not set.
  - getReplyToSuffix
```
public String getReplyToSuffix()
```
    Description copied from interface: XMLMessage
    
    Returns the appended suffix to the session's default ReplyTo base topic set as part of this message's ReplyTo topic destination.
    
    Specified by:
    
    getReplyToSuffix in interface XMLMessage
    
    Returns:
    
    The suffix, or null if unset or ReplyTo is not a Topic.
  - getSendTimestamp
```
public Long getSendTimestamp()
```
    Specified by:
    
    getSendTimestamp in interface XMLMessage
  - getSenderTimestamp
```
public Long getSenderTimestamp()
```
    Description copied from interface: XMLMessage
    
    Gets the send timestamp (in milliseconds, from midnight, January 1, 1970 UTC). This field can be set automatically during message publishing, but existing values are not overwritten if non-null, as when a message is sent multiple times.
    
    Specified by:
    
    getSenderTimestamp in interface XMLMessage
    
    Returns:
    
    The send timestamp. Null if it was not set on send.
  - getSenderID
```
public String getSenderID()
```
    Specified by:
    
    getSenderID in interface XMLMessage
  - getSenderId
```
public String getSenderId()
```
    Description copied from interface: XMLMessage
    
    Returns the Sender's ID. This field can be set automatically during message publishing, but existing values are not overwritten if non-null, as when a message is sent multiple times.
    
    Specified by:
    
    getSenderId in interface XMLMessage
    
    Returns:
    
    The Sender's ID; null, if it is not set.
  - getSequenceNumber
```
public Long getSequenceNumber()
```
    Description copied from interface: XMLMessage
    
    Gets the sequence number. This field can be set automatically during message publishing, but existing values are not overwritten if non-null, as when a message is sent multiple times.
    
    Specified by:
    
    getSequenceNumber in interface XMLMessage
    
    Returns:
    
    The sequence number. Null if it was not set on send.
  - getStructuredMsgType
```
public byte getStructuredMsgType()
```
    Description copied from interface: XMLMessage
    Gets the structured message type. Used in conjunction with isStructuredMsg()
    One of the structured messages:
    - STRUCTURED_MAP_MESSAGE
    - STRUCTURED_STREAM_MESSAGE
    - STRUCTURED_TEXT_MESSAGE
    or one of the unstructured messages:
    - UNSTRUCTURED_MESSAGE
    - UNSTRUCTURED_XML_MESSAGE
    - UNSTRUCTURED_JMS_BYTES_MESSAGE
    - UNSTRUCTURED_JMS_OBJECT_MESSAGE
    - UNSTRUCTURED_JMS_PROPERTIES_MESSAGE
    Specified by:
    
    getStructuredMsgType in interface XMLMessage
    
    Returns:
    
    The structured/unstructured message type.
  - getTQDiscardIndication
```
public boolean getTQDiscardIndication()
```
    Specified by:
    
    getTQDiscardIndication in interface XMLMessage
    
    Returns:
    
    True if prior messages have been discarded, else false.
  - getTimeToLive
```
public long getTimeToLive()
```
    Description copied from interface: XMLMessage
    
    The number of milliseconds before the message is discarded or moved to Dead Message Queue. A value of 0 means the message will never expire. The default value is 0.
    
    Specified by:
    
    getTimeToLive in interface XMLMessage
    
    Returns:
    
    The number of milliseconds before the message is discarded or moved to Dead Message Queue.
  - getTopicNameLength
```
public int getTopicNameLength()
```
    Specified by:
    
    getTopicNameLength in interface XMLMessage
    
    Returns:
    
    The number of bytes in the Topic name.
  - getTopicNameOffset
```
public int getTopicNameOffset()
```
    Specified by:
    
    getTopicNameOffset in interface XMLMessage
    
    Returns:
    
    the number of bytes from the start of the metadata.
  - getUserData
```
public byte[] getUserData()
```
    Description copied from interface: XMLMessage
    
    When an application sends a message, it can optionally attach application-specific data along with the message, such as user data. The user data is passed along with the message from the sender to the receiver. Use the hasUserData() method to check whether user data is present on a received message.
    NOTE: The maximum length of the user data is 36 bytes.
    
    Specified by:
    
    getUserData in interface XMLMessage
    
    Returns:
    
    Returns a reference to the user data array, or null if none is present.
  - hasContent
```
public boolean hasContent()
```
    Description copied from interface: XMLMessage
    
    Checks whether the message has content.
    
    Specified by:
    
    hasContent in interface XMLMessage
    
    Returns:
    
    True if the message has content, false otherwise.
  - hasAttachment
```
public boolean hasAttachment()
```
    Description copied from interface: XMLMessage
    
    Checks whether the message has an attachment.
    
    Specified by:
    
    hasAttachment in interface XMLMessage
    
    Returns:
    
    True if the message has an attachment, false otherwise.
  - hasBinaryMetadata
```
public boolean hasBinaryMetadata(int type)
```
    Specified by:
    
    hasBinaryMetadata in interface XMLMessage
    
    Parameters:
    
    type - The type of binary metadata to check for.
    
    Returns:
    
    Whether any binary metadata of the given type is present.
  - hasMetadata
```
public boolean hasMetadata()
```
  - hasUserData
```
public boolean hasUserData()
```
    Description copied from interface: XMLMessage
    
    Checks whether a received message includes user data.
    
    Specified by:
    
    hasUserData in interface XMLMessage
    
    Returns:
    
    true if user data is present, false otherwise.
  - isCacheMessage
```
public boolean isCacheMessage()
```
    Description copied from interface: XMLMessage
    
    Returns true if this message was part of a cache reply.
    
    Specified by:
    
    isCacheMessage in interface XMLMessage
    
    Returns:
    
    true if this message was part of a cache reply.
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: XMLMessage
    
    Tests if the message is read only.
    
    Specified by:
    
    isReadOnly in interface XMLMessage
    
    Returns:
    
    boolean true if set to read only, false otherwise
  - isReplyMessage
```
public boolean isReplyMessage()
```
    Description copied from interface: XMLMessage
    
    Returns whether the message's reply field is set, indicating that this message is a reply.
    
    Specified by:
    
    isReplyMessage in interface XMLMessage
    
    Returns:
    
    A boolean indicating the state of the reply field.
  - isStructuredMsg
```
public boolean isStructuredMsg()
```
    Description copied from interface: XMLMessage
    
    Returns whether the message is a structured message. Used in conjunction with getStructuredMsgType().
    
    Specified by:
    
    isStructuredMsg in interface XMLMessage
    
    Returns:
    
    True if the message is a structured message.
  - isSuspect
```
public boolean isSuspect()
```
    Description copied from interface: XMLMessage
    
    Return true if this message was part of a cache reply that had the suspect flag set.
    
    Specified by:
    
    isSuspect in interface XMLMessage
    
    Returns:
    
    true if this message was part of a cache reply that had the suspect flag set.
  - readAttachmentBytes
```
public int readAttachmentBytes(byte[] byteOutputBuffer)
```
    Description copied from interface: XMLMessage
    
    Reads bytes from an attachment, copying the data to the supplied byte array.
    If the length of the array is less than the number of bytes remaining to be read, the array is filled.
    If the number of bytes to be read in the attachment is less than the length of the array, all attachment bytes are read into the array. Use XMLMessage.getAttachmentContentLength() to find the size of the attachment in order to provide a correctly-sized array.
    
    Specified by:
    
    readAttachmentBytes in interface XMLMessage
    
    Parameters:
    
    byteOutputBuffer - A byte array to fill with bytes from the attachment.
    
    Returns:
    
    The number of bytes read.
  - readAttachmentBytes
```
public int readAttachmentBytes(byte[] byteOutputBuffer,
                               int length)
```
    Description copied from interface: XMLMessage
    
    Reads length bytes from an attachment, copying the data to the supplied byte array.
    If the number of bytes to be read in the attachment is less than length, all attachment bytes are read into the array.
    
    Specified by:
    
    readAttachmentBytes in interface XMLMessage
    
    Parameters:
    
    byteOutputBuffer - A byte array to fill with bytes from the attachment.
    
    length - The number of bytes to read.
    
    Returns:
    
    The number of bytes read.
  - readAttachmentBytes
```
public int readAttachmentBytes(int srcPos,
                               byte[] byteOutputBuffer,
                               int destPos,
                               int length)
```
    Description copied from interface: XMLMessage
    
    Reads length bytes from an attachment, copying the data to the supplied byte array.
    If the number of bytes to be read in the attachment is less than length, all attachment bytes are read into the array.
    Parameter ordering mimics the semantics of System#arraycopy.
    
    Specified by:
    
    readAttachmentBytes in interface XMLMessage
    
    Parameters:
    
    srcPos - The starting position in the source array.
    
    byteOutputBuffer - A destination byte array to fill.
    
    destPos - The starting position in the destination array.
    
    length - The number of bytes to read.
    
    Returns:
    
    The number of bytes read, or -1 if there is nothing to read.
  - readBinaryMetadataBytes
```
public int readBinaryMetadataBytes(int type,
                                   byte[] byteOutputBuffer)
```
    Specified by:
    
    readBinaryMetadataBytes in interface XMLMessage
    
    Parameters:
    
    type - The type of binary metadata to read.
    
    byteOutputBuffer - The byte array to copy the data to.
    
    Returns:
    
    The number of bytes read.
  - readContentBytes
```
public int readContentBytes(int srcPos,
                            byte[] byteOutputBuffer,
                            int destPos,
                            int length)
```
    Description copied from interface: XMLMessage
    
    Reads length bytes from the message content, copying the data to the supplied byte array.
    If the number of bytes to be read in the content is less than length, all content bytes are read into the array.
    
    Specified by:
    
    readContentBytes in interface XMLMessage
    
    Parameters:
    
    srcPos - The starting position in the source array.
    
    byteOutputBuffer - A destination byte array to fill.
    
    destPos - The starting position in the destination array.
    
    length - The number of bytes to read.
    
    Returns:
    
    The number of bytes read, or -1 if there is nothing to read.
  - readContentBytes
```
public int readContentBytes(byte[] byteOutputBuffer)
```
    Description copied from interface: XMLMessage
    
    Reads from the message content, copying the data to the supplied byte array. The output array should be properly sized for the length of the content to read.
    
    Specified by:
    
    readContentBytes in interface XMLMessage
    
    Parameters:
    
    byteOutputBuffer - A destination byte array to fill.
    
    Returns:
    
    The number of bytes read, or -1 if there is nothing to read.
  - readContentBytes
```
public int readContentBytes(byte[] byteOutputBuffer,
                            int length)
```
    Description copied from interface: XMLMessage
    
    Reads length bytes from the message content, copying the data to the supplied byte array.
    If the number of bytes to be read in the content is less than length, all content bytes are read into the array.
    
    Specified by:
    
    readContentBytes in interface XMLMessage
    
    Parameters:
    
    byteOutputBuffer - A destination byte array to fill.
    
    length - The number of bytes to read.
    
    Returns:
    
    The number of bytes read, or -1 if there is nothing to read.
  - readMetadataBytes
```
public int readMetadataBytes(byte[] byteOutputBuffer)
```
  - readMetadataBytes
```
public int readMetadataBytes(byte[] byteOutputBuffer,
                             int length)
```
  - readMetadataBytes
```
public int readMetadataBytes(int srcPos,
                             byte[] byteOutputBuffer,
                             int destPos,
                             int length)
```
  - rejectMessage
```
public void rejectMessage()
```
    Specified by:
    
    rejectMessage in interface XMLMessage
  - rewindAttachment
```
public void rewindAttachment()
```
    Description copied from interface: XMLMessage
    
    Resets the read mark for attachment to 0. The next call to XMLMessage.readAttachmentBytes(byte[]) or XMLMessage.readAttachmentBytes(byte[], int) reads from the beginning of the attachment.
    
    Specified by:
    
    rewindAttachment in interface XMLMessage
  - rewindMetadata
```
public void rewindMetadata()
```
  - setAppMessageID
```
public void setAppMessageID(String msgId)
```
    Specified by:
    
    setAppMessageID in interface XMLMessage
  - setApplicationMessageId
```
public void setApplicationMessageId(String msgId)
```
    Description copied from interface: XMLMessage
    
    Sets the message ID (a string for an application-specific message identifier).
    
    Specified by:
    
    setApplicationMessageId in interface XMLMessage
    
    Parameters:
    
    msgId - The message ID.
  - setAppMessageType
```
public void setAppMessageType(String appMsgType)
```
    Specified by:
    
    setAppMessageType in interface XMLMessage
  - setApplicationMessageType
```
public void setApplicationMessageType(String appMsgType)
```
    Description copied from interface: XMLMessage
    
    Sets the application message type. This value is used by applications only and is passed through the API untouched.
    
    Specified by:
    
    setApplicationMessageType in interface XMLMessage
    
    Parameters:
    
    appMsgType - The application message type.
  - setAsReplyMessage
```
public void setAsReplyMessage(boolean isReply)
```
    Description copied from interface: XMLMessage
    
    Sets the reply field of the message.
    
    Specified by:
    
    setAsReplyMessage in interface XMLMessage
    
    Parameters:
    
    isReply - Whether to set or clear the reply attribute.
  - setCorrelationId
```
public void setCorrelationId(String id)
```
    Description copied from interface: XMLMessage
    
    Sets the correlation ID. The correlation ID is used for correlating a request to a reply.
    
    Specified by:
    
    setCorrelationId in interface XMLMessage
    
    Parameters:
    
    id - The correlation ID to associate with this message.
  - setCorrelationKey
```
public void setCorrelationKey(Object key)
```
    Description copied from interface: XMLMessage
    
    Sets the correlation key for the message. A correlation key is used for asynchronous message acknowledgement notification by JCSMPStreamingPublishCorrelatingEventHandler. Only effective for PERSISTENT and NON-PERSISTENT messages (that is, Guaranteed Delivery).
    
    Specified by:
    
    setCorrelationKey in interface XMLMessage
    
    Parameters:
    
    key - The correlation key to associate with this message.
  - setCos
```
public void setCos(User_Cos cosValue)
```
    Description copied from interface: XMLMessage
    
    Sets the Class of Service (CoS) value for this message. The Class of Service has different semantics for direct and guaranteed messages. For direct messaging, it determines the WRR weight for the message. For guaranteed messaging, it indicates the discard eligibility of the message when its destination endpoint is congested.
    
    Specified by:
    
    setCos in interface XMLMessage
    
    Parameters:
    
    cosValue - Class of Service (CoS).
  - setDeliverToOne
```
public void setDeliverToOne(boolean deliverToOne)
```
    Description copied from interface: XMLMessage
    
    Configures this message to be delivered to one client only. Deliver to one is False by default.
    When a direct message has the DeliverToOne property set to true , it can be delivered only to one client. For a Guaranteed Delivery message, this behavior only applies to the "demoted" direct copy of this message.
    
    Specified by:
    
    setDeliverToOne in interface XMLMessage
    
    Parameters:
    
    deliverToOne - True to enable delivering to one client only.
  - setDeliveryMode
```
public void setDeliveryMode(DeliveryMode mode)
```
    Description copied from interface: XMLMessage
    
    Sets the delivery mode of the message.
    
    Specified by:
    
    setDeliveryMode in interface XMLMessage
    
    Parameters:
    
    mode - An enumerated type (DeliveryMode) representing one of the CSMP delivery modes.
  - setMessageType
```
public void setMessageType(MessageType msgType)
```
    Specified by:
    
    setMessageType in interface XMLMessage
    
    Parameters:
    
    msgType - An enumerated type (MessageType) representing one of the CSMP message types.
  - setPriority
```
public void setPriority(int priority)
```
    Description copied from interface: XMLMessage
    
    A message can optionally have priority set.
    The valid priority value range is 0-255 with 0 as the lowest priority and 255 as the highest. Value -1 indicates the priority is not set and a default priority value is used instead.
    
    Specified by:
    
    setPriority in interface XMLMessage
    
    Parameters:
    
    priority - parameter
  - setProperties
```
public void setProperties(SDTMap props)
```
    Description copied from interface: XMLMessage
    
    This method allows users to specify their own user properties to be carried in the message separate from the payload. This enable users to supplement the Solace-defined properties (correlation id, send timestamp, sequence number, etc.). To create an SDTMap see Producer
    
    Specified by:
    
    setProperties in interface XMLMessage
    
    Parameters:
    
    props - The user properties map.
  - setQueueNameLocation
```
public void setQueueNameLocation(int offset,
                                 int length)
```
    Specified by:
    
    setQueueNameLocation in interface XMLMessage
    
    Parameters:
    
    offset - Indicates the number of bytes from the start of the metadata where the first byte of the queue name is located.
    
    length - parameter
  - setReadOnly
```
public void setReadOnly()
```
    Description copied from interface: XMLMessage
    
    The message can be set as read only. Once this flag is set, any write operation causes an IllegalAccessError to be raised.
    
    Specified by:
    
    setReadOnly in interface XMLMessage
  - setReplyTo
```
public void setReplyTo(Destination destination)
```
    Description copied from interface: XMLMessage
    
    Sets the replyTo destination for the message.
    
    Specified by:
    
    setReplyTo in interface XMLMessage
    
    Parameters:
    
    destination - The replyTo destination.
  - setReplyToSuffix
```
public void setReplyToSuffix(String suffix)
```
    Description copied from interface: XMLMessage
    
    Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination. If the string does not start with a topic delimiter ('/'), then a delimiter is inserted as well.
    
    Specified by:
    
    setReplyToSuffix in interface XMLMessage
    
    Parameters:
    
    suffix - The suffix to append when setting a new ReplyTo destination on this message.
  - setSendTimestamp
```
public void setSendTimestamp(long ts)
```
    Specified by:
    
    setSendTimestamp in interface XMLMessage
  - setSenderTimestamp
```
public void setSenderTimestamp(long ts)
```
    Description copied from interface: XMLMessage
    
    Allows the application to set the send timestamp overriding the API's generated value. This field can be set automatically during message publishing, but existing values are not overwritten if non-null, as when a message is sent multiple times.
    
    Specified by:
    
    setSenderTimestamp in interface XMLMessage
    
    Parameters:
    
    ts - The value to set as the send timestamp.
  - setSenderID
```
public void setSenderID(String senderID)
```
    Specified by:
    
    setSenderID in interface XMLMessage
  - setSenderId
```
public void setSenderId(String senderId)
```
    Description copied from interface: XMLMessage
    
    Sets the Sender ID for the message. This field can be set automatically during message publishing, but existing values are not overwritten if non-null, as when a message is sent multiple times.
    
    Specified by:
    
    setSenderId in interface XMLMessage
    
    Parameters:
    
    senderId - The Sender ID for the message.
  - setSequenceNumber
```
public void setSequenceNumber(long seqNum)
```
    Description copied from interface: XMLMessage
    
    Sets the sequence number. If sequence number generation is enabled, this method's argument overrides the generated value. This field can be set automatically during message publishing, but existing values are not overwritten if set, as when a message is sent multiple times.
    
    Specified by:
    
    setSequenceNumber in interface XMLMessage
    
    Parameters:
    
    seqNum - The sequence number.
  - setStructuredMsg
```
public void setStructuredMsg(boolean isStructured)
```
    Description copied from interface: XMLMessage
    
    Sets the message as a structured message. Used in conjunction with setStructuredMsgType().
    
    Specified by:
    
    setStructuredMsg in interface XMLMessage
    
    Parameters:
    
    isStructured - True if it is a structured message.
  - setStructuredMsgType
```
public void setStructuredMsgType(byte value)
```
    Description copied from interface: XMLMessage
    Sets the structured message type. Used in conjunction with setStructuredMsg()
    One of the structured messages:
    - STRUCTURED_MAP_MESSAGE
    - STRUCTURED_STREAM_MESSAGE
    - STRUCTURED_TEXT_MESSAGE
    or one of the unstructured messages:
    - UNSTRUCTURED_MESSAGE
    - UNSTRUCTURED_XML_MESSAGE
    - UNSTRUCTURED_JMS_BYTES_MESSAGE
    - UNSTRUCTURED_JMS_OBJECT_MESSAGE
    - UNSTRUCTURED_JMS_PROPERTIES_MESSAGE
    Specified by:
    
    setStructuredMsgType in interface XMLMessage
    
    Parameters:
    
    value - structured/Unstructured message type.
  - setTimeToLive
```
public void setTimeToLive(long ttl)
```
    Description copied from interface: XMLMessage
    
    The number of milliseconds before the message is discarded or moved to a Dead Message Queue.
    A value of 0 means the message never expires. The default value is 0.
    Note: Calling this method with a value of 0 explicitly resets previously set message expiration to 0.
    This property is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used in conjunction with other message types unless the message is promoted by the appliance to a Guaranteed message.
    
    Specified by:
    
    setTimeToLive in interface XMLMessage
    
    Parameters:
    
    ttl - The number of milliseconds the Guaranteed message is allowed to live before delivery to a subscriber.
  - setTopicNameLocation
```
public void setTopicNameLocation(int offset,
                                 int length)
```
    Specified by:
    
    setTopicNameLocation in interface XMLMessage
    
    Parameters:
    
    offset - Indicates the number of bytes from the start of the metadata where the first byte of the Topic name is located.
    
    length - parameter
  - setUserData
```
public void setUserData(byte[] userData)
```
    Description copied from interface: XMLMessage
    
    When an application sends a message, it can optionally attach application-specific data along with the message as user data. This data is passed along with the message from the sender to the receiver and is not processed by the appliance network.
    NOTE: The maximum length of user data is 36 bytes.
    
    Specified by:
    
    setUserData in interface XMLMessage
    
    Parameters:
    
    userData - The user data - copied into the message object.
  - writeAttachment
```
public int writeAttachment(byte[] byteInputBuffer)
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. This operation causes a new Message ID to be generated when the message is sent. If called multiple times, the existing attachment is replaced.
    This method copies the input bytes into the message.
    
    Specified by:
    
    writeAttachment in interface XMLMessage
    
    Parameters:
    
    byteInputBuffer - A byte array to copy as attachment content.
    
    Returns:
    
    The number of bytes written.
  - writeAttachment
```
public int writeAttachment(byte[] byteInputBuffer,
                           int offset,
                           int length)
                    throws BufferUnderflowException
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. If called multiple times, the existing attachment is replaced. If offset or length are negative, an IllegalArgumentException is thrown. If length or offset result in an attempt to read past the end of the array, a BufferUnderflowException is thrown.
    This method copies the input bytes into the message.
    
    Specified by:
    
    writeAttachment in interface XMLMessage
    
    Parameters:
    
    byteInputBuffer - A byte array to copy as attachment content.
    
    offset - The offset from which to read bytes from the input buffer.
    
    length - The number of bytes to copy.
    
    Returns:
    
    The number of bytes written.
    
    Throws:
    
    BufferUnderflowException - on error
  - writeAttachment
```
public int writeAttachment(InputStream stream)
                    throws IOException
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. If called multiple times, it overwrites a previously-set attachment.
    This method copies the input bytes into the message.
    
    Specified by:
    
    writeAttachment in interface XMLMessage
    
    Parameters:
    
    stream - A stream from which to read attachment content.
    
    Returns:
    
    The number of bytes written.
    
    Throws:
    
    IOException
  - writeBinaryMetadataBytes
```
public int writeBinaryMetadataBytes(int type,
                                    byte[] byteInputBuffer)
```
    Specified by:
    
    writeBinaryMetadataBytes in interface XMLMessage
    
    Parameters:
    
    type - The type of binary metadata to write.
    
    byteInputBuffer - The byte array to copy the data to.
    
    Returns:
    
    The number of bytes written.
  - writeBinaryMetadataBytes
```
public int writeBinaryMetadataBytes(int type,
                                    byte[] byteInputBuffer,
                                    int offset,
                                    int length)
                             throws BufferUnderflowException
```
    Specified by:
    
    writeBinaryMetadataBytes in interface XMLMessage
    
    Parameters:
    
    type - The type of binary metadata to write.
    
    byteInputBuffer - Byte array to copy the data to.
    
    offset - The offset from which to read bytes from the input buffer.
    
    length - The number of bytes to copy.
    
    Returns:
    
    Number of bytes written.
    
    Throws:
    
    BufferUnderflowException - on error
  - writeMetadata
```
public int writeMetadata(byte[] byteInputBuffer)
```
  - writeMetadata
```
public int writeMetadata(byte[] byteInputBuffer,
                         int offset,
                         int length)
                  throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - writeMetadata
```
public int writeMetadata(InputStream stream)
                  throws IOException
```
    Throws:
    
    IOException
  - writeNewAttachment
```
public int writeNewAttachment(byte[] byteInputBuffer)
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. This operation causes a new Message ID to be generated when the message is sent. If called multiple times, the existing attachment is replaced.
    
    Specified by:
    
    writeNewAttachment in interface XMLMessage
    
    Parameters:
    
    byteInputBuffer - A byte array to copy as attachment content.
    
    Returns:
    
    The number of bytes written.
  - writeNewAttachment
```
public int writeNewAttachment(byte[] byteInputBuffer,
                              int offset,
                              int length)
                       throws BufferUnderflowException
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. If called multiple times, the existing attachment is replaced. If offset or length are negative, an IllegalArgumentException is thrown. If length or offset result in an attempt to read past the end of the array, a BufferUnderflowException is thrown.
    
    Specified by:
    
    writeNewAttachment in interface XMLMessage
    
    Parameters:
    
    byteInputBuffer - A byte array to copy as attachment content.
    
    offset - The offset from which to read bytes from the input buffer.
    
    length - The number of bytes to copy.
    
    Returns:
    
    The number of bytes written.
    
    Throws:
    
    BufferUnderflowException
  - writeNewAttachment
```
public int writeNewAttachment(InputStream stream,
                              int offset,
                              int length)
                       throws IOException
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. If called multiple times, the existing attachment is replaced. If offset or length are negative, an IllegalArgumentException is thrown.
    
    Specified by:
    
    writeNewAttachment in interface XMLMessage
    
    Parameters:
    
    stream - A stream from which to read attachment content.
    
    offset - The offset from which to read bytes from the input stream.
    
    length - The number of bytes to read from the stream.
    
    Returns:
    
    The number of bytes written.
    
    Throws:
    
    IOException
  - writeNewAttachment
```
public int writeNewAttachment(InputStream stream)
                       throws IOException
```
    Description copied from interface: XMLMessage
    
    Writes a new attachment to the message. If called multiple times, it overwrites a previously set attachment.
    
    Specified by:
    
    writeNewAttachment in interface XMLMessage
    
    Parameters:
    
    stream - A stream from which to read attachment content.
    
    Returns:
    
    The number of bytes written.
    
    Throws:
    
    IOException
  - reset
```
public void reset()
```
    Description copied from interface: XMLMessage
    
    Resets the message, clearing all fields, preparing it for publishing again. For use with session-independent messages acquired from JCSMPFactory.
    
    Specified by:
    
    reset in interface XMLMessage
  - dump
```
public String dump()
```
    Description copied from interface: XMLMessage
    
    Produces a human-readable dump of the message properties and its contents (can be quite large). Applications must not parse the output as its format is undefined. This method is the equivalent of calling dump(MSGDUMP_FULL).
    
    Specified by:
    
    dump in interface XMLMessage
    
    Returns:
    
    A String representation of the message, to be used for debugging.
  - dump
```
public String dump(int flags)
```
    Description copied from interface: XMLMessage
    Produces a human-readable dump of the message properties and its contents. Applications must not parse the output as its format is undefined.
    
    Flags
    Output can be controlled by the flags:
    - XMLMessage.MSGDUMP_BRIEF
    - XMLMessage.MSGDUMP_FULL
    Specified by:
    
    dump in interface XMLMessage
    
    Parameters:
    
    flags - Flags controlling the output, such as whether to include verbose (binary dump) information
    
    Returns:
    
    A String representation of the message, to be used for debugging.
  - isDMQEligible
```
public boolean isDMQEligible()
```
    Description copied from interface: XMLMessage
    
    The method returns whether the message is eligible to be moved to a Dead Message Queue (DMQ) upon expiration. If the value is false, the message is discarded upon expiration. The default value is false.
    This setting is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used for a Direct message unless the message is promoted by the appliance to a Guaranteed message.
    
    Specified by:
    
    isDMQEligible in interface XMLMessage
    
    Returns:
    
    A boolean indicating whether the message is eligible to be moved to a Dead Message Queue.
  - getExpiration
```
public long getExpiration()
```
    Description copied from interface: XMLMessage
    The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire. This field only serves as a reference as to when the message may expire.
    A value of 0 means the message never expires. The default value is 0.
    If TimeToLive is set to a value greater than 0 before sending, getExpiration() will have one of the following values:
    - On the publishing side, if JCSMPProperties.CALCULATE_MESSAGE_EXPIRATION is set to true, getExpiration() returns the sum of the message's TimeToLive and UTC value after the message is sent at the first send attempt. Otherwise, getExpiration() returns 0.
    - On the receiving side, if JCSMPProperties.CALCULATE_MESSAGE_EXPIRATION is set to true, getExpiration() returns the sum of TimeToLive and the UTC value when the message is received. Otherwise, getExpiration returns 0.
    This setting is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used for a Direct message unless the message is promoted by the appliance to a Guaranteed message.
    Specified by:
    
    getExpiration in interface XMLMessage
    
    Returns:
    
    The UTC time when the message is discarded or moved to a Dead Message Queue.
  - setDMQEligible
```
public void setDMQEligible(boolean dmqEligible)
```
    Description copied from interface: XMLMessage
    
    Set the message to be eligible to be moved to a Dead Message Queue. The default value is false.
    This setting is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used for a Direct message unless the message is promoted by the appliance to a Guaranteed message.
    
    Specified by:
    
    setDMQEligible in interface XMLMessage
    
    Parameters:
    
    dmqEligible - Whether the message is eligible to be moved to a DMQ upon expiration.
  - setExpiration
```
public void setExpiration(long expiration)
```
    Description copied from interface: XMLMessage
    
    The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire. Setting this property has no effect if the TimeToLive is set in the same message. It is carried to clients that receive the message, unmodified and does not effect the life cycle of the message. Use setTimeToLive() to enforce message expiry in the network.
    This field only serves as a reference as to when the message may expire. A value of 0 means the message never expires. The default value is 0.
    Note: If TimeToLive is set to zero explicitly by application, any previously set Expiration is reset to 0.
    This setting is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used for a Direct message unless the message is promoted by the appliance to a Guaranteed message.
    
    Specified by:
    
    setExpiration in interface XMLMessage
    
    Parameters:
    
    expiration - parameter
  - isElidingEligible
```
public boolean isElidingEligible()
```
    Description copied from interface: XMLMessage
    
    Checks whether the message is eligible for eliding.
    Message eliding enables filtering of data to avoid transmitting every single update to a subscribing client. It can be used to overcome slow consumers or any situation where a slower message rate is desired. Eliding can be applied to messages delivered to subscribers in DIRECT delivery mode.
    Time-based eliding ensures that subscriber applications always receive only the most current update of a published topic at a rate that they can manage. By limiting the incoming message rate, a subscriber application is able to avoid a message backlog filled with outdated messages. This property does not indicate whether messages were elided or provide information about the subscriber profile eliding configuration.
    
    Specified by:
    
    isElidingEligible in interface XMLMessage
    
    Returns:
    
    Whether this message is eligible for eliding.
  - setElidingEligible
```
public void setElidingEligible(boolean eliding)
```
    Description copied from interface: XMLMessage
    
    Sets whether the message is eligible for eliding.
    
    Specified by:
    
    setElidingEligible in interface XMLMessage
    
    Parameters:
    
    eliding - Whether the message is eligible for eliding.
    
    See Also:
    
    isElidingEligible() for more information about this feature.
  - getTopicSequenceNumber
```
public Long getTopicSequenceNumber()
```
    Description copied from interface: XMLMessage
    
    Gets the topic sequence number generated by the appliance.
    
    Specified by:
    
    getTopicSequenceNumber in interface XMLMessage
    
    Returns:
    
    The topic sequence number. Null if it was not generated by the appliance.
  - isAckImmediately
```
public boolean isAckImmediately()
```
    Description copied from interface: XMLMessage
    
    Test if the ACK Immediately message property is set or not. When it is set to true on an outgoing Guaranteed message, it indicates that the appliance should ACK this message immediately upon receipt. The default value is false.
    This setting is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used for a Direct message.
    This property, when set by a publisher, may or may not be removed by the appliance prior to delivery to a consumer, so message consumers must not rely on this property being present.
    
    Specified by:
    
    isAckImmediately in interface XMLMessage
    
    Returns:
    
    A boolean indicating whether the message should be ACKed by the appliance immediately upon receipt.
  - setAckImmediately
```
public void setAckImmediately(boolean ackImmediately)
```
    Description copied from interface: XMLMessage
    
    Set the ACK Immediately message property. When it is set to true on an outgoing Guaranteed message, it indicates that the appliance should ACK this message immediately upon receipt. The default value is false.
    This setting is only valid for Guaranteed messages (Persistent and Non-Persistent). It has no effect when used for a Direct message.
    This property, when set by a publisher, may or may not be removed by the appliance prior to delivery to a consumer, so message consumers must not rely on this property being present.
    
    Specified by:
    
    setAckImmediately in interface XMLMessage
    
    Parameters:
    
    ackImmediately - Whether the message should be ACKed by the appliance immediately upon receipt.
  - getAckMessageId
```
public long getAckMessageId()
```
    Specified by:
    
    getAckMessageId in interface XMLMessage
    
    Returns:
    
    The ack message id for the message.
  - getHTTPContentType
```
public String getHTTPContentType()
```
    Description copied from interface: XMLMessage
    
    Gets the HTTP content type header value from interaction with an HTTP client.
    
    Specified by:
    
    getHTTPContentType in interface XMLMessage
    
    Returns:
    
    The HTTP content type header value, or null if it is not set.
  - setHTTPContentType
```
public void setHTTPContentType(String contentType)
```
    Description copied from interface: XMLMessage
    
    Sets the HTTP content type header value for interaction with an HTTP client.
    
    Specified by:
    
    setHTTPContentType in interface XMLMessage
    
    Parameters:
    
    contentType - The HTTP content type header value.
  - getHTTPContentEncoding
```
public String getHTTPContentEncoding()
```
    Description copied from interface: XMLMessage
    
    Gets the HTTP content encoding header value from interaction with an HTTP client.
    
    Specified by:
    
    getHTTPContentEncoding in interface XMLMessage
    
    Returns:
    
    The HTTP content encoding header value, or null if it is not set.
  - setHTTPContentEncoding
```
public void setHTTPContentEncoding(String contentEncoding)
```
    Description copied from interface: XMLMessage
    
    Sets the HTTP content type encoding value for interaction with an HTTP client.
    
    Specified by:
    
    setHTTPContentEncoding in interface XMLMessage
    
    Parameters:
    
    contentEncoding - The HTTP content encoding header value.
  - isPrioritySet
```
public boolean isPrioritySet()
```
  - deletePriority
```
public void deletePriority()
```
  - getDeliveryCount
```
public int getDeliveryCount()
                     throws UnsupportedOperationException
```
    Description copied from interface: XMLMessage
    
    Get message delivery count.
    
    Specified by:
    
    getDeliveryCount in interface XMLMessage
    
    Returns:
    
    The number of times the message has been delivered.
    
    Throws:
    
    UnsupportedOperationException
  - isDeliveryCountSupported
```
public boolean isDeliveryCountSupported()
```
    Description copied from interface: XMLMessage
    
    Returns true if Delivery Count is supported.
    
    Specified by:
    
    isDeliveryCountSupported in interface XMLMessage
    
    Returns:
    
    true if the Delivery Count is supported, otherwise false.

Class CacheEventMessageImpl

Field Summary

Fields inherited from interface com.solacesystems.jcsmp.XMLMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheEventMessageImpl

CacheEventMessageImpl

Method Detail

getBytes

readBytes

readBytes

rewindContent

writeBytes

writeBytes

ackMessage

clearAttachment

clearBinaryMetadataBytes

clearContent

clearMetadata

clearQueueNameLocation

clearTopicNameLocation

getAppMessageID

getApplicationMessageId

getAppMessageType

getApplicationMessageType

getAttachmentContentLength

getAttachmentByteBuffer

getBinaryMetadataContentLength

getBinaryMetadataTypes

getCacheRequestId

getCacheRequestResult

getCacheRequestTopic

getCacheRequestException

getConsumerIdList

getContentLength

getCorrelationId

getCorrelationKey

getCos

getDeliverToOne

getDeliveryMode

getDestination

getDestinationName

getDestinationTopicSuffix

getDiscardIndication

getMessageId

getMessageIdLong

getMessageType

getMetadataContentLength

getPriority

getProperties

getQueueNameLength

getQueueNameOffset

getReceiveTimestamp

getRedelivered

getReplyTo

getReplyToSuffix

getSendTimestamp

getSenderTimestamp

getSenderID

getSenderId

getSequenceNumber

getStructuredMsgType

getTQDiscardIndication

getTimeToLive

getTopicNameLength

getTopicNameOffset

getUserData

hasContent

hasAttachment

hasBinaryMetadata

hasMetadata

hasUserData

isCacheMessage

isReadOnly

isReplyMessage

isStructuredMsg

isSuspect

readAttachmentBytes