Session

com.kesoftware.imu.Session

com.kesoftware.imu.Session

Depuis : 1.0

Description

Gère une connexion à un serveur IMu.

Le nom d’hôte du serveur et son port peuvent être spécifiés en définissant des propriétés sur l’objet ou en définissant des propriétés par défaut au niveau de la classe.

Propriétés de classe

Méthode

Détails

defaultHost

Le nom de l’hôte auquel se connecter si aucun hôte spécifique à l’objet n’a été fourni.

Getter:

String getDefaultHost()

Setter:

setDefaultHost(String value)

defaultPort

Numéro du port sur l’hôte si aucun port spécifique à l’objet n’a été fourni.

Getter:

int getDefaultPort()

Setter:

setDefaultPort(int value)

Constructeurs

Constructeur

Détails

Session(host, port)

Session(String host, int port)

Crée un objet Session avec l'host et le port spécifiés.

Paramètres :

host (String)

L’hôte auquel se connecter.

port (int)

Port sur l’hôte sur lequel se connecter.

Session(host)

Session(String host)

Crée un objet Session avec l'host spécifié.

Le port utilisé pour la connexion sera obtenu à partir de la propriété de classe defaultPort.

Paramètres :

host (String)

L’hôte auquel se connecter.

Session(port)

Session(int port)

Crée un objet Session avec le port spécifié.

L’hôte auquel se connecter sera obtenu à partir de la propriété de classe defaultHost.

Paramètres :

port (int)

Port sur l’hôte sur lequel se connecter.

Session()

Session()

Crée un objet Session.

L’hôte auquel se connecter sera obtenu à partir de la propriété de classe defaultHost.

Le port utilisé pour la connexion sera obtenu à partir de la propriété de classe defaultPort.

Propriétés

Propriété

Détails

close

Un indicateur permettant de déterminer si la connexion au serveur doit être fermée après la requête suivante. Cet indicateur est transmis au serveur dans le cadre de la requête suivante afin de lui permettre d’effectuer le nettoyage nécessaire.

Getter:

boolean getClose()

Setter:

setClose(boolean value)

context

L’identifiant unique attribué par le serveur à la session en cours.

Getter:

String getContext()

Setter:

setContext(String value)

host

Nom de l’hôte auquel se connecter. La définition de cette propriété après l’établissement de la connexion n’a aucun effet.

Getter:

String getHost()

Setter:

setHost(String value)

port

Numéro du port de l’hôte auquel se connecter. La définition de cette propriété après l’établissement de la connexion n’a aucun effet.

Getter:

int getPort()

Setter:

setPort(int value)

suspend

Indicateur permettant de déterminer si le processus serveur gérant cette session doit commencer à écouter sur un port distinct et spécifique au processus afin de garantir qu’une nouvelle session se connecte au même processus serveur.

Cela fait partie du mécanisme de maintien de l’état d’IMu. Si cet indicateur est défini à true, après l’envoi de la prochaine requête au serveur, la propriété port de Session sera remplacée par le numéro du port spécifique au processus.

Getter:

boolean getSuspend()

Setter:

setSuspend(boolean value)

Méthodes

Propriété

Détails

connect()

void connect()

Ouvre une connexion à un serveur IMu.

Retourne :

void

 

Lancers :

IMuException

La connexion n’a pas pu être ouverte.

disconnect()

void disconnect()

Ferme la connexion au serveur IMu.

Retourne :

void

 

login(login, password, spawn)

Map login(String login, String password, boolean spawn)

Se connecte en tant que l’utilisateur indiqué avec le mot de passe correspondant.

Le paramètre password peut être null. Cela amènera le serveur à utiliser l’authentification côté serveur (telle que l’authentification .rhosts) pour authentifier l’utilisateur.

Paramètres :

login (String)

Le nom d’utilisateur avec lequel se connecter.

password (String)

Le mot de passe de l’utilisateur pour l’authentification.

spawn (boolean)

Un indicateur indiquant si le processus doit créer un nouveau processus enfant spécifiquement pour traiter les demandes de l’utilisateur nouvellement connecté.

Retourne :

Map

 

Lancers :

IMuException

La demande de connexion a échoué.

Exception

Une erreur de socket de bas niveau s’est produite.

login(login, password)

Map login(String login, String password)

Se connecte en tant que l’utilisateur indiqué avec le mot de passe correspondant.

Le paramètre password peut être null. Cela amènera le serveur à utiliser l’authentification côté serveur (telle que l’authentification .rhosts) pour authentifier l’utilisateur.

Spawn prend par défaut la valeur true, ce qui amène le serveur à créer un nouveau processus enfant spécifiquement pour traiter les demandes de l’utilisateur nouvellement connecté.

Paramètres :

login (String)

Le nom d’utilisateur avec lequel se connecter.

password (String)

Le mot de passe de l’utilisateur pour l’authentification.

Retourne :

Map

 

Lancers :

IMuException

La demande de connexion a échoué.

Exception

Une erreur de socket de bas niveau s’est produite.

login(login)

Map login(String login)

Se connecte en tant que l’utilisateur indiqué.

Utilise l’authentification côté serveur (telle que l’authentification .rhosts) pour authentifier l’utilisateur.

Le serveur créera un nouveau processus enfant spécifiquement pour traiter les demandes de l’utilisateur nouvellement connecté.

Paramètres :

login (String)

Le nom d’utilisateur avec lequel se connecter.

Retourne :

Map

 

Lancers :

IMuException

La demande de connexion a échoué.

Exception

Une erreur de socket de bas niveau s’est produite.

logout()

Map logout()

Déconnecte l’utilisateur du serveur.

Retourne :

Map

 

request(request)

Map request(Map request)

Envoie une requête de bas niveau au serveur IMu.

Paramètres :

request (Map)

Un objet Map contenant les paramètres de la requête.

Retourne :

Map

Un objet Map contenant la réponse du serveur.

Lancers :

IMuException

Une erreur côté serveur s'est produite.