Message (AdroitLogic Project-X 17.07.5 API)

java.lang.Object
- org.adroitlogic.x.core.Message

All Implemented Interfaces:

Closeable, AutoCloseable, XMessage
```
public class Message
extends Object
implements XMessage
```
The base implementation of the Project-X runtime message representation

Since:

17.01

Author:

Ruwan Linton

Constructor Summary

Constructors
Constructor and Description

Message(XMessageFormat payload)

Constructors
Constructor and Description
`Message(XMessageFormat payload)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<P> void`	`addMessageProperty(String key, P value)` Add a message property - i.e.
`void`	`addPayloadToRelease(XMessageFormat payload)` Associate `XMessageFormat` (i.e : payload ) with `XMessage` in order to GC with `XMessage` resulting any `XMessageFormat`s obtained from File Store to release with it.
`<H> void`	`addTransportHeader(String key, H value)` Add a transport header to this message
`XMessage`	`cloneFullMessage()` Creates a clone of the message including the clone of payload as well as clones of attachments if any
`XMessage`	`cloneMessageWithoutPayload()` Creates a clone of the message without the payload and attachments.
`void`	`close()`
`Optional<XAttachment>`	`getAttachment(String key)` Retrieves the XAttachment with the given key
`Map<String,XAttachment>`	`getAttachments()` Return current attachments as an unmodifiable map
`String`	`getContentType()` Get the content type of the message if set.
`String`	`getDestinationURI()` Get the current destination URI for this message.
`Map<String,List<String>>`	`getDuplicateStringTransportHeaders()` Get the map of current transport header duplicate values
`Map<String,List<Object>>`	`getDuplicateTransportHeaders()` Get the map of current transport header duplicate values
`<H> Map<String,List<H>>`	`getDuplicateTransportHeaders(Class<H> type)` Get the map of current transport header duplicate values
`Optional<String>`	`getFirstStringTransportHeader(String key)`
`Optional<String>`	`getFirstStringTransportHeaderIgnoreCase(String key)`
`<H> Optional<H>`	`getFirstTransportHeader(String key, Class<H> type)` Get the first transport header with the given key as as a typed object of type H
`<H> Optional<H>`	`getFirstTransportHeaderIgnoreCase(String key, Class<H> type)` This will perform a case insensitive lookup for the first occurrence of the given transport header and retrieve it as as a typed object of type H
`UUID`	`getMessageId()`
`Map<String,Object>`	`getMessageProperties()` Return current message properties as an unmodifiable map
`<P> Optional<P>`	`getMessageProperty(String key, Class<P> cls)` Get the message property associated with the specified key as a typed object of type P
`XMessageFormat`	`getPayload()` Get the current payload of the message
`String`	`getRequestContentType()` Return the content type of the original request.
`int`	`getResponseCode()` Gets the response code of the message
`Optional<String>`	`getStringMessageProperty(String key)` Get the String message property associated with the specified key
`Map<String,String>`	`getStringTransportHeaders()` Get the map of current transport header values ignoring duplicates
`List<String>`	`getStringTransportHeaders(String key)` Get a List of transport header values for the given key
`Map<String,Object>`	`getTransportHeaders()` Get the map of current transport header values ignoring duplicates
`<H> Map<String,H>`	`getTransportHeaders(Class<H> type)` Get the map of current transport header values ignoring duplicates
`List<Object>`	`getTransportHeaders(String key)` Get a List of transport header values for the given key
`<H> List<H>`	`getTransportHeaders(String key, Class<H> type)` Get a List of transport header values for the given key
`boolean`	`hasAttachment(String key)` Checks if there is an attachment by the given key
`boolean`	`hasAttachments()` Checks whether this xMessageContext contains attachments
`boolean`	`hasMessageProperty(String key)` Checks whether the given property is present in the message properties map
`boolean`	`hasTransportHeader(String key)` Checks whether the give header is present in the message headers
`void`	`removeAllTransportHeaders()` Remove all transport headers
`void`	`removeAttachment(String key)` Removes `XAttachment` with the given key
`void`	`removeMessageProperty(String key)` Remove the message property associated with the specified key
`void`	`removeTransportHeader(String key)` Remove all occurrences of the specified transport header
`void`	`removeTransportHeaders(String... headers)` Remove transport headers specified in the comma separated list
`<H> void`	`replaceTransportHeader(String key, H value)` Replace the first occurrence of the transport header with the given value
`void`	`retainOnlyTransportHeaders(String... headers)` Retain only transport headers specified in the comma separated list
`void`	`setAttachment(String key, XAttachment value)` Sets a new attachment by adding it to the map of attachments
`void`	`setContentType(String contentType)` Set the content type of the message
`void`	`setDestinationURI(String destinationURI)` Set the destination URI for this message
`void`	`setPayload(XMessageFormat currentPayload)`
`void`	`setRequestContentType(String requestContentType)`
`void`	`setResponseCode(int responseCode)` Sets the response code of the message
`String`	`toString()`

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

