net.sf.eBus.messages

Class EReplyMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.EReplyMessage

All Implemented Interfaces:

Serializable

public class EReplyMessage
extends EMessage
implements Serializable

Required base class for all application request messages. Adds the message fields reply status, reply reason, and final reply flag.

This message is not abstract because it is a complete message in its own right and may be used to send a generic reply to any request.

Note: messages are limited to 31 fields. This is due to eBus binary serialization format. This number is decreased to 27 fields for sub-classes because EMessage has two fields: subject and timestamp and EReplyMessage has two fields: replyStatus and replyReason.

Author:

Charles Rapp

See Also:

ENotificationMessage, ERequestMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EReplyMessage.Builder<M extends EReplyMessage,B extends EReplyMessage.Builder<M,?>> Base class for all EReplyMessage builders.
static class	EReplyMessage.ConcreteBuilder Since EReplyMessage is not abstract and may be instantiated as a concrete message, this builder is used to create an EReplyMessage instance.
static class	EReplyMessage.ReplyStatus An eBus reply is limited to either OK (success) or ERROR (failure).

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
String	replyReason The reason for a EReplyMessage.ReplyStatus.ERROR reply status.
EReplyMessage.ReplyStatus	replyStatus The current request handling status.

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EReplyMessage(EReplyMessage.Builder<?,?> builder) Creates a new eBus reply message based on the given reply message builder.
	EReplyMessage(String subject, EReplyMessage.ReplyStatus replyStatus, String replyReason) Creates a new reply message instance for the given subject, status, reason, and final reply flag.
	EReplyMessage(String subject, long timestamp, EReplyMessage.ReplyStatus replyStatus, String replyReason) Creates a new reply message instance for the given subject, timestamp, status, reason, and final reply flag.

Method Summary

Modifier and Type	Method and Description
static EReplyMessage.Builder	builder() Returns the EReplyMessage builder.
boolean	equals(Object o) Returns true if o is a non-null EReplyMessage instance with a reply status and reply reason equal to this EReplyMessage instance and false otherwise.
int	hashCode() Returns the reply message hash code.
boolean	isFinal() Returns true if this is the final reply and false if another reply is to be expected.
String	toString() Returns the message subject, timestamp, and sequence number as a string.

Methods inherited from class net.sf.eBus.messages.EMessage

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

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

Field Detail

replyStatus

public final EReplyMessage.ReplyStatus replyStatus

The current request handling status. If EReplyMessage.ReplyStatus.ERROR, then replyReason will contain text explaining why the request was rejected.

replyReason

@Optional
public final String replyReason

The reason for a EReplyMessage.ReplyStatus.ERROR reply status. May be null or empty.

Constructor Detail

EReplyMessage

public EReplyMessage(String subject,
                     EReplyMessage.ReplyStatus replyStatus,
                     String replyReason)
              throws IllegalArgumentException

Creates a new reply message instance for the given subject, status, reason, and final reply flag. The timestamp is set to the current system time.

This constructor is public so that this class may be used as a generic reply to any request.

Parameters:

subject - the message subject.

replyStatus - the reply status.

replyReason - the reason explaining an error reply status. May be null or empty.

Throws:

IllegalArgumentException - if:

• subject is either of null or empty;
• replyStatus is null;

EReplyMessage

public EReplyMessage(String subject,
                     long timestamp,
                     EReplyMessage.ReplyStatus replyStatus,
                     String replyReason)
              throws IllegalArgumentException

Creates a new reply message instance for the given subject, timestamp, status, reason, and final reply flag.

This constructor is not deprecated since it is needed by local messages designated by @ELocalOnly annotation.

Parameters:

subject - the message subject.

timestamp - the message timestamp (Java millisecond epoch time).

replyStatus - the OK or error reply status.

replyReason - the reason explaining an error reply status. May be null or empty.

Throws:

IllegalArgumentException - if:

• subject is either of null or empty;
• replyStatus is null;

EReplyMessage

protected EReplyMessage(EReplyMessage.Builder<?,?> builder)

Creates a new eBus reply message based on the given reply message builder. builder is guaranteed to contain a valid message configuration at this point.

Parameters:

builder - contains the reply message configuration.

Method Detail

equals

public boolean equals(Object o)

Returns true if o is a non-null EReplyMessage instance with a reply status and reply reason equal to this EReplyMessage instance and false otherwise.

Overrides:

equals in class EMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Returns the reply message hash code.

Overrides:

hashCode in class EMessage

Returns:

the reply message hash code.

toString

public String toString()

Returns the message subject, timestamp, and sequence number as a string.

Overrides:

toString in class EMessage

Returns:

the message as text.

isFinal

public boolean isFinal()

Returns true if this is the final reply and false if another reply is to be expected.

Returns:

true if this is the final reply.

builder

public static EReplyMessage.Builder builder()

Returns the EReplyMessage builder.

Returns:

EReplyMessage.Builder instance.