Riferimenti per la classe org.jaebi.server.JAEBIServer

Diagramma di collaborazione per org.jaebi.server.JAEBIServer:

Collaboration graph
[legenda]
Lista di tutti i membri.

Descrizione Dettagliata

Autore:
detro
Server di JAEBI. Questa Classe e' si colloca al massimo livello di astrazione possibile per questo progetto.

Una volta istanziata, alloca tutte le risorse necessarie a fornire il servizio ed incapsula la logica di interezione tra tutte le classi di JAEBI, sfruttando anche la classe ServiceMediator, che rende semplice l'utilizzo dei servizi offerti in questa implementazione di JAEBI.

Definizione alla linea 41 del file JAEBIServer.java.

Membri pubblici

 JAEBIServer (String backEndPropertiesFilePath) throws JAEBIServerInitException
 Creates a new instance of JAEBIServer.
 JAEBIServer () throws JAEBIServerInitException
 Creates a new instance of JAEBIServer.
void registerNewUser (String userNick, Session userSession, String userType) throws JAEBIServerUserRegistrationException
 Registra un nuovo User sul Server.
void unregisterUser (Session userSession) throws JAEBIServerWrongSessionException
 Elimina uno User registrato sul Server.
User getRegisteredUser (Session userSession) throws JAEBIServerWrongSessionException
 Recupera uno User Registrato dal Server.
String executeRequest (Session userSession, String userRequest) throws JAEBIServerExecException, JAEBIServerWrongSessionException
 Esegue una richiesta.
List getRegisteredUsers ()
 Ritorna una List di tutti gli User attualmente Registrati.

Attributi privati

final UserContainer registeredUsers
 Container di User registrati sul Server.
ServiceMediator serviceMediator
 Istanza di Service Mediator che incapsula e centralizza l'uso di tutti i Servizi.

Attributi privati statici

static final String exceptionPrefix = "[JAEBIServer Exception]: "


Documentazione dei costruttori e dei distruttori

org.jaebi.server.JAEBIServer.JAEBIServer String  backEndPropertiesFilePath  )  throws JAEBIServerInitException
 

Creates a new instance of JAEBIServer.

Parametri:
backEndPropertiesFilePath File Path al file di configurazione del BackEndHandler
Eccezioni:
JAEBIServerInitException Errore in fase di Inizializzazione del JAEBI Server

Definizione alla linea 58 del file JAEBIServer.java.

Riferimenti org.jaebi.server.JAEBIServer.exceptionPrefix, org.jaebi.server.JAEBIServer.registeredUsers, e org.jaebi.server.JAEBIServer.serviceMediator.

00059                                         {
00060         
00061         /* Alloca il container di User:
00062          * controlla ogni 30 secondi che uno User non sia inattivo
00063          * da piu' di 5 minuti */
00064                 // param 01: Elimina User dopo 5 min (300 sec) di inattivita'
00065                 // param 02: Controlla Timestamp degli User ogni 30 sec
00066         registeredUsers = new TimeoutThreadedUserContainer( 300000, 30000 ); 
00067         serviceMediator = null;
00068         
00069         try {
00070             /* Alloca il Service Mediator */
00071             if ( backEndPropertiesFilePath != null ) {
00072                 serviceMediator = 
00073                         new ServiceMediatorImpl(backEndPropertiesFilePath);
00074             } else {
00075                 serviceMediator = new ServiceMediatorImpl();
00076             }
00077         } catch ( ServiceMediatorInitException sminite ) {
00078             throw new JAEBIServerInitException( 
00079                     exceptionPrefix + "Server Initialization Error\n" + sminite );
00080         }
00081     }

org.jaebi.server.JAEBIServer.JAEBIServer  )  throws JAEBIServerInitException
 

Creates a new instance of JAEBIServer.

Eccezioni:
JAEBIServerInitException Errore in fase di Inizializzazione del JAEBI Server

Definizione alla linea 89 del file JAEBIServer.java.

00090                                             {
00091 
00092             this(null);
00093         }


Documentazione delle funzioni membro

String org.jaebi.server.JAEBIServer.executeRequest Session  userSession,
String  userRequest
throws JAEBIServerExecException, JAEBIServerWrongSessionException
 

Esegue una richiesta.

La richieta dovra' essere codificata, in questa implementazione, nell'XML Xrequest. La risposta sara' codificata nell'XML Xresponse.

Parametri:
userSession Identifica quale User ha eseguito la richiesta
userRequest Richiesta XML
Eccezioni:
JAEBIServerExecException Errore durante l'esecuzione della Requst.

Definizione alla linea 165 del file JAEBIServer.java.

Riferimenti org.jaebi.server.JAEBIServer.exceptionPrefix, org.jaebi.server.service.ServiceMediator.executeServiceToString(), org.jaebi.server.JAEBIServer.getRegisteredUser(), e org.jaebi.server.JAEBIServer.serviceMediator.

Referenziato da org.jaebi.server.JAEBIWSImpl.executeRequest(), e org.jaebi.test.server.core.MainTestJAEBIServer.main().

00166                                                                           {
00167         
00168         User requestingUser = null;
00169         String result = null;
00170         
00171         requestingUser = getRegisteredUser(userSession);
00172                 
00173         try {
00174             result = serviceMediator.executeServiceToString(requestingUser, userRequest);
00175         } catch (ServiceMediatorExecException sermedee) {
00176             throw new JAEBIServerExecException(
00177                     exceptionPrefix + "Service Error\n" + sermedee );
00178         }
00179         
00180         return result;
00181     }

Questo è il grafo delle chiamate per questa funzione:

User org.jaebi.server.JAEBIServer.getRegisteredUser Session  userSession  )  throws JAEBIServerWrongSessionException
 