- Constructor Detail
  - Message
```
public Message(XMessageFormat payload)
```
- Method Detail
  - getMessageId
```
public UUID getMessageId()
```
    Specified by:
    
    getMessageId in interface XMessage
  - getPayload
```
public XMessageFormat getPayload()
```
    Description copied from interface: XMessage
    
    Get the current payload of the message
    
    Specified by:
    
    getPayload in interface XMessage
    
    Returns:
    
    the current payload
  - setPayload
```
public void setPayload(XMessageFormat currentPayload)
```
    Specified by:
    
    setPayload in interface XMessage
  - hasTransportHeader
```
public boolean hasTransportHeader(String key)
```
    Description copied from interface: XMessage
    
    Checks whether the give header is present in the message headers
    
    Specified by:
    
    hasTransportHeader in interface XMessage
    
    Parameters:
    
    key - the key to be checked for existence
    
    Returns:
    
    whether the message contains a header with the given key
  - getFirstTransportHeader
```
public <H> Optional<H> getFirstTransportHeader(String key,
                                               Class<H> type)
```
    Description copied from interface: XMessage
    
    Get the first transport header with the given key as as a typed object of type H
    
    Specified by:
    
    getFirstTransportHeader in interface XMessage
    
    Type Parameters:
    
    H - the type of the header
    
    Parameters:
    
    key - the header name
    
    type - the class of the header type
    
    Returns:
    
    the optional with the typed header value if any or an empty optional
  - getFirstStringTransportHeader
```
public Optional<String> getFirstStringTransportHeader(String key)
```
    Specified by:
    
    getFirstStringTransportHeader in interface XMessage
  - getFirstTransportHeaderIgnoreCase
```
public <H> Optional<H> getFirstTransportHeaderIgnoreCase(String key,
                                                         Class<H> type)
```
    Description copied from interface: XMessage
    
    This will perform a case insensitive lookup for the first occurrence of the given transport header and retrieve it as as a typed object of type H
    
    Specified by:
    
    getFirstTransportHeaderIgnoreCase in interface XMessage
    
    Type Parameters:
    
    H - the type of the header
    
    Parameters:
    
    key - the case insensitive header name
    
    type - the class of the header type
    
    Returns:
    
    the optional typed header value if any or an empty optional
  - getFirstStringTransportHeaderIgnoreCase
```
public Optional<String> getFirstStringTransportHeaderIgnoreCase(String key)
```
    Specified by:
    
    getFirstStringTransportHeaderIgnoreCase in interface XMessage
  - addTransportHeader
```
public <H> void addTransportHeader(String key,
                                   H value)
```
    Description copied from interface: XMessage
    
    Add a transport header to this message
    
    Specified by:
    
    addTransportHeader in interface XMessage
    
    Type Parameters:
    
    H - the type of the header value
    
    Parameters:
    
    key - name of the header to be added
    
    value - header value to be set
  - removeTransportHeader
```
public void removeTransportHeader(String key)
```
    Description copied from interface: XMessage
    
    Remove all occurrences of the specified transport header
    
    Specified by:
    
    removeTransportHeader in interface XMessage
    
    Parameters:
    
    key - header name to remove
  - removeAllTransportHeaders
```
public void removeAllTransportHeaders()
```
    Description copied from interface: XMessage
    
    Remove all transport headers
    
    Specified by:
    
    removeAllTransportHeaders in interface XMessage
  - removeTransportHeaders
