moteur
Interface MoteurIHM

public interface MoteurIHM

L'interface Moteur - IHM.

Cette inerface présente les quelques méthodes que doit implémenter la classe du moteur qui sera visible par l'IHM.

Since:

1.0

Method Summary

int	addElementReseau(int type) ajoute un élément au réseau renvoie id si l'opération a réussi, -1 sinon
java.lang.String	addProprieteBase(int id, java.lang.String key, java.lang.String[] value) ajoute une propriété de base a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	addProprietePerso(int id, java.lang.String key, java.lang.String[] value) ajoute une propriété personalisée a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	delete() supprime le reseau et ses propriétés renvoie "true" si l'opération a réussi, sinon un message d'erreur
void	endApp() Demande la fermeture de l'application.
java.lang.String	export2Xml(java.io.File fichier) sauvegarde le reseau dans le fichier en paramétre renvoie "true" si l'execution est correct, sinon renvoie le message d'erreur
int	getAccess(java.lang.String codeMib) Renvoie le numéro d'accès d'un code MIB
java.util.Hashtable<java.lang.String,java.lang.String[]>	getBase(int id) retourne les proprietés de base a afficher pour l'element
java.lang.String	getIpContact(int id) Renvoie l'IP de contact de l'élément réseau L'IP de contact est nécessairement l'IP de l'une des interfaces accessibles de l'élément, bien qu'il puisse y avoir plusieurs interface sur l'élément.
boolean	getLog() permet de savoir si le moteur prend en charge les logs ou non
java.lang.String	getName(int id) Renvoie le nom de l'élément réseau
java.lang.String	getNetwork(int id) Renvoie l'adresse de réseau de l'élément spécifié.
reseau.MibNode	getNode(java.lang.String codeMib) Renvoie le noeud de l'arbre de la MIB à partir du code
boolean	getOnline(int id) Renvoie la valeur de la proptiété online d'un élément réseau.
java.util.Hashtable<java.lang.String,java.lang.String[]>	getPerso(int id) retourne les proprietés personalisées a afficher pour l'element
moteur.Reseau	getReseau() permet d'acceder au contenu du reseau
reseau.MibNode	getRoot() Renvoie la racine de l'arbre MIB
moteur.ElementReseauConfiguration[]	getTabERC() permet d'acceder aux propriétés des élèments du réseau
int	getType(int id) Renvoie le type de l'élément réseau
boolean	isOnline(int id) Interroge le réseau pour vérifier l'état de l'élément.
void	logOff() désactive la prise en charge des logs
void	logOn() active la prise en charge des logs
ihm.SymbBounds[]	open(java.io.File fichier) ouvre et initialise le moteur avec le fichier en paramétre renvoie "true" si l'execution est correct, sinon renvoie le message d'erreur
boolean	removeElementReseau(int id) supprime un élément au réseau renvoie true si l'opération a réussi, false sinon
java.lang.String	removeProprieteBase(int id, java.lang.String key, java.lang.String[] value) supprime une propriétés de base a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	removeProprietePerso(int id, java.lang.String key) supprime une propriété personalisé a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	replaceProprieteBase(int id, java.lang.String key, java.lang.String[] old, java.lang.String[] value) remplace une propriétés de base a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	replaceProprietePerso(int id, java.lang.String key, java.lang.String[] old, java.lang.String[] value) remplace une propriété personalisé a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	save(java.io.File fichier, ihm.SymbBounds[] positions) sauvegarde le moteur dans le fichier en paramétre renvoie "true" si l'execution est correct, sinon renvoie le message d'erreur
java.lang.String	updateBase(int id, java.util.Hashtable<java.lang.String,java.lang.String[]> old, java.util.Hashtable<java.lang.String,java.lang.String[]> value) met à jour les propriétés de base a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur
java.lang.String	updatePerso(int id, java.util.Hashtable<java.lang.String,java.lang.String[]> old, java.util.Hashtable<java.lang.String,java.lang.String[]> value) met à jour les propriétés personalisées a afficher renvoie "true" si l'opération a réussi, sinon un message d'erreur

Method Detail

getAccess

int getAccess(java.lang.String codeMib)

Renvoie le numéro d'accès d'un code MIB

Parameters:

codeMib - le code mib sous forme de chaîne de caractères

Returns:

l'entier correspondant

getNode

reseau.MibNode getNode(java.lang.String codeMib)

Renvoie le noeud de l'arbre de la MIB à partir du code

Parameters:

codeMib - le code mib sous forme de chaîne de caractères

Returns:

le noeud de l'arbre MIB

getRoot

reseau.MibNode getRoot()

Renvoie la racine de l'arbre MIB

Returns:

le noeud racine de l'arbre de la MIB

getReseau

moteur.Reseau getReseau()

permet d'acceder au contenu du reseau

Returns:

Reseau

getTabERC

moteur.ElementReseauConfiguration[] getTabERC()

permet d'acceder aux propriétés des élèments du réseau

Returns:

ElementReseauConfiguration[]

getOnline

boolean getOnline(int id)

Renvoie la valeur de la proptiété online d'un élément réseau.

N'interroge pas le réseau.

Parameters:

id - l'ID de l'élément réseau

Returns:

true si l'élément est online, false sinon

getType

int getType(int id)

Renvoie le type de l'élément réseau

Parameters:

id - l'identifiant de l'élément, partagé entre le moteur et l'IHM

Returns:

le type de l'élément. C'est l'un des types de la classe ET

getName

java.lang.String getName(int id)

Renvoie le nom de l'élément réseau

Parameters:

id - l'identifiant de l'élément, partagé entre le moteur et l'IHM

Returns:

le nom de l'élément

getIpContact

