Sirius.server.registry.rmplugin.interfaces

Interface RMForwarder

All Superinterfaces:

Remote

All Known Subinterfaces:

RMRegistryServer

All Known Implementing Classes:

RMRegistryServerImpl

public interface RMForwarder
extends Remote

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

Sebastian

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.
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() DOCUMENT ME!
void	logCurrentRegistry() This method logs the current content of the registry to the log4j logger in the way qualified name --> rmiAdress.
int	sendMessage(String target, String message, String title) This method is the heart of RMRegistry implementation and represents 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	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.

Method Detail

sendMessage

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

This method is the heart of RMRegistry implementation and represents 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.

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:

RemoteException - 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.

UnableToSendMessageException - DOCUMENT ME!

sendMessage

int sendMessage(String target,
                String ipAddress,
                String message,
                String title)
         throws RemoteException,
                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.

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:

RemoteException - 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.

UnableToSendMessageException - DOCUMENT ME!

available

boolean available(String target)
           throws RemoteException

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.

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

Throws:

RemoteException - DOCUMENT ME!

available

boolean available(String target,
                  String ipAddress)
           throws RemoteException

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.

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

Throws:

RemoteException - DOCUMENT ME!

updateRegistry

void updateRegistry()
             throws RemoteException

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.

Throws:

RemoteException - DOCUMENT ME!

logCurrentRegistry

void logCurrentRegistry()
                 throws RemoteException

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

Throws:

RemoteException - DOCUMENT ME!

getAllActiveDomains

ArrayList<String> getAllActiveDomains()
                               throws RemoteException

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

Returns:

a ArrayList which contains all domains

Throws:

RemoteException - DOCUMENT ME!

getAllActiveGroups

ArrayList<String> getAllActiveGroups(String domain)
                              throws RemoteException

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

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

Throws:

RemoteException - DOCUMENT ME!

getAllActiveUsers

ArrayList<RMUser> getAllActiveUsers(String group,
                                    String domain)
                             throws RemoteException

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

Parameters:

group - the group which should be checked

domain - the domain which should be checked

Returns:

an ArrayList containing all active users

Throws:

RemoteException - DOCUMENT ME!

getAllUsers

ArrayList<RMUser> getAllUsers()
                       throws RemoteException

DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

RemoteException - DOCUMENT ME!