Plug-in d'attribut de session

Utilisez le plug-in de rendu SessionAttribute pour extraire, définir ou supprimer des attributs de la session de portlet ou de servlet. Lorsque vous accédez à la session de portlet vous pouvez également indiquer la portée des attributs de session en tant que portée d'application ou de portlet.

La syntaxe de ce plug-in est la suivante :

[Plugin:SessionAttribute key="" value="" mode="" scope="" defaultValue="" escape=""]

Ce plug-in utilise les attributs suivants :

portée

Utilisez cet attribut pour indiquer la portée de session et d'attribut avec laquelle vous voulez travailler :

application: Accès à la session de portlet dans la portée d'application de portlet.
portlet: Accès à la session de portlet dans la portée de portlet. Il s'agit de la portée par défaut.
servlet: Accès à la session de servlet.

key

Cet attribut permet d'indiquer le nom de l'attribut de session à extraire, définir ou supprimer.

mode

Cet attribut permet d'indiquer l'opération à effectuer :

get: Extraction de l'attribut indiqué de la session et renvoi de la valeur d'attribut.
set: Définition de l'attribut indiqué pour la session.
supprimer: Suppression de l'attribut indiqué de la session.
remove: Suppression de l'attribut indiqué de la session et renvoi de la valeur d'attribut précédemment définie.

valeur

Cet attribut permet de spécifier la valeur de l'attribut à définir. Si un attribut du même nom existe dans la demande, il est remplacé par la nouvelle valeur. Si vous souhaitez définir un attribut dans la demande, cet attribut est obligatoire.

defaultValue

Utilisez cet attribut pour indiquer la valeur à renvoyer si le paramètre de session voulu n'existe pas ou a la valeur null.

Echap

Utilisez cet attribut pour définir la séquence d'échappement à utiliser pour écrire l'adresse URL. Specify one of the values xml, json, javascript, or none. The default value is none. This value is evaluated only if the mode attribute is set to get or remove.

Exemples

Pour extraire l'attribut avec la clé key1 à partir de la session de portlet dans la portée de portlet, utilisez une des balises de plug-in suivantes :
```
[Plugin:SessionAttribute key="key1"]
[Plugin:SessionAttribute scope="portlet" key="key1"]
```
Pour extraire l'attribut avec la clé key1 à partir de la session de portlet dans la portée d'application de portlet, utilisez la balise de plug-in suivante :
```
[Plugin:SessionAttribute scope="application" key="key1"] 
```
Pour extraire l'attribut avec la clé key1 à partir de la session de servlet et pour renvoyer la valeur defaultValue si l'attribut n'est pas défini ou a la valeur null, utilisez la balise de plug-in suivante :
```
[Plugin:SessionAttribute scope="servlet" key="key1" defaultValue="defaultValue"] 
```
Pour définir l'attribut avec la clé key1 et la valeur value1 pour la session de portlet dans la portée de session de portlet, utilisez une des balises de plug-in suivantes :
```
[Plugin:SessionAttribute key="key1" value="value1"] 
[Plugin:SessionAttribute mode="set" key="key1" value="value1"]
```
Pour supprimer l'attribut avec la clé key1 de la session de portlet dans la portée d'application de portlet sans renvoyer la valeur précédente, utilisez le mode delete ou transmettez une valeur vide :
```
[Plugin:SessionAttribute key="key1" mode="delete"]
[Plugin:SessionAttribute key="key1" value=""]
```
Pour supprimer l'attribut avec la clé key1 de la session de portlet dans la portée d'application de portlet et renvoyer la valeur précédemment définie, utilisez la balise de plug-in suivante :
```
[Plugin:SessionAttribute scope="application" key="key1" mode="remove"]
```