Serialized Form (eBus Core 5.2.1 API)

Package net.sf.eBus.client
- Class net.sf.eBus.client.AbstractEBusMessage extends ENotificationMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - remoteAddress
```
InetSocketAddress remoteAddress
```
      The client address referenced in this message.
    - serverPort
```
int serverPort
```
      A TCP service port number.
- Class net.sf.eBus.client.ConnectionMessage extends AbstractEBusMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - state
```
ConnectionMessage.ConnectionState state
```
      The remote eBus is either logged on or logged off.
    - reason
```
String reason
```
      If ConnectionMessage.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.
- Class net.sf.eBus.client.ERemoteAppContext extends statemap.FSMContext7 implements Serializable
  
  serialVersionUID:
  
  1L
- Class net.sf.eBus.client.ServerMessage extends AbstractEBusMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.client.TestPublisherContext extends statemap.FSMContext7 implements Serializable
  
  serialVersionUID:
  
  1L
- Class net.sf.eBus.client.TestReplierContext extends statemap.FSMContext7 implements Serializable
  
  serialVersionUID:
  
  1L
- Class net.sf.eBus.client.TestRequestorContext extends statemap.FSMContext7 implements Serializable
  
  serialVersionUID:
  
  1L
- Class net.sf.eBus.client.TestSubscriberContext extends statemap.FSMContext7 implements Serializable
  
  serialVersionUID:
  
  1L
Package net.sf.eBus.client.sysmessages
- Class net.sf.eBus.client.sysmessages.AbstractKeyMessage extends ESystemMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - messageClass
```
String messageClass
```
      The message key class name. The class name is transmitted rather than the Class instance because the far-end deserialization will fail if the Class is unknown.
    - messageSubject
```
String messageSubject
```
      The message key subject.
- Class net.sf.eBus.client.sysmessages.AbstractLogonMessage extends ESystemMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - eid
```
String eid
```
      The eBus identifier.
- Class net.sf.eBus.client.sysmessages.AdMessage extends AbstractKeyMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - adStatus
```
AdMessage.AdStatus adStatus
```
      Add or retract this advertisement.
    - adMessageType
```
EMessage.MessageType adMessageType
```
      The advertised message is for either a notification or a request.
    - feedState
```
EFeedState feedState
```
      The advertised feed's current state.
- Class net.sf.eBus.client.sysmessages.CancelRequest extends ESystemMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.client.sysmessages.FeedStatusMessage extends ESystemMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - feedState
```
EFeedState feedState
```
      The updated feed state.
- Class net.sf.eBus.client.sysmessages.KeyMessage extends ESystemMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - keyId
```
int keyId
```
      The sender's message key identifier. The receiver may assign its own unique identifier for the key.
    - keyClass
```
String keyClass
```
      The message key class name.
    - keySubject
```
String keySubject
```
      The message key subject.
- Class net.sf.eBus.client.sysmessages.LogoffMessage extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.client.sysmessages.LogonCompleteMessage extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.client.sysmessages.LogonMessage extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.client.sysmessages.LogonReply extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - logonStatus
```
EReplyMessage.ReplyStatus logonStatus
```
      Either the logon attempt succeeded or failed.
    - reason
```
String reason
```
      Explanation for a rejected logon request. May be null or empty.
- Class net.sf.eBus.client.sysmessages.PauseReply extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - replyStatus
```
EReplyMessage.ReplyStatus replyStatus
```
      The current request handling status. If EReplyMessage.ReplyStatus.ERROR, then PauseReply.replyReason will contain text explaining why the request was rejected.
    - replyReason
```
String replyReason
```
      The reason for a EReplyMessage.ReplyStatus.ERROR reply status. May be null or empty.
    - pauseTime
```
Duration pauseTime
```
      Requesting a connection pause lasting for this duration. The far-end may not accept this time and require a shorter pause time
    - maximumBacklogSize
```
int maximumBacklogSize
```
      Requesting the far-end store up to this many undelivered messages before beginning to discard messages. Which messages are to be discarded is based on the PauseRequest.discardPolicy. Please note that this size is a suggestion. The far-end response may specify smaller backlog size.
