com.liferay.lcs.messaging

Class CommandMessage

java.lang.Object

com.liferay.lcs.messaging.Message

com.liferay.lcs.messaging.CommandMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CheckHeartbeatCommandMessage, DownloadPatchCommandMessage, ExecuteScriptCommandMessage, MessageBusCommandMessage, ScheduleMessageListenersCommandMessage, ScheduleTasksCommandMessage, SendInstallationEnvironmentCommandMessage, SendPatchesCommandMessage, SendPortalPropertiesCommandMessage, SignOffCommandMessage, UpdateSignaturePublicKeyCommandMessage

public abstract class CommandMessage
extends Message

Represents a Liferay Cloud Services Protocol command message.

Since:

LCS 0.1

See Also:

Serialized Form

Field Summary

Fields inherited from class com.liferay.lcs.messaging.Message

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 Summary

Constructors

Constructor and Description
CommandMessage()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCorrelationId() Returns the message's correlation ID.
java.lang.String	getSignature()
void	setCorrelationId(java.lang.String correlationId) Sets the command message's correlation ID.
void	setSignature(java.lang.String signature)
java.lang.String	toString()

Methods inherited from class com.liferay.lcs.messaging.Message

createMessage, createMessage, getCreateTime, getDeliveryTag, getErrorCode, getErrorMessage, getKey, getProtocolVersion, getQueueName, getSignatureString, getTransportMetadata, setCreateTime, setDeliveryTag, setErrorCode, setErrorMessage, setKey, setProtocolVersion, setQueueName, setTransportMetadata, toJSON

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandMessage

public CommandMessage()

Method Detail

getCorrelationId

public java.lang.String getCorrelationId()

Returns the message's correlation ID.

Returns:

the message's correlation ID

Since:

LCS 0.1

getSignature

public java.lang.String getSignature()

setCorrelationId

public void setCorrelationId(java.lang.String correlationId)

Sets the command message's correlation ID. The correlation ID is used to match the receiver's response if the command message is sent asynchronously, and must be unique within the current LCS client session.

Parameters:

correlationId - the command message's correlation ID

Since:

LCS 0.1

setSignature

public void setSignature(java.lang.String signature)

toString

public java.lang.String toString()

Overrides:

toString in class Message