org.moock.unity.core
Interface ClientManagementServices


public interface ClientManagementServices

Interface for handling services associated with Client Management.

Author:
Derek Clayton
See Also:
Services

Method Summary
 void changePersistentClient(java.lang.String clientID, java.util.ArrayList args)
          If an AttributePersistence Object is present this method will ask the Object to change an existing entry for a client.
 void createPersistentClient(java.lang.String clientID, java.util.ArrayList args)
          If an AttributePersistence Object is present this method will ask the Object to create a new entry for a client in persistent storage.
 java.util.HashSet getClientList()
          Returns the ClientServices for all clients connected to the server.
 int getNumClients()
          Returns the number of clients connected to the server.
 int getTotalConnections()
          Returns the total number of clients that have connected during the lifetime of the server.
 void loginClient(java.lang.String clientID, java.util.ArrayList args)
          If an AttributePersistence Object is present this method will ask the Object to retrieve the persistent Attributes for this Client.
 void removePersistentClient(java.lang.String clientID, java.util.ArrayList args)
          If an AttributePersistence Object is present this method will ask the Object to remove entry for a client from persistent storage.
 

Method Detail

getClientList

public java.util.HashSet getClientList()
Returns the ClientServices for all clients connected to the server.

getNumClients

public int getNumClients()
Returns the number of clients connected to the server.

getTotalConnections

public int getTotalConnections()
Returns the total number of clients that have connected during the lifetime of the server.

loginClient

public void loginClient(java.lang.String clientID,
                        java.util.ArrayList args)
                 throws org.moock.unity.core.exception.AuthenticationFailedException,
                        org.moock.unity.core.exception.PersistenceObjectNotSetException,
                        org.moock.unity.core.exception.PersistentClientNotFoundException,
                        org.moock.unity.core.exception.AttributePersistenceException,
                        org.moock.unity.core.exception.ClientNotFoundException
If an AttributePersistence Object is present this method will ask the Object to retrieve the persistent Attributes for this Client. The AttributePersistence Object is passed both the ClientServices for the Client and the ArrayList of args given in this method in an attempt to identify the Client.
Parameters:
clientID - if of the client to login

createPersistentClient

public void createPersistentClient(java.lang.String clientID,
                                   java.util.ArrayList args)
                            throws org.moock.unity.core.exception.PersistenceObjectNotSetException,
                                   org.moock.unity.core.exception.PersistentClientAlreadyExistsException,
                                   org.moock.unity.core.exception.AttributePersistenceException,
                                   org.moock.unity.core.exception.ClientNotFoundException
If an AttributePersistence Object is present this method will ask the Object to create a new entry for a client in persistent storage. The AttributePersistence Object is passed both the ClientServices for the Client and the ArrayList of args given in this method.
Parameters:
clientID - if of the client to login, null if for an offline client

removePersistentClient

public void removePersistentClient(java.lang.String clientID,
                                   java.util.ArrayList args)
                            throws org.moock.unity.core.exception.PersistenceObjectNotSetException,
                                   org.moock.unity.core.exception.PersistentClientNotFoundException,
                                   org.moock.unity.core.exception.AttributePersistenceException,
                                   org.moock.unity.core.exception.ClientNotFoundException
If an AttributePersistence Object is present this method will ask the Object to remove entry for a client from persistent storage. The AttributePersistence Object is passed both the ClientServices for the Client and the ArrayList of args given in this method.
Parameters:
clientID - if of the client to login, null if for an offline client

changePersistentClient

public void changePersistentClient(java.lang.String clientID,
                                   java.util.ArrayList args)
                            throws org.moock.unity.core.exception.PersistenceObjectNotSetException,
                                   org.moock.unity.core.exception.PersistentClientNotFoundException,
                                   org.moock.unity.core.exception.AuthenticationFailedException,
                                   org.moock.unity.core.exception.AttributePersistenceException,
                                   org.moock.unity.core.exception.ClientNotFoundException
If an AttributePersistence Object is present this method will ask the Object to change an existing entry for a client. The AttributePersistence Object is passed both the ClientServices for the Client and the ArrayList of args given in this method.
Parameters:
clientID - if of the client to login, null if for an offline client