Recupera uno User Registrato dal Server.

Parametri:
userSession Session che identifica univocamente uno User
Restituisce:
User trovato
Eccezioni:
JAEBIServerWrongSessionException In caso di problemi con il Session fornito (per esempio, non esistono User con quel Session)

Definizione alla linea 142 del file JAEBIServer.java.

Riferimenti org.jaebi.server.core.UserContainer.contains(), org.jaebi.server.JAEBIServer.exceptionPrefix, org.jaebi.server.core.UserContainer.getUser(), e org.jaebi.server.JAEBIServer.registeredUsers.

Referenziato da org.jaebi.server.JAEBIServer.executeRequest(), e org.jaebi.server.JAEBIWSImpl.getUsersList().

00143                                                 {
00144         
00145         if ( !registeredUsers.contains(userSession) ) {
00146             throw new JAEBIServerWrongSessionException(
00147                     exceptionPrefix + "User or Session Unknown\n" );
00148         } else {
00149             return registeredUsers.getUser(userSession);
00150         }
00151     }

Questo è il grafo delle chiamate per questa funzione:

List org.jaebi.server.JAEBIServer.getRegisteredUsers  ) 
 

Ritorna una List di tutti gli User attualmente Registrati.

Restituisce:
List degli User registrati

Definizione alla linea 188 del file JAEBIServer.java.

Riferimenti org.jaebi.server.JAEBIServer.registeredUsers, e org.jaebi.server.core.UserContainer.toCollection().

00188                                          {
00189                 Collection coll = registeredUsers.toCollection();
00190                 ArrayList result = new ArrayList();
00191                                 
00192                 result.addAll(coll);
00193                 
00194                 return result;
00195         }

Questo è il grafo delle chiamate per questa funzione:

void org.jaebi.server.JAEBIServer.registerNewUser String  userNick,
Session  userSession,
String  userType
throws JAEBIServerUserRegistrationException
 

Registra un nuovo User sul Server.

Parametri:
userNick NickName dello User
userSession Session assegnata allo User (che lo identifica univocamente all'interno del Server)
userType Una stringa contenente il tipo di Utente
Eccezioni:
JAEBIServerUserRegistrationException In caso ci siano dei problemi durante la registrazione del nuovo User

Definizione alla linea 106 del file JAEBIServer.java.

Riferimenti org.jaebi.server.core.UserContainer.addUser(), org.jaebi.server.JAEBIServer.exceptionPrefix, e org.jaebi.server.JAEBIServer.registeredUsers.

Referenziato da org.jaebi.server.JAEBIWSImpl.login(), e org.jaebi.test.server.core.MainTestJAEBIServer.main().

00108                                                     {
00109         
00110         if ( !registeredUsers.addUser(userNick, userSession, userType) ) {
00111             throw new JAEBIServerUserRegistrationException(
00112                     exceptionPrefix + "Unable to Register User\n" );
00113         }
00114     }

Questo è il grafo delle chiamate per questa funzione:

void org.jaebi.server.JAEBIServer.unregisterUser Session  userSession  )  throws JAEBIServerWrongSessionException
 

Elimina uno User registrato sul Server.

Parametri:
userSession Session che identifica univocamente uno User
Eccezioni:
JAEBIServerWrongSessionException In caso di problemi con il Session fornito (per esempio, non esistono User con quel Session)

Definizione alla linea 124 del file JAEBIServer.java.

Riferimenti org.jaebi.server.JAEBIServer.exceptionPrefix, org.jaebi.server.JAEBIServer.registeredUsers, e org.jaebi.server.core.UserContainer.removeUser().

Referenziato da org.jaebi.server.JAEBIWSImpl.logout().

00125                                                 {
00126         
00127         if ( !registeredUsers.removeUser(userSession) ) {
00128             throw new JAEBIServerWrongSessionException(
00129                     exceptionPrefix + "User or Session Unknown\n" );
00130         }
00131     }

Questo è il grafo delle chiamate per questa funzione:


Documentazione dei dati membri

final String org.jaebi.server.JAEBIServer.exceptionPrefix = "[JAEBIServer Exception]: " [static, private]
 

Definizione alla linea 47 del file JAEBIServer.java.

Referenziato da org.jaebi.server.JAEBIServer.executeRequest(), org.jaebi.server.JAEBIServer.getRegisteredUser(), org.jaebi.server.JAEBIServer.JAEBIServer(), org.jaebi.server.JAEBIServer.registerNewUser(), e org.jaebi.server.JAEBIServer.unregisterUser().

final UserContainer org.jaebi.server.JAEBIServer.registeredUsers [private]
 

Container di User registrati sul Server.

Definizione alla linea 43 del file JAEBIServer.java.

Referenziato da org.jaebi.server.JAEBIServer.getRegisteredUser(), org.jaebi.server.JAEBIServer.getRegisteredUsers(), org.jaebi.server.JAEBIServer.JAEBIServer(), org.jaebi.server.JAEBIServer.registerNewUser(), e org.jaebi.server.JAEBIServer.unregisterUser().

ServiceMediator org.jaebi.server.JAEBIServer.serviceMediator [private]
 

Istanza di Service Mediator che incapsula e centralizza l'uso di tutti i Servizi.

Definizione alla linea 46 del file JAEBIServer.java.

Referenziato da org.jaebi.server.JAEBIServer.executeRequest(), e org.jaebi.server.JAEBIServer.JAEBIServer().


La documentazione per questa classe è stata generata a partire dal seguente file:
Generato il Mon Jun 27 22:50:39 2005 per JAEBI - JAva Enterprice BackEnd Interfacement da  doxygen 1.4.3