net.sf.eBus.client.sysmessages

Class LogonReply

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.AbstractLogonMessage

net.sf.eBus.client.sysmessages.LogonReply

All Implemented Interfaces:

Serializable

public final class LogonReply
extends AbstractLogonMessage
implements Serializable

This message is sent in reply to a logon message. The subject contains the eBus identifier received in the LogonMessage.

Author:

Charles Rapp

See Also:

AbstractLogonMessage, LogonMessage, LogoffMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogonReply.Builder Class used to create LogonReply instances.

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
EReplyMessage.ReplyStatus	logonStatus Either the logon attempt succeeded or failed.
String	reason Explanation for a rejected logon request.

Fields inherited from class net.sf.eBus.client.sysmessages.AbstractLogonMessage

eid

Fields inherited from class net.sf.eBus.messages.ESystemMessage

SYSTEM_SUBJECT

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

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Method Summary

Modifier and Type	Method and Description
static LogonReply.Builder	builder() Returns a new instance of the LogonReply builder.
boolean	equals(Object o) Returns true if o is a non-null LogonReply instance with reply status and reason equal to this LogonReply instance and false otherwise.
int	hashCode() Returns the feed status message hash code.
String	toString() Returns a human-readable text version of this message.

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

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

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

Field Detail

logonStatus

public final EReplyMessage.ReplyStatus logonStatus

Either the logon attempt succeeded or failed.

reason

@Optional
public final String reason

Explanation for a rejected logon request. May be null or empty.

Method Detail

equals

public boolean equals(Object o)

Returns true if o is a non-null LogonReply instance with reply status and reason equal to this LogonReply instance and false otherwise.

Overrides:

equals in class AbstractLogonMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Returns the feed status message hash code.

Overrides:

hashCode in class AbstractLogonMessage

Returns:

the feed status message hash code.

toString

public String toString()

Returns a human-readable text version of this message.

Overrides:

toString in class AbstractLogonMessage

Returns:

text version of this message.

builder

public static LogonReply.Builder builder()

Returns a new instance of the LogonReply builder.

Returns:

message builder instance.