- Class net.sf.eBus.client.sysmessages.PauseRequest extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - pauseTime
```
Duration pauseTime
```
      Requesting a connection pause lasting for this duration. The far-end may not accept this time and require a shorter pause time
    - maximumBacklogSize
```
int maximumBacklogSize
```
      Requesting the far-end store up to this many un-delivered messages before beginning to discard messages. Which messages are to be discarded is based on the PauseRequest.discardPolicy. Please note that is size is a suggestion. The far-end response may specify smaller backlog size.
    - discardPolicy
```
EConfigure.DiscardPolicy discardPolicy
```
      Specifies how the far-end should discard messages if and when PauseRequest.maximumBacklogSize is reached.
- Class net.sf.eBus.client.sysmessages.RemoteAck extends ESystemMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - remaining
```
int remaining
```
      The number of remaining remote repliers. When this value reaches zero, the request is completed.
- Class net.sf.eBus.client.sysmessages.ResumeReply extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - replyStatus
```
EReplyMessage.ReplyStatus replyStatus
```
      The current request handling status. If EReplyMessage.ReplyStatus.ERROR, then ResumeReply.replyReason will contain text explaining why the request was rejected.
    - replyReason
```
String replyReason
```
      The reason for a EReplyMessage.ReplyStatus.ERROR reply status. May be null or empty.
- Class net.sf.eBus.client.sysmessages.ResumeRequest extends AbstractLogonMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.client.sysmessages.SubscribeMessage extends AbstractKeyMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - feedState
```
EFeedState feedState
```
      The subscription is either EFeedState.UP or EFeedState.DOWN.
Package net.sf.eBus.messages
- Class net.sf.eBus.messages.EAbstractList extends ArrayList<E extends EMessageObject> implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mReadOnlyFlag
```
boolean mReadOnlyFlag
```
      When set to true list may only be read from and not updated.
- Class net.sf.eBus.messages.EField extends EMessageObject implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.messages.EFieldList extends EAbstractList<E extends EField> implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.messages.EMessage extends EMessageObject implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - subject
```
String subject
```
      The required message subject. The subject and the message class are used to route this message to the intended eBus clients.
    - timestamp
```
long timestamp
```
      The message timestamp in Java millisecond epoch time.
    - mMessageType
```
EMessage.MessageType mMessageType
```
      The message type. Either notification, request, reply, or system.
    - mKey
```
EMessageKey mKey
```
      The message key combining the message class and subject.
- Class net.sf.eBus.messages.EMessageKey extends Object implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mMessageClass
```
Class<T> mMessageClass
```
      The message class.
    - mMessageClassessageSubject
```
String mMessageClassessageSubject
```
      The message subject.
    - mHashCode
```
int mHashCode
```
      Message key hash code is lazily computed the first time it is requested and then cached for later use. The reason is that hash key calculation is expensive and not always needed.
    - mKeyString
```
String mKeyString
```
      The combination of the message class and subject. Used a the key into the subject tree. This value is created on demand only.
- Class net.sf.eBus.messages.EMessageList extends EAbstractList<E extends EMessage> implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mKey
```
EMessageKey mKey
```
      All messages placed into this list must have this key.
- Class net.sf.eBus.messages.EMessageObject extends Object implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.messages.ENotificationMessage extends EMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.messages.EReplyMessage extends EMessage implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - replyStatus
```
EReplyMessage.ReplyStatus replyStatus
```
      The current request handling status. If EReplyMessage.ReplyStatus.ERROR, then EReplyMessage.replyReason will contain text explaining why the request was rejected.
    - replyReason
```
String replyReason
```
      The reason for a EReplyMessage.ReplyStatus.ERROR reply status. May be null or empty.
- Class net.sf.eBus.messages.ERequestMessage extends EMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.messages.ESystemMessage extends EMessage implements Serializable
  
  serialVersionUID:
  
  328192L
- Class net.sf.eBus.messages.InvalidMessageException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mMsgClass
```
Class<T> mMsgClass
```
      The invalid message identifier.
- Class net.sf.eBus.messages.UnknownFieldException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mMessageName
```
String mMessageName
```
      The message class name.
    - mField
```
String mField
```
      The unknown message field.
- Class net.sf.eBus.messages.UnknownMessageException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mClass
```
String mClass
```
      The message class name causing this exception.
