Sirius.server.registry.rmplugin

Class RMRegistryServerImpl

java.lang.Object

Sirius.server.registry.rmplugin.RMRegistryServerImpl

All Implemented Interfaces:

Remote, RMForwarder, RMRegistry, RMRegistryServer

public class RMRegistryServerImpl
extends Object
implements RMRegistryServer

This Class ist the implementation of the RMRegestry Server. This server provides functionality such as sending messages to users, test rm object if there alive, determine online users etc.

Version:

0.6

Author:

Sebastian

Constructor Summary

Constructors

Constructor and Description
RMRegistryServerImpl()

Method Summary

Modifier and Type	Method and Description
boolean	available(String target) Checks if a user is availabe, available means in this context if you could send a message to this user and use the other offered services.
boolean	available(String target, String ipAddress) Actually the same method as available(String target) but with the difference that not only if one target user is online this account is available.
void	deregister(RMInfo info) This method is the pendant to the register method and deregisters a rmplugin by deleting the mapping between qualified name and RMInfo object.
ArrayList<String>	getAllActiveDomains() This Method delivers all domain in which are currently user registrated.
ArrayList<String>	getAllActiveGroups(String domain) This Method returns all groups within a specific domain.
ArrayList<RMUser>	getAllActiveUsers(String group, String domain) This Method returns all active user specified by a group and a domain.
ArrayList<RMUser>	getAllUsers() This method returns every user registered in the RMRegistry in an ArrayList.
protected int	getTotalCountOfLastSendMessages() Returns how many messages are send at last invocation of sendMessage().
protected int	getUserCount() Getter for the actual count of users online.
void	logCurrentRegistry() This method logs the current content of the registry to the log4j logger in the way qualified name --> rmiAdress.
void	register(RMInfo info) This Method registers an RMPlugin in the RMRegistry.
int	sendMessage(String target, String message, String title) This method is the heart of RMRegistry implementation and provides the main functionallity.
int	sendMessage(String target, String ipAddress, String message, String title) Actually the same as the Method sendMessage(String,String) but with this method it is possible to further select the user via the ipAddress.
void	startRMRegistryServer(int port) This Constructor initializes RMI Registry with the given port.
void	stopRMRegistryServer() This method is responsible for unbinding the RMRegistry Object.
void	updateRegistry() This method updates the registry that means every dead rmObject (if there is any problem by using the remote methods) will be removed from the RMRegistry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RMRegistryServerImpl

public RMRegistryServerImpl()

Method Detail

startRMRegistryServer

public void startRMRegistryServer(int port)
                           throws RemoteException

This Constructor initializes RMI Registry with the given port. In this registry the RMRegistry is bind, which enables clients to register and deregister RMPlugin instances. On the otherside it is possible to send messages to active users.

Parameters:

port - The port which registry should be used or if no one exist where to create

Throws:

RemoteException - java.lang.Exception This method forwards any uncatched exception

stopRMRegistryServer

public void stopRMRegistryServer()
                          throws Exception

This method is responsible for unbinding the RMRegistry Object.

Throws:

Exception - java.lang.Exception Any Exception thrown in this method will be forwarded to the next higher instance

available

public boolean available(String target)

Checks if a user is availabe, available means in this context if you could send a message to this user and use the other offered services.

Specified by:

available in interface RMForwarder

Parameters:

target - The target is a string identifier build up out of three components seperated by @'s. The identifier contains username, group and domain. for example heinz@ketschup@lecker where heinz indicates the user, ketschup the group and lecker the domain.

Returns:

return either true if the user is availabe or false if its not

available

public boolean available(String target,
                         String ipAddress)

Actually the same method as available(String target) but with the difference that not only if one target user is online this account is available. A target is only available if the ipAddresses are equal.

Specified by:

available in interface RMForwarder

Parameters:

target - The target is a string identifier build up out of three components seperated by @'s. The identifier contains username, group and domain. for example heinz@ketschup@lecker where heinz indicates the user, ketschup the group and lecker the domain.

ipAddress - the ipAddress of the user

Returns:

return either true if the user is availabe or false if its not

sendMessage

public int sendMessage(String target,
                       String message,
                       String title)
                throws UnableToSendMessageException

This method is the heart of RMRegistry implementation and provides the main functionallity. This method sends a message with a title to the given target. Target means in this context all user which contains the target string complete.