```
public void removeTransportHeaders(String... headers)
```
    Description copied from interface: XMessage
    
    Remove transport headers specified in the comma separated list
    
    Specified by:
    
    removeTransportHeaders in interface XMessage
    
    Parameters:
    
    headers - a list of transport headers to remove
  - retainOnlyTransportHeaders
```
public void retainOnlyTransportHeaders(String... headers)
```
    Description copied from interface: XMessage
    
    Retain only transport headers specified in the comma separated list
    
    Specified by:
    
    retainOnlyTransportHeaders in interface XMessage
    
    Parameters:
    
    headers - a list of transport headers to retain
  - replaceTransportHeader
```
public <H> void replaceTransportHeader(String key,
                                       H value)
```
    Description copied from interface: XMessage
    
    Replace the first occurrence of the transport header with the given value
    
    Specified by:
    
    replaceTransportHeader in interface XMessage
    
    Type Parameters:
    
    H - the type of the new header value
    
    Parameters:
    
    key - the name of the header to be replaced
    
    value - the new value to be set
  - getTransportHeaders
```
public <H> List<H> getTransportHeaders(String key,
                                       Class<H> type)
```
    Description copied from interface: XMessage
    
    Get a List of transport header values for the given key
    
    Specified by:
    
    getTransportHeaders in interface XMessage
    
    Type Parameters:
    
    H - the type of the header value
    
    Parameters:
    
    key - the name of the transport header to be retrieved
    
    type - the class of the type of the expected header value list
    
    Returns:
    
    transport headers as a List for the given key
  - getTransportHeaders
```
public <H> Map<String,H> getTransportHeaders(Class<H> type)
```
    Description copied from interface: XMessage
    
    Get the map of current transport header values ignoring duplicates
    
    Specified by:
    
    getTransportHeaders in interface XMessage
    
    Type Parameters:
    
    H - the type of the header values to be returned
    
    Parameters:
    
    type - the class of the type of the header values
    
    Returns:
    
    transport headers as a Map, when ignoring duplicates
  - getDuplicateTransportHeaders
```
public <H> Map<String,List<H>> getDuplicateTransportHeaders(Class<H> type)
```
    Description copied from interface: XMessage
    
    Get the map of current transport header duplicate values
    
    Specified by:
    
    getDuplicateTransportHeaders in interface XMessage
    
    Type Parameters:
    
    H - the type of the header values to be returned
    
    Parameters:
    
    type - the class of the type of the headers to be retrieved
    
    Returns:
    
    transport header duplicates as a Map
  - getTransportHeaders
```
public List<Object> getTransportHeaders(String key)
```
    Description copied from interface: XMessage
    
    Get a List of transport header values for the given key
    
    Specified by:
    
    getTransportHeaders in interface XMessage
    
    Parameters:
    
    key - the name of the transport header to retrieve the header values
    
    Returns:
    
    transport headers as a List for the given key
  - getTransportHeaders
```
public Map<String,Object> getTransportHeaders()
```
    Description copied from interface: XMessage
    
    Get the map of current transport header values ignoring duplicates
    
    Specified by:
    
    getTransportHeaders in interface XMessage
    
    Returns:
    
    transport headers as a Map, when ignoring duplicates
  - getDuplicateTransportHeaders
```
public Map<String,List<Object>> getDuplicateTransportHeaders()
```
    Description copied from interface: XMessage
    
    Get the map of current transport header duplicate values
    
    Specified by:
    
    getDuplicateTransportHeaders in interface XMessage
    
    Returns:
    
    transport header duplicates as a Map
  - getStringTransportHeaders
```
public List<String> getStringTransportHeaders(String key)
```
    Description copied from interface: XMessage
    
    Get a List of transport header values for the given key
    
    Specified by:
    
    getStringTransportHeaders in interface XMessage
    
    Parameters:
    
    key - the name of the transport header to retrieve the String header values
    
    Returns:
    
    transport headers as a List for the given key
  - getStringTransportHeaders
```
public Map<String,String> getStringTransportHeaders()
```
    Description copied from interface: XMessage
    
    Get the map of current transport header values ignoring duplicates
    
    Specified by:
    
    getStringTransportHeaders in interface XMessage
    
    Returns:
    
    transport headers as a Map, when ignoring duplicates
  - getDuplicateStringTransportHeaders
