org.axonframework.commandhandling.distributed

Class ReplyMessage

java.lang.Object

org.axonframework.commandhandling.distributed.ReplyMessage

public abstract class ReplyMessage
extends Object

Base class for reply messages which may be used in the CommandBusConnector for replying on received commands from other nodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commandIdentifier
protected String	payloadRevision
protected String	payloadType
protected byte[]	serializedMetaData
protected byte[]	serializedPayload
protected boolean	success

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReplyMessage() Default constructor required for de-/serialization of extending classes.
	ReplyMessage(String commandIdentifier, boolean success, CommandResultMessage<?> commandResultMessage, Serializer serializer) Initializes a ReplyMessage containing a reply to the command with given {commandIdentifier} and given commandResultMessage.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCommandIdentifier() Returns the identifier of the command for which this message is a reply.
CommandResultMessage<?>	getCommandResultMessage(Serializer serializer) Returns the returnValue of the command processing.
Throwable	getError(Serializer serializer) Returns the error of the command processing.
String	getPayloadRevision() Returns the payload revision of the serialized reply message.
String	getPayloadType() Returns the payload type of the serialized reply message.
byte[]	getSerializedMetaData() Returns the serialized meta data of the serialized reply message.
byte[]	getSerializedPayload() Returns the serialized payload of the serialized reply message.
int	hashCode()
boolean	isSuccess() Whether the reply message represents a successfully executed command.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

commandIdentifier

protected String commandIdentifier

success

protected boolean success

serializedMetaData

protected byte[] serializedMetaData

payloadType

protected String payloadType

payloadRevision

protected String payloadRevision

serializedPayload

protected byte[] serializedPayload

Constructor Detail

ReplyMessage

protected ReplyMessage()

Default constructor required for de-/serialization of extending classes. Do not use directly.

ReplyMessage

public ReplyMessage(String commandIdentifier,
                    boolean success,
                    CommandResultMessage<?> commandResultMessage,
                    Serializer serializer)

Initializes a ReplyMessage containing a reply to the command with given {commandIdentifier} and given commandResultMessage. The parameter success determines whether the was executed successfully or not.

Parameters:

commandIdentifier - The identifier of the command to which the message is a reply

success - Whether or not the command executed successfully or not

commandResultMessage - The result message of command process

serializer - The serializer to serialize the message contents with

Method Detail

getCommandResultMessage

public CommandResultMessage<?> getCommandResultMessage(Serializer serializer)

Returns the returnValue of the command processing. If isSuccess() return false, this method returns null. This method also returns null if response processing returned a null value.

Parameters:

serializer - The serializer to deserialize the result with

Returns:

The return value of command processing

getError

public Throwable getError(Serializer serializer)

Returns the error of the command processing. If isSuccess() return true, this method returns null.

Parameters:

serializer - The serializer to deserialize the result with

Returns:

The exception thrown during command processing

getCommandIdentifier

public String getCommandIdentifier()

Returns the identifier of the command for which this message is a reply.

Returns:

the identifier of the command for which this message is a reply as a String

isSuccess

public boolean isSuccess()

Whether the reply message represents a successfully executed command. In this case, successful means that the command's execution did not result in an exception.

Returns:

true if this reply contains a return value, false if it contains an error.

getPayloadType

public String getPayloadType()

Returns the payload type of the serialized reply message.

Returns:

the payload type of the serialized reply message as a String

getPayloadRevision

public String getPayloadRevision()

Returns the payload revision of the serialized reply message.

Returns:

the payload revision of the serialized reply message as a String

getSerializedPayload

public byte[] getSerializedPayload()

Returns the serialized payload of the serialized reply message.

Returns:

the serialized payload of the serialized reply message as a byte[]

getSerializedMetaData

public byte[] getSerializedMetaData()

Returns the serialized meta data of the serialized reply message.

Returns:

the serialized meta data of the serialized reply message as a byte[]

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object