Système Automatique de Surveillance

Système Automatique de
Surveillance
Jean-Paul Gressard - Jacques Lacote - Laurent Marchand - Xavier
Nicolovici
Copyright 2003

Package
sas.util
Classes de base du système SAS.
Ce package regroupe l'ensemble des classes de bases utilisées dans le développement du système SAS. Ces classes trouvent leurs
paramètres dans un unique fichier de configuration, le fichier sas.properties situé par défaut dans le répertoireconfig,
respectant le format nécessaire aux objetProperties
p> <br> <table width="100%" border=1> <tr> <th colspan=3>Description des paramètres du fichier de configuration</th> </tr>
<tr> <th>Paramètre</th> <th>Commentaires</th> <th>Status</th> </tr> <tr> <td>jndi-server-protocol</td> <td>Dépend de la
configuration du serveur JNDI (rmi,tcp,...)</td> <td>Obligatoire</td> </tr> <tr> <td>jndi-server-name</td> <td>Hostname du
serveur JNDI</td> <td>Obligatoire</td> </tr> <tr> <td>jndi-server-port</td> <td>Numéro du port du serveur JNDI</td>
<td>Obligatoire</td> </tr> <tr> <td>topic-connection-factory</td> <td>Dépend de la configuration du serveur OpenJMS</td>
<td>Obligatoire</td> </tr> <tr> <td>queue-connection-factory</td> <td>Dépend de la configuration du serveur OpenJMS</td>
<td>Obligatoire</td> </tr> <tr> <td>jms-user-id</td> <td>Le nom d'utilisateur JMS, est aussi utilisé pour identifier l'expéditeur
des messages</td> <td>Obligatoire</td> </tr> <tr> <td>jms-user-password</td> <td>Le mot de passe du jms-userid. Pas utilisé
pour l'instant</td> <td>Optionnel</td> </tr> <tr> <td>main-topic-name</td> <td>Dépend de la configuration du serveur
OpenJMS</td> <td>Obligatoire</td> </tr> <tr> <td>helpdesk-queue-name</td> <td>Dépend de la configuration du serveur
OpenJMS</td> <td>Obligatoire</td> </tr> </table> <br>
Page 2

sas.util
Class Connector
java.lang.Object
|
+-sas.util.Connector
public class Connector
extends java.lang.Object
La classe Connector se charge d'initialiser le contexte JNDI.
Cette classe s'occupe aussi de la gestion du fichier de configuration du package et propose quelques méthodes utiles au
développement de sous classes:
-Des méthodes d'accès aux paramètres du fichier de configuration ({@link #getSasProperty(String)}, {@link
#getSasProperty(String,String)})
-Des méthodes pour l'émission de message de log ({@link #log(String) log}, {@link #warning(String) warning}, {@link
#debug(String) debug} et {@link #error(String) error})
A faire:
-Passer les variables {@link #jndiContext} et {@link #configProperties} en variables statiques afin d'éviter de les initialiser
à chaques instanciation d'un objet {@link Connector}. Il faut pour celà modifier le comportement des méthodes {@link
#loadConfigFile(File)} et {@link #initJndi()}.
-Créer un nouveau constructeur acceptant un objet File en paramètre afin de pouvoir transmettre le nom du fichier en tant
que paramètre. Attention, les sous classes devront être adaptée en conséquence
See Also:
sas.util
Direct Known Subclasses:
MainTopicConnector
Fields
jndiContext
private javax.naming.InitialContext jndiContext
Variable interne permettant de stocker le contexte JNDI de l'application SAS.
See Also:
#initJndi()
configProperties
private java.util.Properties configProperties
Variable interne permettant de stocker les paramètres du fichier de configuration.
See Also:
#loadConfigFile(File)
Constructors
(continued on next page)
Page 3
sas.util.Connector

(continued from last page)
Connector
public Connector()
Charge le fichier de configuration de l'application et initialise le contexte JNDI.
Le fichier de configuration sas.properties est chargé par la méthode {@link #loadConfigFile(File)}, puis le contexte
JNDI est initialisé en faisant appel à la méthode {@link #initJndi()}.
Methods
loadConfigFile
private void loadConfigFile(java.io.File configFile)
Lit le fichier de config sas.properties et initialise la variable interne {@link #configProperties}
initJndi
private void initJndi()
Initialise le context JNDI et stocke une référence dans la variable interne {@link #jndiContext}.
Repose sur les paramètres:
jndi-server-protocoljndi-server-namejndi-server-port
getJndiContext
public javax.naming.InitialContext getJndiContext()
Méthode d'accès au membre privé {@link #jndiContext}.
Returns:
un objet InitialContext référencant le service JNDI SAS
getSasProperty
public java.lang.String getSasProperty(java.lang.String key)
Renvoie la valeur de la clef du fichier de configuration.
Parameters:
key - nom de la clef
Returns:
valeur de la clef
See Also:
#getSasProperty(String,String)
getSasProperty
public java.lang.String getSasProperty(java.lang.String key,
java.lang.String defaultValue)
Renvoie la valeur de la clef du fichier de configuration ou une valeur par défaut si la clef n'existe pas.
Parameters:
key - nom de la clef
defaultValue - valeur par défault
Returns:
(continued on next page)
Page 4
sas.util.Connector

(continued from last page)
la valeur de la clef ou à défaut le paramètre defaultValue
See Also:
#getSasProperty(String)
logMessage
private void logMessage(java.lang.String mess,
int type)
Permet d'écrire une chaîne de type INFO ou DEBUG sur la console.
En fonction du type de message, définit à l'aide des constantes exportées par l'interface {@link LogType}, la chaîne
s'affiche différement sur la console. Cette méthode privée existe pour les besoins des méthodes {@link #log(String)},
{@link #warning(String)}, {@link #debug(String)} et {@link #error(String)}.
Parameters:
mess - la chaîne à afficher
type - le type de message
See Also:
LogType
#log(String)
#debug(String)
log
public void log(java.lang.String mess)
Affiche une chaîne de caratère sur la sortie standard de la console.
Parameters:
mess - la chaîne à afficher
warning
public void warning(java.lang.String mess)
Affiche une chaîne précédée des caractères **WARNING**sur la sortie d'erreur de la console.
Parameters:
mess - la chaîne à afficher
debug
public void debug(java.lang.String mess)
Affiche une chaîne précédée des caractères **DEBUG**sur la sortie d'erreur de la console.
Parameters:
mess - la chaîne à afficher
error
public void error(java.lang.String mess)
Affiche une chaîne précédée des caractères **ERROR**sur la sortie d'erreur de la console et stop le programme avec le
code de retour -1
Parameters:
mess - la chaîne à afficher
Page 5
sas.util.Connector