net.sf.eBus.client

Class AbstractEBusMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

net.sf.eBus.client.AbstractEBusMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConnectionMessage, ServerMessage

public abstract class AbstractEBusMessage
extends ENotificationMessage
implements Serializable

Base class for eBus ConnectionMessage and ServerMessage classes. Defines the common notification subject used for all eBus client messages.

Contains the remote TCP address and service port used by subclasses.

Author:

Charles Rapp

See Also:

ConnectionMessage, ServerMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractEBusMessage.Builder<M extends AbstractEBusMessage,B extends AbstractEBusMessage.Builder<M,?>> Base class builder for AbstractEBusMessage 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	EBUS_SUBJECT "/eBus" is the subject used for all eBus ConnectionMessage and ServerMessage instances.
InetSocketAddress	remoteAddress The client address referenced in this message.
int	serverPort A TCP service port number.

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	AbstractEBusMessage(AbstractEBusMessage.Builder builder)
protected	AbstractEBusMessage(InetSocketAddress addr, int serverPort) Creates a new eBus message instance with the subject set to EBUS_SUBJECT and the timestamp set to the current time.
protected	AbstractEBusMessage(long timestamp, InetSocketAddress addr, int serverPort) Creates a new eBus message instance with the subject set to EBUS_SUBJECT and the timestamp set to the given time.
protected	AbstractEBusMessage(String subject, long timestamp, InetSocketAddress addr, int serverPort) Creates a new eBus client message instance for the given message subject and timestamp.

Method Summary

Modifier and Type	Method and Description
String	toString() Returns the message as text.

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

equals, hashCode, isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

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

Field Detail

EBUS_SUBJECT

public static final String EBUS_SUBJECT

"/eBus" is the subject used for all eBus ConnectionMessage and ServerMessage instances.

When subscribing for ConnectionMessage and ServerMessage, always use the subject "/eBus".

See Also:

Constant Field Values

remoteAddress

public final InetSocketAddress remoteAddress

The client address referenced in this message.

serverPort

public final int serverPort

A TCP service port number.

Constructor Detail

AbstractEBusMessage

protected AbstractEBusMessage(InetSocketAddress addr,
                              int serverPort)

Creates a new eBus message instance with the subject set to EBUS_SUBJECT and the timestamp set to the current time.

Parameters:

addr - the remote eBus address.

serverPort - connection is associated with this EServer port; zero if not an accepted connection.

Throws:

NullPointerException - if addr is null.

AbstractEBusMessage

protected AbstractEBusMessage(long timestamp,
                              InetSocketAddress addr,
                              int serverPort)

Creates a new eBus message instance with the subject set to EBUS_SUBJECT and the timestamp set to the given time.

Parameters:

timestamp - the notification timestamp.

addr - the remote eBus address.

serverPort - connection is associated with this EServer port; zero if not an accepted connection.

Throws:

NullPointerException - if addr is null.

AbstractEBusMessage

protected AbstractEBusMessage(String subject,
                              long timestamp,
                              InetSocketAddress addr,
                              int serverPort)

Creates a new eBus client message instance for the given message subject and timestamp.

Parameters:

subject - the notification subject. Will always be "/eBus".

timestamp - the notification timestamp.

addr - the remote eBus address.

serverPort - connection is associated with this EServer port; zero if not an accepted connection.

Throws:

NullPointerException - if addr is null.

AbstractEBusMessage

protected AbstractEBusMessage(AbstractEBusMessage.Builder builder)

Method Detail

toString

public String toString()

Returns the message as text.

Overrides:

toString in class EMessage

Returns:

textual representation of the message.