csbase.util.messages

Class Topic

java.lang.Object

csbase.util.messages.Topic

All Implemented Interfaces:

IDispatchListener<IMessageListener,Message>

public class Topic
extends java.lang.Object
implements IDispatchListener<IMessageListener,Message>

Armazena as mensagens até que elas sejam entregues ou expiradas.

Author:

Tecgraf

Constructor Summary

Constructors

Constructor and Description
Topic(MessageStore store, IDispatcher<IMessageListener,Message> dispatcher) Construtor.

Method Summary

Methods

Modifier and Type	Method and Description
MessageStore	getMessageStore() Obtém o componente responsável por armazenar as mensagens do tópico.
void	onDataDelivered(IMessageListener consumer, Message... messages) Método utilizado para indicar que os dados foram entregues com sucesso ao destino.
void	onExceptionThrown(java.lang.Exception e, IMessageListener consumer, Message... messages) Método utilizado para indicar que houve um erro durante a entrega dos dados ao destino.
void	publish(Message message, long timeToLive) Adiciona uma mensagem no tópico e notifica seus ouvintes.
Message[]	receive(java.io.Serializable consumerId, tecgraf.javautils.core.filter.IFilter<Message> filter) Obtém as mensagens a serem entregues a um dado consumidor e as marca como recebidas.
int	subscribe(java.io.Serializable consumerId, IMessageListener listener, tecgraf.javautils.core.filter.IFilter<Message> selector) Inclui um ouvinte de mensagens nessa estrutura.
int	unsubscribe(java.io.Serializable consumerId) Remove um determinado ouvinte desta estrutura.

Methods inherited from class java.lang.Object

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

Constructor Detail

Topic

public Topic(MessageStore store,
     IDispatcher<IMessageListener,Message> dispatcher)

Construtor.

Parameters:

store - Responsável por armazenar as mensagens e quem as recebeu.

dispatcher - Estratégia utilizada para entregar as mensagens aos consumidores.

Method Detail

receive

public Message[] receive(java.io.Serializable consumerId,
                tecgraf.javautils.core.filter.IFilter<Message> filter)

Obtém as mensagens a serem entregues a um dado consumidor e as marca como recebidas.

Parameters:

consumerId - Identificador do consumidor.

filter - filtro que determina as mensagens que serão retornadas.

Returns:

as mensagens a serem entregues a um dado consumidor.

publish

public void publish(Message message,
           long timeToLive)

Adiciona uma mensagem no tópico e notifica seus ouvintes.

Parameters:

message - Mensagem a ser incluída.

timeToLive - Tempo, em milisegundos, que essa mensagem deve persistir até que seja consumida.

subscribe

public int subscribe(java.io.Serializable consumerId,
            IMessageListener listener,
            tecgraf.javautils.core.filter.IFilter<Message> selector)

Inclui um ouvinte de mensagens nessa estrutura.

Parameters:

consumerId - Identificador do consumidor.

listener - Interface utilizada para entregar as mensagens de forma assíncrona.

selector - Filtro que determina as mensagens que serão repassadas ao ouvinte.

Returns:

o número de ouvintes restantes.

Throws:

java.lang.IllegalArgumentException - Se já existir um ouvinte com o mesmo identificador.

unsubscribe

public int unsubscribe(java.io.Serializable consumerId)

Remove um determinado ouvinte desta estrutura.

Uma vez removido, o ouvinte não irá mais receber mensagens a menos que seja inserido de novo através do método subscribe(Serializable, IMessageListener, IFilter).

Parameters:

consumerId - Identificador do consumidor.

Returns:

o número de ouvintes restantes.

See Also:

subscribe(Serializable, IMessageListener, IFilter)

getMessageStore

public MessageStore getMessageStore()

Obtém o componente responsável por armazenar as mensagens do tópico.

Returns:

o componente responsável por armazenar as mensagens do tópico.

onExceptionThrown

public void onExceptionThrown(java.lang.Exception e,
                     IMessageListener consumer,
                     Message... messages)

Método utilizado para indicar que houve um erro durante a entrega dos dados ao destino.

Specified by:

onExceptionThrown in interface IDispatchListener<IMessageListener,Message>

Parameters:

e - Exceção lançada durante a entrega.

consumer - Destino dos dados.

messages - Dados Dados que deveriam ter sido entregues.

onDataDelivered

public void onDataDelivered(IMessageListener consumer,
                   Message... messages)

Método utilizado para indicar que os dados foram entregues com sucesso ao destino.

Specified by:

onDataDelivered in interface IDispatchListener<IMessageListener,Message>

Parameters:

consumer - Destino dos dados.

messages - Dados entregues.