- Class net.sf.eBus.messages.ValidationException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  328192L
  - Serialized Fields
    - mClass
```
Class<T> mClass
```
      Build failed attempting to build this message object class.
    - mProblems
```
List<E> mProblems
```
      Text explaining each validation failure.

Serialized Form

Package net.sf.eBus.client

Class net.sf.eBus.client.AbstractEBusMessage extends ENotificationMessage implements Serializable

Serialized Fields

remoteAddress

serverPort

Class net.sf.eBus.client.ConnectionMessage extends AbstractEBusMessage implements Serializable

Serialized Fields

state

reason

Class net.sf.eBus.client.ERemoteAppContext extends statemap.FSMContext7 implements Serializable

Class net.sf.eBus.client.ServerMessage extends AbstractEBusMessage implements Serializable

Class net.sf.eBus.client.TestPublisherContext extends statemap.FSMContext7 implements Serializable

Class net.sf.eBus.client.TestReplierContext extends statemap.FSMContext7 implements Serializable

Class net.sf.eBus.client.TestRequestorContext extends statemap.FSMContext7 implements Serializable

Class net.sf.eBus.client.TestSubscriberContext extends statemap.FSMContext7 implements Serializable

Package net.sf.eBus.client.sysmessages

Class net.sf.eBus.client.sysmessages.AbstractKeyMessage extends ESystemMessage implements Serializable

Serialized Fields

messageClass

messageSubject

Class net.sf.eBus.client.sysmessages.AbstractLogonMessage extends ESystemMessage implements Serializable

Serialized Fields

eid

Class net.sf.eBus.client.sysmessages.AdMessage extends AbstractKeyMessage implements Serializable

Serialized Fields

adStatus

adMessageType

feedState

Class net.sf.eBus.client.sysmessages.CancelRequest extends ESystemMessage implements Serializable

Class net.sf.eBus.client.sysmessages.FeedStatusMessage extends ESystemMessage implements Serializable

Serialized Fields

feedState

Class net.sf.eBus.client.sysmessages.KeyMessage extends ESystemMessage implements Serializable

Serialized Fields

keyId

keyClass

keySubject

Class net.sf.eBus.client.sysmessages.LogoffMessage extends AbstractLogonMessage implements Serializable

Class net.sf.eBus.client.sysmessages.LogonCompleteMessage extends AbstractLogonMessage implements Serializable

Class net.sf.eBus.client.sysmessages.LogonMessage extends AbstractLogonMessage implements Serializable

Class net.sf.eBus.client.sysmessages.LogonReply extends AbstractLogonMessage implements Serializable

Serialized Fields

logonStatus

reason

Class net.sf.eBus.client.sysmessages.PauseReply extends AbstractLogonMessage implements Serializable

Serialized Fields

replyStatus

replyReason

pauseTime

maximumBacklogSize

Class net.sf.eBus.client.sysmessages.PauseRequest extends AbstractLogonMessage implements Serializable

Serialized Fields

pauseTime

maximumBacklogSize

discardPolicy

Class net.sf.eBus.client.sysmessages.RemoteAck extends ESystemMessage implements Serializable

Serialized Fields

remaining

Class net.sf.eBus.client.sysmessages.ResumeReply extends AbstractLogonMessage implements Serializable

Serialized Fields

replyStatus

replyReason

Class net.sf.eBus.client.sysmessages.ResumeRequest extends AbstractLogonMessage implements Serializable

Class net.sf.eBus.client.sysmessages.SubscribeMessage extends AbstractKeyMessage implements Serializable

Serialized Fields

feedState

Package net.sf.eBus.messages

Class net.sf.eBus.messages.EAbstractList extends ArrayList<E extends EMessageObject> implements Serializable

Serialized Fields

mReadOnlyFlag

Class net.sf.eBus.messages.EField extends EMessageObject implements Serializable

Class net.sf.eBus.messages.EFieldList extends EAbstractList<E extends EField> implements Serializable

Class net.sf.eBus.messages.EMessage extends EMessageObject implements Serializable

Serialized Fields

subject

timestamp

mMessageType

mKey

Class net.sf.eBus.messages.EMessageKey extends Object implements Serializable