csbase.util.messages

Class Message

java.lang.Object

csbase.util.messages.Message

All Implemented Interfaces:

java.io.Serializable

public class Message
extends java.lang.Object
implements java.io.Serializable

Representa uma mensagem serializável.

Uma mensagem é composta de cabeçalho e corpo.
O cabeçalho carrega informações de identificação e tempo devida da mensagem; enquanto o corpo carrega o dado a ser entregue.

Version:

1.0

Author:

Tecgraf

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message(java.io.Serializable body) Construtor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsHeader(java.lang.String name) Indica se existe um cabeçalho dada a seu nome.
java.io.Serializable	getBody() Obtém o corpo da mensagem.
long	getCreationDate() Obtém a data de criação da mensagem.
java.io.Serializable	getHeader(java.lang.String name) Obtém o valor de um cabeçalho da mensagem.
java.util.UUID	getId() Obtém o identificador único da mensagem.
java.util.TimeZone	getTimeZone() Obtém o TimeZone padrão do host em que a data de criação foi atribuída.
void	setBody(java.io.Serializable body) Atribui um novo corpo a mensagem.
void	setHeader(java.lang.String name, java.io.Serializable value) Atribui o valor de um cabeçalho da mensagem.
void	setId(java.util.UUID id) Atribui o identificador único da mensagem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Message

public Message(java.io.Serializable body)

Construtor.

Parameters:

body - Corpo da mensagem.

Method Detail

getId

public java.util.UUID getId()

Obtém o identificador único da mensagem.

Returns:

Identificador único da mensagem.

setId

public void setId(java.util.UUID id)

Atribui o identificador único da mensagem.

Esse método será utilizado pelo serviço de entrega de mensagens para identificar a mensagem dentro dele. Consequentemente, irá sobrescrever qualquer valor que tenha sido atribuído ao id anteriormente.

Parameters:

id - o identificador único da mensagem.

getHeader

public java.io.Serializable getHeader(java.lang.String name)

Obtém o valor de um cabeçalho da mensagem.

Parameters:

name - Nome do cabeçalho.

Returns:

o valor de um cabeçalho da mensagem, ou null caso ele não exista. Obs.: null também é um valor válido um cabeçalho, para saber se ele não existe, use o método containsHeader(String).

See Also:

containsHeader(String), setHeader(String, Serializable)

containsHeader

public boolean containsHeader(java.lang.String name)

Indica se existe um cabeçalho dada a seu nome.

Parameters:

name - Nome do cabeçalho.

Returns:

true caso o cabeçalho exista.

See Also:

getHeader(String), setHeader(String, Serializable)

setHeader

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

Atribui o valor de um cabeçalho da mensagem. Se este cabeçalho ainda não existir, ele será criado.

Parameters:

name - Nome do cabeçalho.

value - Valor a ser atribuído.

See Also:

getHeader(String), containsHeader(String)

getBody

public java.io.Serializable getBody()

Obtém o corpo da mensagem.

Returns:

O corpo da mensagem.

setBody

public void setBody(java.io.Serializable body)

Atribui um novo corpo a mensagem.

Parameters:

body - O novo corpo da mensagem.

getCreationDate

public long getCreationDate()

Obtém a data de criação da mensagem.

Returns:

a data de criação da mensagem.

getTimeZone

public java.util.TimeZone getTimeZone()

Obtém o TimeZone padrão do host em que a data de criação foi atribuída.

Returns:

o TimeZone padrão do host em que a data de criação foi atribuída.

See Also:

getCreationDate()