lac.cnclib.sddl.message

Interface Message

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ApplicationMessage, ExtendedMessage, GroupMessage, PublishSubscribeMessage, ServiceMessage

public interface Message
extends java.io.Serializable

Represents message behavior. Abstraction utilized by applications for communication.

Author:

Rafael, Lucas

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.List<java.lang.String> tagList) Sets the message tags list, replacing previous list.

Method Detail

getType

ClientLibProtocol.MSGType getType()

Returns the message type

Returns:

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

addTag

void addTag(java.lang.String tag)

Stamps a tag in the message.

Parameters:

tag - Tag to be added to the message.

removeTag

void removeTag(java.lang.String tag)

Erases a message tag.

Parameters:

tag - Tag to be erased in the message.

hasTag

boolean hasTag(java.lang.String tag)

Checks if a tag is stamped in the message.

Parameters:

tag - Tag to be added to the message.

Returns:

// Definir retorno

getContentObject

java.io.Serializable getContentObject()

Retrieves the message content.

Returns:

Serializable object representing message content.

getContent

byte[] getContent()

Retrieves the message content.

Returns:

byte array representing message content.

setContentObject

void setContentObject(java.io.Serializable content)

Sets the message content.

Parameters:

content - Serializable object representing message content.

setContent

void setContent(byte[] content)

Sets the message content.

Parameters:

content - byte array representing message content.

getTagList

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

Returns the message tags list.

Returns:

List Message tags list, each represented by a String.

setTagList

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

Sets the message tags list, replacing previous list.

Parameters:

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

getSenderID

java.util.UUID getSenderID()

Retrieves the message sender ID.

Returns:

UUID UUID instance representing sender's ID.

setSenderID

void setSenderID(java.util.UUID senderID)

Sets the message sender ID.

Parameters:

senderID - UUID instance representing sender's ID.

getSenderGatewayID

java.util.UUID getSenderGatewayID()

Retrieves the message sender Gateway ID.

Returns:

UUID UUID instance representing sender's Gateway ID.

setSenderGatewayID

void setSenderGatewayID(java.util.UUID senderGatewayID)

Sets the message sender Gateway ID.

Parameters:

senderGatewayID - UUID instance representing sender's Gateway ID.

getRecipientID

java.util.UUID getRecipientID()

Retrieves the message recipient ID.

Returns:

UUID UUID instance representing recipient's ID.

setRecipientID

void setRecipientID(java.util.UUID recipientID)

Sets the message recipient ID.

Parameters:

recipientID - UUID instance representing recipient's ID.

getRecipientGatewayID

java.util.UUID getRecipientGatewayID()

Retrieves the message recipient Gateway ID.

Returns:

UUID UUID instance representing recipient's Gateway ID.

setRecipientGatewayID

void setRecipientGatewayID(java.util.UUID recipientGatewayID)

Sets the message recipient Gateway ID.

Parameters:

recipientGatewayID - UUID instance representing recipient's Gateway ID.

getContentClassName

java.lang.String getContentClassName()

setContentClassName

void setContentClassName(java.lang.String contentClassName)

getGatewayLogicalTime

long getGatewayLogicalTime()

setGatewayLogicalTime

void setGatewayLogicalTime(long gatewayLogicalTime)