Message (Module com.liferay.lcs.messaging 12.1.1

java.lang.Object
- com.liferay.lcs.messaging.Message

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CommandMessage, HandshakeMessage, HealthMessage, HeartbeatMessage, LCSMessageMessage, LCSSubscriptionEntryMessage, MessageBusMessage, MetricsMessage, PortalModelMessage, ResponseMessage
```
public abstract class Message
extends java.lang.Object
implements java.io.Serializable
```
Represents a Liferay Cloud Services Protocol message.

Since:

LCS 0.1

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROTOCOL_VERSION_1_0`
`static java.lang.String`	`PROTOCOL_VERSION_1_1`
`static java.lang.String`	`PROTOCOL_VERSION_1_2`
`static java.lang.String`	`PROTOCOL_VERSION_1_3`
`static java.lang.String`	`PROTOCOL_VERSION_1_4`
`static java.lang.String`	`PROTOCOL_VERSION_1_5`
`static java.lang.String`	`PROTOCOL_VERSION_1_6`
`static java.lang.String`	`PROTOCOL_VERSION_1_7`
`static java.lang.String`	`PROTOCOL_VERSION_1_8`
`static java.lang.String`	`PROTOCOL_VERSION_CURRENT`

Constructor Summary

Constructors
Constructor and Description

Message()

Constructors
Constructor and Description
`Message()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T extends Message> T`	`createMessage(java.lang.String json)`
`static <T extends Message> T`	`createMessage(java.lang.String json, java.lang.Class clazz)`
`long`	`getCreateTime()` Returns the message's creation time in milliseconds.
`long`	`getDeliveryTag()` Returns the message's delivery tag.
`int`	`getErrorCode()` Returns the message's error code.
`java.lang.String`	`getErrorMessage()` Returns the message's error message.
`java.lang.String`	`getKey()` Returns the message creator's cluster node key.
`java.lang.String`	`getProtocolVersion()` Returns the message's protocol version.
`java.lang.String`	`getQueueName()` Returns the message's queue name.
`java.lang.String`	`getSignatureString()`
`<T extends TransportMetadata> T`	`getTransportMetadata()`
`void`	`setCreateTime(long createTime)` Sets the message's creation time in milliseconds.
`void`	`setDeliveryTag(long deliveryTag)` Sets the message's delivery tag.
`void`	`setErrorCode(int errorCode)` Sets the error code.
`void`	`setErrorMessage(java.lang.String errorMessage)` Sets the error message.
`void`	`setKey(java.lang.String key)` Sets the message creator's cluster node key.
`void`	`setProtocolVersion(java.lang.String protocolVersion)` Sets the message's protocol version.
`void`	`setQueueName(java.lang.String queueName)` Sets the message's queue name.
`void`	`setTransportMetadata(TransportMetadata transportMetadata)`
`java.lang.String`	`toJSON()`
`java.lang.String`	`toString()`

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

- Field Detail
  - PROTOCOL_VERSION_1_0
```
public static final java.lang.String PROTOCOL_VERSION_1_0
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_1
```
public static final java.lang.String PROTOCOL_VERSION_1_1
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_2
```
public static final java.lang.String PROTOCOL_VERSION_1_2
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_3
```
public static final java.lang.String PROTOCOL_VERSION_1_3
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_4
```
public static final java.lang.String PROTOCOL_VERSION_1_4
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_5
```
public static final java.lang.String PROTOCOL_VERSION_1_5
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_6
```
public static final java.lang.String PROTOCOL_VERSION_1_6
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_7
```
public static final java.lang.String PROTOCOL_VERSION_1_7
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_1_8
```
public static final java.lang.String PROTOCOL_VERSION_1_8
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION_CURRENT
```
public static final java.lang.String PROTOCOL_VERSION_CURRENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Message
```
public Message()
```
- Method Detail
  - createMessage
```
public static <T extends Message> T createMessage(java.lang.String json)
```
  - createMessage
```
public static <T extends Message> T createMessage(java.lang.String json,
                                                  java.lang.Class clazz)
```
  - getCreateTime
```
public long getCreateTime()
```
    Returns the message's creation time in milliseconds.
    
    Returns:
    
    the message's creation time in milliseconds
    
    Since:
    
    LCS 0.1
  - getDeliveryTag
```
public long getDeliveryTag()
```
    Returns the message's delivery tag.
    
    Returns:
    
    the message's delivery tag
    
    Since:
    
    LCS 0.1
    
    See Also:
    
    setDeliveryTag(long)
  - getErrorCode
```
public int getErrorCode()
```
    Returns the message's error code.
    
    Returns:
    
    Since:
    
    LCS Messaging 10.1.2
    
    See Also:
    
    setErrorCode(int)
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Returns the message's error message.
    
    Returns:
    
    Since:
    
    LCS Messaging 10.1.2
    
    See Also:
    
    setErrorMessage(String)
  - getKey
```
public java.lang.String getKey()
```
    Returns the message creator's cluster node key.
    
    Returns:
    
    the message creator's cluster node key
    
    Since:
    
    LCS 0.1
  - getProtocolVersion
```
public java.lang.String getProtocolVersion()
```
    Returns the message's protocol version.
    
    Returns:
    
    the message's protocol version
    
    Since:
    
    LCS 0.1
  - getQueueName
```
public java.lang.String getQueueName()
```
    Returns the message's queue name.
    
    Returns:
    
    the message's queue name
    
    Since:
    
    LCS 0.1
    
    See Also:
    
    setQueueName(String)
  - getSignatureString
```
public java.lang.String getSignatureString()
```
  - getTransportMetadata
```
public <T extends TransportMetadata> T getTransportMetadata()
```
  - setCreateTime
```
public void setCreateTime(long createTime)
```
    Sets the message's creation time in milliseconds.
    
    Parameters:
    
    createTime - the creation time in milliseconds
    
    Since:
    
    LCS 0.1
  - setDeliveryTag
```
public void setDeliveryTag(long deliveryTag)
```
    Sets the message's delivery tag. The delivery tag is used by some message queue implementations to set the sequence number for the confirmed message.
    
    Parameters:
    
    deliveryTag - the message's delivery tag
    
    Since:
    
    LCS 0.1
  - setErrorCode
```
public void setErrorCode(int errorCode)
```
    Sets the error code. The error code is used in response messages as complement to error message. LCS error codes uniquely identify the problem in LCS Platform and thus LCS Client may use error code to take specific recovery action.
    
    Parameters:
    
    errorCode -
    
    Since:
    
    LCS Messaging 10.1.2
  - setErrorMessage
```
public void setErrorMessage(java.lang.String errorMessage)
```
    Sets the error message. The error message is used in response messages to notify caller about problem at platform side. LCS Client may use error message to display error in the client log.
    
    Parameters:
    
    errorMessage - the error's description
    
    Since:
    
    LCS Messaging 10.1.2
  - setKey
```
public void setKey(java.lang.String key)
```
    Sets the message creator's cluster node key.
    
    Parameters:
    
    key - the message creator's cluster node key
    
    Since:
    
    LCS 0.1
  - setProtocolVersion
```
public void setProtocolVersion(java.lang.String protocolVersion)
```
    Sets the message's protocol version.
    
    Parameters:
    
    protocolVersion - the message's protocol version
    
    Since:
    
    LCS 0.1
  - setQueueName
```
public void setQueueName(java.lang.String queueName)
```
    Sets the message's queue name. The queue name is associated with the underlying message queue implementation where the message was read from.
    
    Parameters:
    
    queueName - the message's queue name
    
    Since:
    
    LCS 0.1
  - setTransportMetadata
```
public void setTransportMetadata(TransportMetadata transportMetadata)
```
  - toJSON
```
public java.lang.String toJSON()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Message

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL_VERSION_1_0

PROTOCOL_VERSION_1_1

PROTOCOL_VERSION_1_2

PROTOCOL_VERSION_1_3

PROTOCOL_VERSION_1_4

PROTOCOL_VERSION_1_5

PROTOCOL_VERSION_1_6

PROTOCOL_VERSION_1_7

PROTOCOL_VERSION_1_8

PROTOCOL_VERSION_CURRENT

Constructor Detail

Message

Method Detail

createMessage

createMessage

getCreateTime

getDeliveryTag

getErrorCode

getErrorMessage

getKey

getProtocolVersion

getQueueName

getSignatureString

getTransportMetadata

setCreateTime

setDeliveryTag

setErrorCode

setErrorMessage

setKey

setProtocolVersion

setQueueName

setTransportMetadata

toJSON

toString