```
public Map<String,List<String>> getDuplicateStringTransportHeaders()
```
    Description copied from interface: XMessage
    
    Get the map of current transport header duplicate values
    
    Specified by:
    
    getDuplicateStringTransportHeaders in interface XMessage
    
    Returns:
    
    transport header duplicates as a Map
  - addMessageProperty
```
public <P> void addMessageProperty(String key,
                                   P value)
```
    Description copied from interface: XMessage
    
    Add a message property - i.e. any Object can be a property
    
    Specified by:
    
    addMessageProperty in interface XMessage
    
    Type Parameters:
    
    P - the type of the value of the property to be added
    
    Parameters:
    
    key - property key
    
    value - property value
  - getMessageProperty
```
public <P> Optional<P> getMessageProperty(String key,
                                          Class<P> cls)
```
    Description copied from interface: XMessage
    
    Get the message property associated with the specified key as a typed object of type P
    
    Specified by:
    
    getMessageProperty in interface XMessage
    
    Type Parameters:
    
    P - the type of the property
    
    Parameters:
    
    key - the property key
    
    cls - the class of the property type
    
    Returns:
    
    the typed property value
  - getStringMessageProperty
```
public Optional<String> getStringMessageProperty(String key)
```
    Description copied from interface: XMessage
    
    Get the String message property associated with the specified key
    
    Specified by:
    
    getStringMessageProperty in interface XMessage
    
    Parameters:
    
    key - property key
    
    Returns:
    
    property value
  - removeMessageProperty
```
public void removeMessageProperty(String key)
```
    Description copied from interface: XMessage
    
    Remove the message property associated with the specified key
    
    Specified by:
    
    removeMessageProperty in interface XMessage
    
    Parameters:
    
    key - property key
  - hasMessageProperty
```
public boolean hasMessageProperty(String key)
```
    Description copied from interface: XMessage
    
    Checks whether the given property is present in the message properties map
    
    Specified by:
    
    hasMessageProperty in interface XMessage
    
    Parameters:
    
    key - the key to be checked for existence
    
    Returns:
    
    whether the message properties contains a property with the given key
  - getMessageProperties
```
public Map<String,Object> getMessageProperties()
```
    Description copied from interface: XMessage
    
    Return current message properties as an unmodifiable map
    
    Specified by:
    
    getMessageProperties in interface XMessage
    
    Returns:
    
    the current message properties
  - getDestinationURI
```
public String getDestinationURI()
```
    Description copied from interface: XMessage
    
    Get the current destination URI for this message. This is the default target address if this message is sent via a default address endpoint
    
    Specified by:
    
    getDestinationURI in interface XMessage
    
    Returns:
    
    the destination URI
  - setDestinationURI
```
public void setDestinationURI(String destinationURI)
```
    Description copied from interface: XMessage
    
    Set the destination URI for this message
    
    Specified by:
    
    setDestinationURI in interface XMessage
    
    Parameters:
    
    destinationURI - the new destination URI
  - getContentType
```
public String getContentType()
```
    Description copied from interface: XMessage
    
    Get the content type of the message if set. Note: sometimes the content type maybe available as a transport header
    
    Specified by:
    
    getContentType in interface XMessage
    
    Returns:
    
    the content type of the message
  - getRequestContentType
```
public String getRequestContentType()
```
    Description copied from interface: XMessage
    
    Return the content type of the original request. On a response message, this method returns the content type of the original request
    
    Specified by:
    
    getRequestContentType in interface XMessage
    
    Returns:
    
    the original request content type if known, or null
  - setRequestContentType
```
public void setRequestContentType(String requestContentType)
```
  - setContentType
```
public void setContentType(String contentType)
```
    Description copied from interface: XMessage
    
    Set the content type of the message
    
    Specified by:
    
    setContentType in interface XMessage
    
    Parameters:
    
    contentType - the content type string to be set
  - getResponseCode
```
public int getResponseCode()
```
    Description copied from interface: XMessage
    
    Gets the response code of the message
    
    Specified by:
    
    getResponseCode in interface XMessage
    
    Returns:
    
    response code
  - setResponseCode
