net.sf.eBus.client

Class ConnectionMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

net.sf.eBus.client.AbstractEBusMessage

net.sf.eBus.client.ConnectionMessage

All Implemented Interfaces:

Serializable

public final class ConnectionMessage
extends AbstractEBusMessage
implements Serializable

This message reports when a remote connection has either logged on or logged off. If the remote connection logged off, then may provide the reason why remote eBus logged off (reason field may be null).

All connection messages have the subject "/eBus". Subscribe to ConnectionMessage.class/eBus to receive this notification.

Note: this notification is published locally only and is not sent to remote eBus applications.

Author:

Charles Rapp

See Also:

ServerMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionMessage.Builder Use this builder to create ConnectionMessage instances.
static class	ConnectionMessage.ConnectionState A remote eBus is either logged on or logged off.

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
static EMessageKey	MESSAGE_KEY The connection message key ConnectionMessage.class:/eBus.
String	reason If state is ConnectionMessage.ConnectionState.LOGGED_OFF and the log off was due to an exception, then the exception message is stored here.
ConnectionMessage.ConnectionState	state The remote eBus is either logged on or logged off.

Fields inherited from class net.sf.eBus.client.AbstractEBusMessage

EBUS_SUBJECT, remoteAddress, serverPort

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

Constructor and Description
ConnectionMessage(InetSocketAddress addr, int serverPort, ConnectionMessage.ConnectionState state) Deprecated. use ConnectionMessage.Builder to create connection message.
ConnectionMessage(InetSocketAddress addr, int serverPort, ConnectionMessage.ConnectionState state, String reason) Deprecated. use ConnectionMessage.Builder to create connection message.
ConnectionMessage(String subject, long timestamp, InetSocketAddress addr, int serverPort, ConnectionMessage.ConnectionState state, String reason) Deprecated. use ConnectionMessage.Builder to create connection message.

Method Summary

Modifier and Type	Method and Description
static ConnectionMessage.Builder	builder() Returns a connection message builder instance.
String	toString() Returns the connection 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

MESSAGE_KEY

public static final EMessageKey MESSAGE_KEY

The connection message key ConnectionMessage.class:/eBus. Use this key when ESubscribeFeed.open(ESubscriber, EMessageKey, EFeed.FeedScope, ECondition) for this message.

state

public final ConnectionMessage.ConnectionState state

The remote eBus is either logged on or logged off.

reason

public final String reason

If state is ConnectionMessage.ConnectionState.LOGGED_OFF and the log off was due to an exception, then the exception message is stored here. May be null.

Constructor Detail

ConnectionMessage

@Deprecated
public ConnectionMessage(InetSocketAddress addr,
                                     int serverPort,
                                     ConnectionMessage.ConnectionState state)

Deprecated. use ConnectionMessage.Builder to create connection message.

Creates a new connection message for the given remote eBus address and connection state. reason is set to null.

Parameters:

addr - remote eBus address.

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

state - connection state.

Throws:

NullPointerException - if either addr or state is null.

ConnectionMessage

@Deprecated
public ConnectionMessage(InetSocketAddress addr,
                                     int serverPort,
                                     ConnectionMessage.ConnectionState state,
                                     String reason)

Deprecated. use ConnectionMessage.Builder to create connection message.

Creates a new connection message for the given remote eBus address, connection state, and reason.

Parameters:

addr - remote eBus address.

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

state - connection state.

reason - reason for a logged off state. May be null or empty.

Throws:

NullPointerException - if either addr or state is null.

ConnectionMessage

@Deprecated
public ConnectionMessage(String subject,
                                     long timestamp,
                                     InetSocketAddress addr,
                                     int serverPort,
                                     ConnectionMessage.ConnectionState state,
                                     String reason)

Deprecated. use ConnectionMessage.Builder to create connection message.

Creates a remote eBus connection update with the given parameters.

Parameters:

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

timestamp - notification timestamp.

addr - remote eBus address.

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

state - connection state.

reason - the reason for a ConnectionMessage.ConnectionState.LOGGED_OFF connection state.

Throws:

NullPointerException - if either addr or state is null.

Method Detail

toString

public String toString()

Returns the connection message as text.

Overrides:

toString in class AbstractEBusMessage

Returns:

textual representation of the connection message.

builder

public static ConnectionMessage.Builder builder()

Returns a connection message builder instance.

Returns:

message builder instance.