net.sf.eBus.messages

Class ESystemMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractKeyMessage, AbstractLogonMessage, CancelRequest, FeedStatusMessage, KeyMessage, RemoteAck

public abstract class ESystemMessage
extends EMessage
implements Serializable

Required base class for all system messages. Note that system messages may not be used by applications. If an eBus application extends this class, it will not be able to send or received such a message. System messages are meant for internal eBus use only.

Author:

Charles Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ESystemMessage.Builder<M extends ESystemMessage,B extends ESystemMessage.Builder<M,?>> Base class for all ESystemMessage builders.

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_SUBJECT All system messages use the same subject: "/eBus".

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	ESystemMessage() Deprecated. use ESystemMessage(ESystemMessage.Builder) in the future.
protected	ESystemMessage(ESystemMessage.Builder<?,?> builder) Creates a new system message based on the given message builder.
protected	ESystemMessage(String subject, long timestamp) Deprecated. use ESystemMessage(ESystemMessage.Builder) in the future.

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

Field Detail

SYSTEM_SUBJECT

public static final String SYSTEM_SUBJECT

All system messages use the same subject: "/eBus".

See Also:

Constant Field Values

Constructor Detail

ESystemMessage

@Deprecated
protected ESystemMessage()
                              throws IllegalArgumentException

Deprecated. use ESystemMessage(ESystemMessage.Builder) in the future.

Creates an eBus system message using the default values: /eBus subject, and the current time.

Throws:

IllegalArgumentException

See Also:

ESystemMessage(String, long)

ESystemMessage

@Deprecated
protected ESystemMessage(String subject,
                                     long timestamp)
                              throws IllegalArgumentException

Deprecated. use ESystemMessage(ESystemMessage.Builder) in the future.

Creates a new system message instance with the given subject and timestamp.

Parameters:

subject - the required message subject.

timestamp - the message timestamp in Java millisecond epoch time.

Throws:

IllegalArgumentException - if subject is either of null or empty.

ESystemMessage

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

Creates a new system 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.