```
public void setResponseCode(int responseCode)
```
    Description copied from interface: XMessage
    
    Sets the response code of the message
    
    Specified by:
    
    setResponseCode in interface XMessage
    
    Parameters:
    
    responseCode - the integer response code to be set
  - cloneFullMessage
```
public XMessage cloneFullMessage()
```
    Description copied from interface: XMessage
    
    Creates a clone of the message including the clone of payload as well as clones of attachments if any
    
    Specified by:
    
    cloneFullMessage in interface XMessage
    
    Returns:
    
    instance of XMessage
  - cloneMessageWithoutPayload
```
public XMessage cloneMessageWithoutPayload()
```
    Description copied from interface: XMessage
    
    Creates a clone of the message without the payload and attachments. The payload of the cloned message will be empty.
    
    Specified by:
    
    cloneMessageWithoutPayload in interface XMessage
    
    Returns:
    
    instance of XMessage
  - getAttachments
```
public Map<String,XAttachment> getAttachments()
```
    Description copied from interface: XMessage
    
    Return current attachments as an unmodifiable map
    
    Specified by:
    
    getAttachments in interface XMessage
    
    Returns:
    
    current message attachments
  - setAttachment
```
public void setAttachment(String key,
                          XAttachment value)
```
    Description copied from interface: XMessage
    
    Sets a new attachment by adding it to the map of attachments
    
    Specified by:
    
    setAttachment in interface XMessage
    
    Parameters:
    
    key - String key for an attachment
    
    value - XAttachment an attachment
  - removeAttachment
```
public void removeAttachment(String key)
```
    Description copied from interface: XMessage
    
    Removes XAttachment with the given key
    
    Specified by:
    
    removeAttachment in interface XMessage
    
    Parameters:
    
    key - String key of the attachment to be removed
  - getAttachment
```
public Optional<XAttachment> getAttachment(String key)
```
    Description copied from interface: XMessage
    
    Retrieves the XAttachment with the given key
    
    Specified by:
    
    getAttachment in interface XMessage
    
    Parameters:
    
    key - String key
    
    Returns:
    
    Optional containing the XAttachment if exists and Optional.EMPTY otherwise
  - hasAttachments
```
public boolean hasAttachments()
```
    Description copied from interface: XMessage
    
    Checks whether this xMessageContext contains attachments
    
    Specified by:
    
    hasAttachments in interface XMessage
    
    Returns:
    
    true if message contains attachments and false otherwise
  - hasAttachment
```
public boolean hasAttachment(String key)
```
    Description copied from interface: XMessage
    
    Checks if there is an attachment by the given key
    
    Specified by:
    
    hasAttachment in interface XMessage
    
    Parameters:
    
    key - String key
    
    Returns:
    
    true if message contains an attachment under given key and false otherwise
  - addPayloadToRelease
```
public void addPayloadToRelease(XMessageFormat payload)
```
    Description copied from interface: XMessage
    
    Associate XMessageFormat (i.e : payload ) with XMessage in order to GC with XMessage resulting any XMessageFormats obtained from File Store to release with it.
    
    Specified by:
    
    addPayloadToRelease in interface XMessage
    
    Parameters:
    
    payload - XMessageFormat instance to be released
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

getMessageId

getPayload

setPayload

hasTransportHeader

getFirstTransportHeader

getFirstStringTransportHeader

getFirstTransportHeaderIgnoreCase

getFirstStringTransportHeaderIgnoreCase

addTransportHeader

removeTransportHeader

removeAllTransportHeaders

removeTransportHeaders

retainOnlyTransportHeaders

replaceTransportHeader

getTransportHeaders

getTransportHeaders

getDuplicateTransportHeaders

getTransportHeaders

getTransportHeaders

getDuplicateTransportHeaders

getStringTransportHeaders

getStringTransportHeaders

getDuplicateStringTransportHeaders

addMessageProperty

getMessageProperty

getStringMessageProperty

removeMessageProperty

hasMessageProperty

getMessageProperties

getDestinationURI

setDestinationURI

getContentType

getRequestContentType

setRequestContentType

setContentType

getResponseCode

setResponseCode

cloneFullMessage

cloneMessageWithoutPayload

getAttachments

setAttachment

removeAttachment

getAttachment

hasAttachments

hasAttachment

addPayloadToRelease

close

toString