org.granite.client.messaging.messages

Class AbstractMessage

java.lang.Object

org.granite.client.messaging.messages.AbstractMessage

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Message

Direct Known Subclasses:

AbstractRequestMessage, AbstractResponseMessage, TopicMessage

public abstract class AbstractMessage
extends java.lang.Object
implements Message

Author:

Franck WOLFF

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.granite.client.messaging.messages.Message

Message.Type

Constructor Summary

Constructors

Constructor and Description
AbstractMessage()
AbstractMessage(java.lang.String clientId)
AbstractMessage(java.lang.String id, java.lang.String clientId, long timestamp, long timeToLive, java.util.Map<java.lang.String,java.lang.Object> headers)

Method Summary

Methods

Modifier and Type	Method and Description
Message	clone()
protected void	copy(AbstractMessage message)
boolean	equals(java.lang.Object obj)
java.lang.String	getClientId()
java.lang.Object	getHeader(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getHeaders()
java.lang.String	getId()
long	getRemainingTimeToLive()
long	getRemainingTimeToLive(long currentTimeMillis)
long	getTimestamp()
long	getTimeToLive()
int	hashCode()
boolean	headerExists(java.lang.String name)
boolean	isExpired()
boolean	isExpired(long currentTimeMillis)
void	readExternal(java.io.ObjectInput in)
void	setClientId(java.lang.String clientId)
void	setHeader(java.lang.String name, java.lang.Object value)
void	setHeaders(java.util.Map<java.lang.String,java.lang.Object> headers)
void	setId(java.lang.String id)
void	setTimestamp(long timestamp)
void	setTimeToLive(long timeToLive)
java.lang.String	toString()
java.lang.StringBuilder	toString(java.lang.StringBuilder sb)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.granite.client.messaging.messages.Message

copy, getType

Constructor Detail

AbstractMessage

public AbstractMessage()

AbstractMessage

public AbstractMessage(java.lang.String clientId)

AbstractMessage

public AbstractMessage(java.lang.String id,
               java.lang.String clientId,
               long timestamp,
               long timeToLive,
               java.util.Map<java.lang.String,java.lang.Object> headers)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Message

setId

public void setId(java.lang.String id)

Specified by:

setId in interface Message

getClientId

public java.lang.String getClientId()

Specified by:

getClientId in interface Message

setClientId

public void setClientId(java.lang.String clientId)

Specified by:

setClientId in interface Message

getTimestamp

public long getTimestamp()

Specified by:

getTimestamp in interface Message

setTimestamp

public void setTimestamp(long timestamp)

Specified by:

setTimestamp in interface Message

getTimeToLive

public long getTimeToLive()

Specified by:

getTimeToLive in interface Message

setTimeToLive

public void setTimeToLive(long timeToLive)

Specified by:

setTimeToLive in interface Message

getHeaders

public java.util.Map<java.lang.String,java.lang.Object> getHeaders()

Specified by:

getHeaders in interface Message

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.lang.Object> headers)

Specified by:

setHeaders in interface Message

getHeader

public java.lang.Object getHeader(java.lang.String name)

Specified by:

getHeader in interface Message

setHeader

public void setHeader(java.lang.String name,
             java.lang.Object value)

Specified by:

setHeader in interface Message

headerExists

public boolean headerExists(java.lang.String name)

Specified by:

headerExists in interface Message

isExpired

public boolean isExpired()

Specified by:

isExpired in interface Message

isExpired

public boolean isExpired(long currentTimeMillis)

Specified by:

isExpired in interface Message

getRemainingTimeToLive

public long getRemainingTimeToLive()

Specified by:

getRemainingTimeToLive in interface Message

getRemainingTimeToLive

public long getRemainingTimeToLive(long currentTimeMillis)

Specified by:

getRemainingTimeToLive in interface Message

copy

protected void copy(AbstractMessage message)

clone

public Message clone()
              throws java.lang.CloneNotSupportedException

Specified by:

clone in interface Message

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.StringBuilder toString(java.lang.StringBuilder sb)