Specified by:

sendMessage in interface RMForwarder

Parameters:

target - The target is a string identifier build up out of three components seperated by @'s. The identifier contains username, group and domain. for example heinz@ketschup@lecker where heinz indicates the user, ketschup the group and lecker the domain.

message - the message which should be send to the user

title - the a short title of the message

Returns:

returns the number messages actually send to users

Throws:

UnableToSendMessageException - Sirius.server.registry.rmplugin.exception.UnableToSendMessageException This Exception is thrown if any attemp to send a message to an user identified by the target string fails due to extern circumstances for example a remote Exception.

sendMessage

public int sendMessage(String target,
                       String ipAddress,
                       String message,
                       String title)
                throws UnableToSendMessageException

Actually the same as the Method sendMessage(String,String) but with this method it is possible to further select the user via the ipAddress. The message is only send to a user exact on that maschine.

Specified by:

sendMessage in interface RMForwarder

Parameters:

target - The target is a string identifier build up out of three components seperated by @'s. The identifier contains username, group and domain. for example heinz@ketschup@lecker where heinz indicates the user, ketschup the group and lecker the domain.

ipAddress - the ipAddress to which the message should be send

message - the message which should be send to the user

title - the a short title of the message

Returns:

returns the number messages actually send to users

Throws:

UnableToSendMessageException - Sirius.server.registry.rmplugin.exception.UnableToSendMessageException This Exception is thrown if any attemp to send a message to an user identified by the target string fails due to extern circumstances for example a remote Exception.

register

public void register(RMInfo info)

This Method registers an RMPlugin in the RMRegistry. In this process a mapping is created between the full qualified identifier (username@group@domain) and the delivered RMInfo Object which contains all necessary information to connect to the RMPlugin. This information more specific the mapping will be saved in a hashmap.

Specified by:

register in interface RMRegistry

Parameters:

info - This object contains all the information of the object who is asking for registration.

deregister

public void deregister(RMInfo info)
                throws UnableToDeregisterException

This method is the pendant to the register method and deregisters a rmplugin by deleting the mapping between qualified name and RMInfo object.

Specified by:

deregister in interface RMRegistry

Parameters:

info - The object which should be removed from the RMRegistry

Throws:

UnableToDeregisterException - Sirius.server.registry.rmplugin.exception.UnableToDeregisterException This Exception is thrown if the object which should be deregister does not exist in the RMRegistry

getAllActiveDomains

public ArrayList<String> getAllActiveDomains()

This Method delivers all domain in which are currently user registrated.

Specified by:

getAllActiveDomains in interface RMForwarder

Returns:

a ArrayList which contains all domains

getAllActiveGroups

public ArrayList<String> getAllActiveGroups(String domain)

This Method returns all groups within a specific domain. A group is returned if at least one member is currently online

Specified by:

getAllActiveGroups in interface RMForwarder

Parameters:

domain - Only the groups specified by this domain will be checked

Returns:

an Arraylist containing the groups which at least have one active user

getAllActiveUsers

public ArrayList<RMUser> getAllActiveUsers(String group,
                                           String domain)

This Method returns all active user specified by a group and a domain.

Specified by:

getAllActiveUsers in interface RMForwarder

Parameters:

group - the group which should be checked

domain - the domain which should be checked

Returns:

an ArrayList containing all active users

getAllUsers

public ArrayList<RMUser> getAllUsers()

This method returns every user registered in the RMRegistry in an ArrayList. The objects in the list are containing the username and the onlineTime.

Specified by:

getAllUsers in interface RMForwarder

Returns:

all current active User

updateRegistry

public void updateRegistry()

This method updates the registry that means every dead rmObject (if there is any problem by using the remote methods) will be removed from the RMRegistry.

Specified by:

updateRegistry in interface RMForwarder

logCurrentRegistry

public void logCurrentRegistry()

This method logs the current content of the registry to the log4j logger in the way qualified name --> rmiAdress.

Specified by:

logCurrentRegistry in interface RMForwarder

getUserCount

protected int getUserCount()

Getter for the actual count of users online.

Returns:

the count of online users

getTotalCountOfLastSendMessages

protected int getTotalCountOfLastSendMessages()

Returns how many messages are send at last invocation of sendMessage().

Returns:

returns the total amount of last send messages