net.sf.eBus.client.sysmessages

Class AbstractKeyMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.AbstractKeyMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdMessage, SubscribeMessage

public abstract class AbstractKeyMessage
extends ESystemMessage
implements Serializable

Base class for all system messages which contain a message class name and message subject. The reason for sending a message key as a separate message class name and subject is due to the receiving eBus application failing to de-serialize the message key because Class.forName throwing ClassNotFoundException. It is entirely reasonable for connected eBus applications not to use exactly the same message set. Therefore, if an eBus application receives a message class name for a class it doesn't know about, that inbound message will successfully deserialize but is ignored.

Author:

Charles W. Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
String	messageClass The message key class name.
String	messageSubject The message key subject.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractKeyMessage(AbstractKeyMessage.Builder<?,?> builder) Creates a new abstract key message from the configured message builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if o is a non-null AdMessage instance with ad status, message class, and message type equal to this AdMessage instance and false otherwise.
int	hashCode() Returns the advertisement message hash code.
EMessageKey	messageKey() Returns the message key based on the message class name and subject.
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

messageClass

public final 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

public final String messageSubject

The message key subject.

Constructor Detail

AbstractKeyMessage

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

Creates a new abstract key message from the configured message builder.

Parameters:

builder - message builder.

Method Detail

equals

public boolean equals(Object o)

Returns true if o is a non-null AdMessage instance with ad status, message class, and message type equal to this AdMessage instance and false otherwise.

Overrides:

equals in class EMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Returns the advertisement message hash code.

Overrides:

hashCode in class EMessage

Returns:

the advertisement message hash code.

toString

public String toString()

Returns a human-readable text version of this message.

Overrides:

toString in class EMessage

Returns:

text version of this message.

messageKey

public final EMessageKey messageKey()
                             throws UnknownMessageException

Returns the message key based on the message class name and subject.

Returns:

the message key.

Throws:

UnknownMessageException - if messageClass is an unknown class name.