lac.cnclib.sddl.message

Class ApplicationMessage

java.lang.Object

lac.cnclib.sddl.message.ApplicationMessage

All Implemented Interfaces:

java.io.Serializable, Message

Direct Known Subclasses:

ExtendedMessage, ServiceMessage

public class ApplicationMessage
extends java.lang.Object
implements Message

Class that implements the message abstraction. Represents topics exchanged by the DDS SDDL infrastructure. The messages are used by the applications.

Author:

Rafael

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationMessage()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTag(java.lang.String tag) Stamps a tag in the message.
byte[]	getContent() Retrieves the message content.
java.lang.String	getContentClassName()
java.io.Serializable	getContentObject() Retrieves the message content.
long	getGatewayLogicalTime()
java.util.UUID	getRecipientGatewayID() Retrieves the message recipient Gateway ID.
java.util.UUID	getRecipientID() Retrieves the message recipient ID.
java.util.UUID	getSenderGatewayID() Retrieves the message sender Gateway ID.
java.util.UUID	getSenderID() Retrieves the message sender ID.
java.util.List<java.lang.String>	getTagList() Returns the message tags list.
ClientLibProtocol.MSGType	getType() Returns the message type
boolean	hasTag(java.lang.String tag) Checks if a tag is stamped in the message.
void	removeTag(java.lang.String tag) Erases a message tag.
void	setContent(byte[] content) Sets the message content.
void	setContentClassName(java.lang.String contentClassName)
void	setContentObject(java.io.Serializable content) Sets the message content.
void	setGatewayLogicalTime(long gatewayLogicalTime)
void	setRecipientGatewayID(java.util.UUID recipientGatewayID) Sets the message recipient Gateway ID.
void	setRecipientID(java.util.UUID recipientID) Sets the message recipient ID.
void	setSenderGatewayID(java.util.UUID senderGatewayID) Sets the message sender Gateway ID.
void	setSenderID(java.util.UUID senderID) Sets the message sender ID.
void	setTagList(java.util.LinkedList<java.lang.String> tagList)
void	setTagList(java.util.List<java.lang.String> tagList) Sets the message tags list, replacing previous list.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationMessage

public ApplicationMessage()

Method Detail

getContentObject

public java.io.Serializable getContentObject()

Retrieves the message content.

Specified by:

getContentObject in interface Message

Returns:

Serializable object representing message content.

getContent

public byte[] getContent()

Retrieves the message content.

Specified by:

getContent in interface Message

Returns:

byte array representing message content.

setContentObject

public void setContentObject(java.io.Serializable content)

Sets the message content.

Specified by:

setContentObject in interface Message

Parameters:

content - Serializable object representing message content.

setContent

public void setContent(byte[] content)

Description copied from interface: Message

Sets the message content.

Specified by:

setContent in interface Message

Parameters:

content - byte array representing message content.

getTagList

public java.util.List<java.lang.String> getTagList()

Returns the message tags list.

Specified by:

getTagList in interface Message

Returns:

List Message tags list, each represented by a String.

setTagList

public void setTagList(java.util.List<java.lang.String> tagList)

Sets the message tags list, replacing previous list.

Specified by:

setTagList in interface Message

Parameters:

tagList - Message tags list, each represented by a String.

addTag

public void addTag(java.lang.String tag)

Stamps a tag in the message.

Specified by:

addTag in interface Message

Parameters:

tag - Tag to be added to the message.

removeTag

public void removeTag(java.lang.String tag)

Erases a message tag.

Specified by:

removeTag in interface Message

Parameters:

tag - Tag to be erased in the message.

hasTag

public boolean hasTag(java.lang.String tag)

Checks if a tag is stamped in the message.

Specified by:

hasTag in interface Message

Parameters:

tag - Tag to be added to the message.

Returns:

// Definir retorno

getSenderID

public java.util.UUID getSenderID()

Retrieves the message sender ID.

Specified by:

getSenderID in interface Message

Returns:

UUID UUID instance representing sender's ID.

setSenderID

public void setSenderID(java.util.UUID senderID)

Sets the message sender ID.

Specified by:

setSenderID in interface Message

Parameters:

senderID - UUID instance representing sender's ID.

getSenderGatewayID

public java.util.UUID getSenderGatewayID()

Retrieves the message sender Gateway ID.

Specified by:

getSenderGatewayID in interface Message

Returns:

UUID UUID instance representing sender's Gateway ID.

setSenderGatewayID

public void setSenderGatewayID(java.util.UUID senderGatewayID)

Sets the message sender Gateway ID.

Specified by:

setSenderGatewayID in interface Message

Parameters:

senderGatewayID - UUID instance representing sender's Gateway ID.

getRecipientID

public java.util.UUID getRecipientID()

Retrieves the message recipient ID.

Specified by:

getRecipientID in interface Message

Returns:

UUID UUID instance representing recipient's ID.

setRecipientID

public void setRecipientID(java.util.UUID recipientID)

Sets the message recipient ID.

Specified by:

setRecipientID in interface Message

Parameters:

recipientID - UUID instance representing recipient's ID.

getRecipientGatewayID

public java.util.UUID getRecipientGatewayID()

Retrieves the message recipient Gateway ID.

Specified by:

getRecipientGatewayID in interface Message

Returns:

UUID UUID instance representing recipient's Gateway ID.

setRecipientGatewayID

public void setRecipientGatewayID(java.util.UUID recipientGatewayID)

Sets the message recipient Gateway ID.

Specified by:

setRecipientGatewayID in interface Message

Parameters:

recipientGatewayID - UUID instance representing recipient's Gateway ID.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getContentClassName

public java.lang.String getContentClassName()

Specified by:

getContentClassName in interface Message

setTagList

public void setTagList(java.util.LinkedList<java.lang.String> tagList)

setContentClassName

public void setContentClassName(java.lang.String contentClassName)

Specified by:

setContentClassName in interface Message

getGatewayLogicalTime

public long getGatewayLogicalTime()

Specified by:

getGatewayLogicalTime in interface Message

setGatewayLogicalTime

public void setGatewayLogicalTime(long gatewayLogicalTime)

Specified by:

setGatewayLogicalTime in interface Message

getType

public ClientLibProtocol.MSGType getType()

Description copied from interface: Message

Returns the message type

Specified by:

getType in interface Message

Returns:

type - indicating if is an application msg, extended msg, or servivce msg