public class EReplyMessage extends EMessage implements java.io.Serializable
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
.
ENotificationMessage
,
ERequestMessage
,
Serialized FormModifier and Type | Class and 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). |
EMessage.MessageType
Modifier and Type | Field and Description |
---|---|
java.lang.String |
replyReason
The reason for a
EReplyMessage.ReplyStatus.ERROR reply status. |
EReplyMessage.ReplyStatus |
replyStatus
The current request handling status.
|
MAX_SUBJECT_LENGTH, subject, timestamp
Modifier | Constructor and Description |
---|---|
protected |
EReplyMessage(EReplyMessage.Builder<?,?> builder)
Creates a new eBus reply message based on the given reply
message builder.
|
Modifier and Type | Method and 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.
|
boolean |
isFinal()
Returns
true if this is the final reply and
false if another reply is to be expected. |
java.lang.String |
toString()
Returns the message subject, timestamp, and sequence
number as a string.
|
isApplicationMessage, isSystemMessage, key, messageType
@FieldDisplayIndex(index=0) public final EReplyMessage.ReplyStatus replyStatus
EReplyMessage.ReplyStatus.ERROR
, then replyReason
will
contain text explaining why the request was rejected.
This field is displayed first.
@FieldDisplayIndex(index=1) @Nullable public final java.lang.String replyReason
EReplyMessage.ReplyStatus.ERROR
reply status.
May be null
or empty.
This field is displayed second.
protected EReplyMessage(EReplyMessage.Builder<?,?> builder)
builder
is guaranteed to contain
a valid message configuration at this point.builder
- contains the reply message configuration.public boolean equals(java.lang.Object o)
true
if o
is a
non-null EReplyMessage
instance with a reply
status and reply reason equal to
this EReplyMessage
instance and false
otherwise.public int hashCode()
public java.lang.String toString()
public boolean isFinal()
true
if this is the final reply and
false
if another reply is to be expected.true
if this is the final reply.public static EReplyMessage.Builder<?,?> builder()
EReplyMessage
builder.EReplyMessage.Builder
instance.Copyright © 2001 - 2024. Charles W. Rapp. All rights reserved.