csbase.server.services.messageservice

Class MessageService

java.lang.Object

csbase.remote.RemoteObjectObservable

csbase.server.ServerRemoteObjectObservable

csbase.server.Service

csbase.server.services.messageservice.MessageService

All Implemented Interfaces:

csbase.remote.MessageServiceInterface, csbase.remote.RemoteObservable, csbase.remote.RemoteObserverNotifierInterface, csbase.remote.ServiceInterface, LoginServiceListener, java.rmi.Remote

public class MessageService
extends Service
implements csbase.remote.MessageServiceInterface, LoginServiceListener

Implementa o serviço de mensagens.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields inherited from class csbase.remote.RemoteObjectObservable

observerManager

Fields inherited from interface csbase.remote.MessageServiceInterface

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
MessageService() Construtor do serviço.

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(csbase.util.messages.Message message, long timeToLive)
void	clearMessageListener()
void	clearMessageListener(ServerSession session) Remove do serviço de mensagens, o ouvinte de mensagens de uma sessão específica.
void	clearServerMessageListener(java.io.Serializable consumerId) Remove do serviço de mensagens o ouvinte de mensagens para o identificador especificado.
void	connectionLost(java.lang.String login, java.lang.Object sessionKey, java.lang.String systemName, long time) Informa que a conexão com um usuário foi perdida
static void	createService() Cria a instância única do serviço.
static MessageService	getInstance() Obtém a instância única do serviço.
protected boolean	has2Update(java.lang.Object arg, java.lang.Object event)
protected void	initService() Método abstrato de inicialização do serviço.
csbase.util.messages.Message[]	receive(tecgraf.javautils.core.filter.IFilter<csbase.util.messages.Message> filter)
void	send(csbase.util.messages.Message message, long timeToLive, java.lang.String... usersLogins)
void	send(csbase.util.messages.Message message, java.lang.String... usersLogins) Envia uma mensagem a vários destinatários.
void	sendToAdmin(csbase.util.messages.Message message) Envia uma mensagem para o administrator.
void	sendToAdmin(csbase.util.messages.Message message, long timeToLive) Envia uma mensagem para o administrator.
void	sendToAll(csbase.util.messages.Message message) Envia uma mensagem para todos os usuários ativos no momento.
void	sendToServer(csbase.util.messages.Message message) Envia uma mensagem para o próprio servidor.
void	sessionCreated(java.lang.String login, java.lang.Object sessionKey, long time) Informa que uma sessão foi criada
void	setMessageListener(csbase.remote.IRemoteMessageListener listener, tecgraf.javautils.core.filter.IFilter<csbase.util.messages.Message> filter)
java.io.Serializable	setServerMessageListener(csbase.util.messages.IMessageListener listener, tecgraf.javautils.core.filter.IFilter<csbase.util.messages.Message> filter) Atribui o ouvinte de mensagens para objetos no servidor ao serviço de mensagens.
protected void	shutdownService() Método abstrato de término do serviço
void	systemNameSet(java.lang.String login, java.lang.Object sessionKey, java.lang.String systemName, long time) Informa que o nome do sistema foi definido
void	userLoggingOut(java.lang.String login, java.lang.Object sessionKey, java.lang.String systemName, long time) Trata o fim da sessão do usuário, seja por logout, ou connection lost, removendo ouvinte de mensagens daquela sessão.

Methods inherited from class csbase.server.Service

getBooleanProperty, getDefaultLocale, getDoubleProperty, getExternalPropertyFile, getFormattedString, getFormattedString, getInitializationDependencies, getInstance, getIntProperty, getKey, getLongProperty, getName, getOptionalString, getOptionalString, getOSPropertyPath, getSenderName, getServices, getString, getString, getStringListProperty, getStringProperty, getSystemId, getThreadLocale, getUser, getUserPermission, hasProperty, incrCounter, isActive, isEnabled, isInternalServerRequest, isLoggingNotifications, isPropertyNull, logNotification, setEnabled, setKey, setSystemId, setUserId

Methods inherited from class csbase.server.ServerRemoteObjectObservable

handleException, handleFatalError

Methods inherited from class csbase.remote.RemoteObjectObservable

addObserver, countObservers, deleteObserver, deleteObserver, deleteObservers, has2update, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Constructor Detail

MessageService

public MessageService()
               throws ServerException

Construtor do serviço.

Throws:

ServerException - em caso de falha na construção do serviço.

Method Detail

getInstance

public static MessageService getInstance()

Obtém a instância única do serviço.

Returns:

A instância única do serviço.

createService

public static void createService()
                          throws ServerException

Cria a instância única do serviço.

Throws:

ServerException - Se houver erro na inicialização.

broadcast

public void broadcast(csbase.util.messages.Message message,
             long timeToLive)
               throws java.rmi.RemoteException

Specified by:

broadcast in interface csbase.remote.MessageServiceInterface

Throws:

java.rmi.RemoteException

send

public void send(csbase.util.messages.Message message,
        long timeToLive,
        java.lang.String... usersLogins)
          throws java.rmi.RemoteException

Specified by:

send in interface csbase.remote.MessageServiceInterface

Throws:

java.rmi.RemoteException

receive

public csbase.util.messages.Message[] receive(tecgraf.javautils.core.filter.IFilter<csbase.util.messages.Message> filter)
                                       throws java.rmi.RemoteException

