Class org.omus.core.Session

Implemented Interfaces

iObservable iMessageHandler

Description

Classe est une enveloppe de la connection au serveur.

Evénements auxquels s'abonner :

Cette classe est implémentée en suivant le modèle Singleton. Un accès global à son instance est obtenu graçe à la méthode getInstance. Elle est aggrémentée par composition des méthodes des sources d'événements (EventDispatcher). Elle est aggrémentée par composition de la classe MessageHandler.

See Also

Field Index

address, changeGroup, loginPort, reconnectPort, versionID

Method Index

addHandler(), addListener(), countListeners(), getInstance(), handleChangeGroup(), handleMessage(), init(), isConnected(), login(), logout(), reconnect(), register(), removeAllListeners(), removeListener(), reset(), sendMessage(), setPasswordEncoder(), toLog(), toString()

Field Detail

versionID

public versionID:String
Version du client à valider avec celle du serveur. Permet de valider une bonne utilisation du client.

address

public address:String
Url du serveur.

loginPort

public loginPort:Number
Port du socket.

reconnectPort

public reconnectPort:Number
Autre port de connection en cas de l'utilsation en cluster.

changeGroup

public changeGroup:Boolean
Processus de changement de groupe enclenché.

Method Detail

toString

public function toString():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet

reset

public function reset():Void

Remet les informations de session à zéro.

init

public function init(vers:String, addr:String, login:Number, recon:Number):Void

Initialise la connection avec le serveur.

Parameters

versUne chaine qui sera comparée à l'attribut versionID du fichier config.xml.
addrUne url valide sous forme "www.domaine.tld" ou IP.
loginLe port du socket.
reconOptionnel. Requis qu'en mode cluster.

setPasswordEncoder

public function setPasswordEncoder(func:Function):Void

Spécifie une fonction d'encodage des mots de passe et méthodes enregistrées. Nécessite l'écriture d'une extension en java pour le décodage côté serveur. Exemple : pwdEncoder = function (password, serverKey){ var offset = parseInt(serverKey); var encoded = ""; for (var i = 0; i < password.length; i++) { var num = password.charCodeAt(i) + offset; encoded += num + "-"; } return encoded; } var session = org.omus.core.Session.getInstance(); session.setPasswordEncoder(pwdEncoder);

Parameters

funcFonction d'encodage.

login

public function login(user:String, pwd:String):Void

Log un utilisateur déjà enregistré comme utilisateur.

Parameters

userLogin de l'utilisateur.
pwdMot de passe.

register

public function register(user:String, pwd:String, mail:String):Void

Enregistre un nouvel utilisateur

Parameters

userLog utilisateur.
pwdMot de passe.
mailMail interne pour la réception de messages permanents.

isConnected

public function isConnected():Boolean

Spécifie si l'utilisateur est connecté ou si l'utilisateur est en train de changer de groupe.

logout

public function logout():Void

Cloture la connection au serveur.

sendMessage

public function sendMessage(env:Envelope):Void

Soumet un message au serveur.

Parameters

envEnveloppe contenant le message

addListener

public function addListener(listener:Object):Boolean

Ajoute un nouvel observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

addListener() in org.omus.util.iObservable

removeListener

public function removeListener(listener:Object):Boolean

Supprime un observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

removeListener() in org.omus.util.iObservable

removeAllListeners

public function removeAllListeners():Void

Supprime tous les abonnés.

Specified By

removeAllListeners() in org.omus.util.iObservable

countListeners

public function countListeners():Number

Retourne le nombre d'observateurs.

Return

Le nombre d'observateurs enregistrés.

Specified By

countListeners() in org.omus.util.iObservable

handleMessage

public function handleMessage(env:Envelope):Void

Active la gestion d'un type de message en fonction du contenu de son enveloppe.

Parameters

envUne référence à l'enveloppe.

Specified By

handleMessage() in org.omus.msg.iMessageHandler

addHandler

public function addHandler(subject:String, methodName:String):Void

Rajoute un gestionnaire chargé d'intercepter la réponse du serveur suite à un message soumis.

Parameters

subjectLe type de message.
methodNameLe nom de l'événement gérant un type de message.

Specified By

addHandler() in org.omus.msg.iMessageHandler

reconnect

public function reconnect(address:String):Void

Reconnection TODO : Ne semble pas utilisé.

Parameters

addressUrl de connection.

handleChangeGroup

public function handleChangeGroup():Void

Gère le changement de groupe.

toLog

static public function toLog():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet.

getInstance

static public function getInstance():Session

Accès global à la référence du Singleton

Return

Une référence à la classe