net.sf.eBus.messages

Class ERequestMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ERequestMessage

All Implemented Interfaces:

Serializable

@EReplyInfo(replyMessageClasses=EReplyMessage.class)
public abstract class ERequestMessage
extends EMessage
implements Serializable

Required base class for all application request messages. This class has no fields of its own. This class allows EReplyMessage to be used to reply to any and all request message classes.

ERequestMessage subclasses must contain a class-level annotation EReplyInfo. This defines the reply message classes used to reply to the request message. This annotation is cumulative. The allowed reply messages include those listed in the current EReplyInfo annotation and those listed in the superclass EReplyInfo annotation. Since EReplyMessage is listed in the ERequestMessage EReplyInfo annotation, EReplyMessage is a valid reply to any request.

   
  @EReplyInfo (replyMessageClasses = {OrderReply.class})
 public final class OrderRequest
     extends ERequestMessage
   
 

Author:

Charles Rapp

See Also:

ENotificationMessage, EReplyMessage, EReplyInfo, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERequestMessage.Builder<M extends ERequestMessage,B extends ERequestMessage.Builder<M,?>>

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

EMessage.MessageType

Field Summary

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	ERequestMessage(ERequestMessage.Builder<?,?> builder) Creates a new eBus request message based on the given message builder.
protected	ERequestMessage(String subject) Creates an eBus request message with the given subject.
	ERequestMessage(String subject, long timestamp) Creates a new request message instance for the given subject and timestamp.

Method Summary

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

equals, hashCode, isApplicationMessage, isSystemMessage, key, messageType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ERequestMessage

protected ERequestMessage(String subject)
                   throws IllegalArgumentException

Creates an eBus request message with the given subject. The message timestamp is set to the current time.

Parameters:

subject - the request message subject.

Throws:

IllegalArgumentException - if subject is either null or empty.

ERequestMessage

public ERequestMessage(String subject,
                       long timestamp)
                throws IllegalArgumentException

Creates a new request message instance for the given subject and timestamp. This constructor is used for message de-serialization.

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).

Throws:

IllegalArgumentException - if subject is either of null or empty.

ERequestMessage

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

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

Parameters:

builder - contains the eBus message configuration.