Specified by:

receive in interface csbase.remote.MessageServiceInterface

Throws:

java.rmi.RemoteException

clearMessageListener

public void clearMessageListener()
                          throws java.rmi.RemoteException

Specified by:

clearMessageListener in interface csbase.remote.MessageServiceInterface

Throws:

java.rmi.RemoteException

setMessageListener

public void setMessageListener(csbase.remote.IRemoteMessageListener listener,
                      tecgraf.javautils.core.filter.IFilter<csbase.util.messages.Message> filter)
                        throws java.rmi.RemoteException

Specified by:

setMessageListener in interface csbase.remote.MessageServiceInterface

Throws:

java.rmi.RemoteException

systemNameSet

public void systemNameSet(java.lang.String login,
                 java.lang.Object sessionKey,
                 java.lang.String systemName,
                 long time)

Informa que o nome do sistema foi definido

Specified by:

systemNameSet in interface LoginServiceListener

Parameters:

login - Login do usuário

sessionKey - Chave da sessão do usuário

systemName - Nome do sistema definido pelo usuário

time - Hora em que ocorreu o evento representado em milisegundos

sessionCreated

public void sessionCreated(java.lang.String login,
                  java.lang.Object sessionKey,
                  long time)

Informa que uma sessão foi criada

Specified by:

sessionCreated in interface LoginServiceListener

Parameters:

login - Login do usuário

sessionKey - Chave da sessão do usuário

time - Hora em que ocorreu o evento representado em milisegundos

connectionLost

public void connectionLost(java.lang.String login,
                  java.lang.Object sessionKey,
                  java.lang.String systemName,
                  long time)

Informa que a conexão com um usuário foi perdida

Specified by:

connectionLost in interface LoginServiceListener

Parameters:

login - Login do usuário que perdeu a conexão

sessionKey - Chave da sessão do usuário

systemName - Nome do sistema definido pelo usuário ou NULL se não tiver sido definido.

time - Hora em que ocorreu o evento representado em milisegundos

userLoggingOut

public void userLoggingOut(java.lang.String login,
                  java.lang.Object sessionKey,
                  java.lang.String systemName,
                  long time)

Trata o fim da sessão do usuário, seja por logout, ou connection lost, removendo ouvinte de mensagens daquela sessão.

Specified by:

userLoggingOut in interface LoginServiceListener

Parameters:

login - Login do usuário.

sessionKey - Sessão do usuário.

systemName - Nome do sistema definido pelo usuário ou NULL se não tiver sido definido.

time - Hora em que ocorreu o evento representado em milisegundos

initService

protected void initService()
                    throws ServerException

Método abstrato de inicialização do serviço.

Specified by:

initService in class Service

Throws:

ServerException - em caso de falha

shutdownService

protected void shutdownService()
                        throws ServerException

Método abstrato de término do serviço

Specified by:

shutdownService in class Service

Throws:

ServerException - em caso de falha.

has2Update

protected boolean has2Update(java.lang.Object arg,
                 java.lang.Object event)

Specified by:

has2Update in class csbase.remote.RemoteObjectObservable

send

public void send(csbase.util.messages.Message message,
        java.lang.String... usersLogins)
          throws java.rmi.RemoteException

Envia uma mensagem a vários destinatários.

Parameters:

message - Mensagem a ser enviada.

usersLogins - Login dos usuários de destino.

Throws:

java.rmi.RemoteException - Caso haja problemas de comunicação com o servidor.

sendToAll

public void sendToAll(csbase.util.messages.Message message)

Envia uma mensagem para todos os usuários ativos no momento.

Parameters:

message - Mensagem a ser enviada.

sendToAdmin

public void sendToAdmin(csbase.util.messages.Message message,
               long timeToLive)
                 throws java.rmi.RemoteException

Envia uma mensagem para o administrator.

Parameters:

message - Mensagem a ser enviada.

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

Throws:

java.rmi.RemoteException

sendToAdmin

public void sendToAdmin(csbase.util.messages.Message message)
                 throws java.rmi.RemoteException

Envia uma mensagem para o administrator.

Parameters:

message - Mensagem a ser enviada.

Throws:

java.rmi.RemoteException

sendToServer

public void sendToServer(csbase.util.messages.Message message)

Envia uma mensagem para o próprio servidor.

Parameters:

message - Mensagem a ser enviada.

clearServerMessageListener

public void clearServerMessageListener(java.io.Serializable consumerId)

Remove do serviço de mensagens o ouvinte de mensagens para o identificador especificado. Utilizado para objetos no servidor.

Parameters:

consumerId - identificador do consumidor

setServerMessageListener

public java.io.Serializable setServerMessageListener(csbase.util.messages.IMessageListener listener,
                                            tecgraf.javautils.core.filter.IFilter<csbase.util.messages.Message> filter)

Atribui o ouvinte de mensagens para objetos no servidor ao serviço de mensagens.

Parameters:

listener - Ouvinte de mensagens.

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

Returns:

o identificador do consumidor no serviço de mensagens

clearMessageListener

public void clearMessageListener(ServerSession session)

Remove do serviço de mensagens, o ouvinte de mensagens de uma sessão específica.

Parameters:

session - a sessão