java.lang.String getIpContact(int id)

Renvoie l'IP de contact de l'élément réseau

L'IP de contact est nécessairement l'IP de l'une des interfaces accessibles de l'élément, bien qu'il puisse y avoir plusieurs interface sur l'élément. C'est l'IP par lequel le moteur contacte l'élément à travers la couche réseau.

Parameters:

id - l'identifiant de l'élément, partagé entre le moteur et l'IHM

Returns:

l'IP de contact de l'élément.

isOnline

boolean isOnline(int id)

Interroge le réseau pour vérifier l'état de l'élément.

Le timeout est définit par le réseau, il est en général d'une seconde. Cette fonction vérifie que l'élément répond en SNMP, uniquement.

Parameters:

id - l'ID de l'élément réseau

Returns:

true si l'élément a été trouvé, false sinon

getLog

boolean getLog()

permet de savoir si le moteur prend en charge les logs ou non

Returns:

boolean

open

ihm.SymbBounds[] open(java.io.File fichier)

ouvre et initialise le moteur avec le fichier en paramétre

renvoie "true" si l'execution est correct, sinon renvoie le message d'erreur

Parameters:

fichier - File

Returns:

un tableau de données graphiques sur les éléménts.

save

java.lang.String save(java.io.File fichier,
                      ihm.SymbBounds[] positions)

sauvegarde le moteur dans le fichier en paramétre

renvoie "true" si l'execution est correct, sinon renvoie le message d'erreur

Parameters:

fichier - File

Returns:

String

export2Xml

java.lang.String export2Xml(java.io.File fichier)

sauvegarde le reseau dans le fichier en paramétre

renvoie "true" si l'execution est correct, sinon renvoie le message d'erreur

Parameters:

fichier - File

Returns:

String

addElementReseau

int addElementReseau(int type)

ajoute un élément au réseau

renvoie id si l'opération a réussi, -1 sinon

Parameters:

type - le type de l'élément à ajouter (tel que définit dans la classe ET)

Returns:

l'ID de l'élément ajouté. Cet ID sera partagé par la suite entre l'IHM et le moteur

removeElementReseau

boolean removeElementReseau(int id)

supprime un élément au réseau

renvoie true si l'opération a réussi, false sinon

Parameters:

id - l'ID de l'élément réseau

Returns:

true si l'élément a été trouvé, false sinon

getBase

java.util.Hashtable<java.lang.String,java.lang.String[]> getBase(int id)

retourne les proprietés de base a afficher pour l'element

Parameters:

id - l'ID de l'élément réseau

Returns:

une hashtable des propriétés de base de l'élément

getPerso

java.util.Hashtable<java.lang.String,java.lang.String[]> getPerso(int id)

retourne les proprietés personalisées a afficher pour l'element

Parameters:

id - l'ID de l'élément réseau

Returns:

une hashtable des propriétés personalisées (favoris)

logOn

void logOn()

active la prise en charge des logs

logOff

void logOff()

désactive la prise en charge des logs

addProprietePerso

java.lang.String addProprietePerso(int id,
                                   java.lang.String key,
                                   java.lang.String[] value)

ajoute une propriété personalisée a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

key - String

value - String[]

Returns:

String

replaceProprietePerso

java.lang.String replaceProprietePerso(int id,
                                       java.lang.String key,
                                       java.lang.String[] old,
                                       java.lang.String[] value)

remplace une propriété personalisé a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

key - String

old - String[]

value - String[]

Returns:

String

removeProprietePerso

java.lang.String removeProprietePerso(int id,
                                      java.lang.String key)

supprime une propriété personalisé a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

key - String

Returns:

String

addProprieteBase

java.lang.String addProprieteBase(int id,
                                  java.lang.String key,
                                  java.lang.String[] value)

ajoute une propriété de base a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

key - String

value - String[]

Returns:

String

replaceProprieteBase

java.lang.String replaceProprieteBase(int id,
                                      java.lang.String key,
                                      java.lang.String[] old,
                                      java.lang.String[] value)

remplace une propriétés de base a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

key - String

old - String[]

value - String[]

Returns:

String

removeProprieteBase

java.lang.String removeProprieteBase(int id,
                                     java.lang.String key,
                                     java.lang.String[] value)

supprime une propriétés de base a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

key - String

value - String[]

Returns:

String

delete

java.lang.String delete()

supprime le reseau et ses propriétés

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Returns:

String

updateBase

java.lang.String updateBase(int id,
                            java.util.Hashtable<java.lang.String,java.lang.String[]> old,
                            java.util.Hashtable<java.lang.String,java.lang.String[]> value)

met à jour les propriétés de base a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

old - Hashtable

value - Hashtable

Returns:

String

updatePerso

java.lang.String updatePerso(int id,
                             java.util.Hashtable<java.lang.String,java.lang.String[]> old,
                             java.util.Hashtable<java.lang.String,java.lang.String[]> value)

met à jour les propriétés personalisées a afficher

renvoie "true" si l'opération a réussi, sinon un message d'erreur

Parameters:

id - l'ID de l'élément réseau

old - Hashtable

value - Hashtable

Returns:

String

endApp

void endApp()

Demande la fermeture de l'application.

Demande au moteur de fermer l'application proprement. Le moteur doit utiliser les méthodes finalize() de l'IHM et du réseau avant de terminer l'application.

getNetwork

java.lang.String getNetwork(int id)

Renvoie l'adresse de réseau de l'élément spécifié.

Le moteur calcul puis renvoie, sous forme de chaîne de caractères, l'adresse du réseau auquel appartient l'élément spécifié dans l'argument.

Parameters:

id - l'ID de l'élément réseau

Returns:

l'adresse du réseau, en tant que String.