Package 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:

java.io.Serializable

Direct Known Subclasses:

ApplicationInfoReply, HistoricReply, MonitoredObjectReply, TimerReply

public class EReplyMessage
extends EMessage
implements java.io.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	Description
static class	EReplyMessage.Builder<M extends EReplyMessage,B extends EReplyMessage.Builder<M,? extends EReplyMessage.Builder>>	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), OK_CONTINUING (in-progress reply with more to come), CANCELED (terminated before completion), CANCEL_REJECT (cancel request rejected), and ERROR (failure to process request and request is terminated).

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.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

MAX_SUBJECT_LENGTH, subject, timestamp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EReplyMessage(EReplyMessage.Builder<?,?> builder)	Creates a new eBus reply message based on the given reply message builder.

Method Summary

Modifier and Type	Method	Description
static EReplyMessage.Builder<?,?>	builder()	Returns the EReplyMessage builder.
boolean	equals(java.lang.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 based on super.hashCode, reply status, and reply reason.
boolean	isFinal()	Returns true if this is the final reply and false if another reply is to be expected.
java.lang.String	toString()	Returns super.toString(), reply status, and reply reason, as a string.

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

isApplicationMessage, isSystemMessage, key, messageType, timestampAsInstant

Methods inherited from class java.lang.Object

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

Field Detail

replyStatus

@FieldDisplayIndex(index=0)
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.

This field is displayed first.

replyReason

@FieldDisplayIndex(index=1)
@Nullable
public final java.lang.String replyReason

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

This field is displayed second.

Constructor Detail

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(java.lang.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 based on super.hashCode, reply status, and reply reason.

Overrides:

hashCode in class EMessage

Returns:

the reply message hash code.

toString

public java.lang.String toString()

Returns super.toString(), reply status, and reply reason, 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.