Asistencia al usuario para autores de contenido

Plugin del atributo de sesión

Utilice el plugin de representación de SessionAttribute para recuperar, establecer o eliminar atributos de la sesión de portlet o servlet. Al acceder a la sesión del portlet, también puede especificar el ámbito de los atributos de sesión como ámbito de la aplicación o ámbito del portlet.

La sintaxis para este plug-in es la siguiente:

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

Este plug-in utiliza los atributos siguientes:

scope

Utilice este atributo para especificar el ámbito de la sesión y el atributo con el que desea trabajar:

application: Acceda a la sesión del portlet en el ámbito de la aplicación de portlets.
portlet: Acceda a la sesión del portlet en el ámbito de los portlets. Este ámbito es el ámbito predeterminado.
servlet: Acceda a la sesión del servlet.

key

Utilice este atributo para especificar el nombre del atributo de sesión que desee recuperar, establecer o eliminar.

mode

Utilice este atributo para especificar la operación que desee realizar:

get: Recupera el atributo especificado desde la sesión y devuelve el valor del atributo.
set: Establece el atributo especificado en la sesión.
delete: Suprima el atributo especificado desde la sesión.
remove: Elimina el atributo especificado de la sesión y devuelve el valor del atributo que se estableció anteriormente.

value

Utilice este atributo para especificar el valor del atributo que desee establecer. Si un atributo con el mismo nombre ya existe en la solicitud, el atributo se sobrescribe con el nuevo valor. Si desea configurar un atributo en la solicitud, este atributo será obligatorio.

defaultValue

Utilice este atributo para especificar el valor que desea que se devuelva si el parámetro de sesión al que se hace referencia no existe o tiene un valor de null.

escape

Utilice este atributo para definir el escape que desee que se utilice para grabar el URL. Especifique uno de los valores xml, json, javascript o none. El valor predeterminado es none. Este valor se evalúa únicamente si el atributo mode se establece en get o remove.

Ejemplos

Para recuperar el atributo con la clave key1 de la sesión del portlet en ámbito del portlet, utilice uno de los códigos de plugin siguientes:
```
[Plugin:SessionAttribute key="key1"]
[Plugin:SessionAttribute scope="portlet" key="key1"]
```
Para recuperar el atributo con la clave key1 de la sesión del portlet en ámbito de aplicación del portlet, utilice el código de plugin siguiente:
```
[Plugin:SessionAttribute scope="application" key="key1"] 
```
Para recuperar el atributo con la clave key1 de la sesión del servlet y devolver el valor defaultValue si el atributo no está definido o tiene un valor de null, utilice el código de plugin siguiente:
```
[Plugin:SessionAttribute scope="servlet" key="key1" defaultValue="defaultValue"] 
```
Para establecer el atributo con la clave key1 y el valor value1 en la sesión del portlet en ámbito de sesión del portlet, utilice uno de los códigos de plugin siguientes:
```
[Plugin:SessionAttribute key="key1" value="value1"] 
[Plugin:SessionAttribute mode="set" key="key1" value="value1"]
```
Para suprimir el atributo con la clave key1 de la sesión del portlet en ámbito de aplicación del portlet sin devolver el valor anterior, utilice la modalidad delete (suprimir) o pase un valor vacío:
```
[Plugin:SessionAttribute key="key1" mode="delete"]
[Plugin:SessionAttribute key="key1" value=""]
```
Para eliminar el atributo con la clave key1 de la sesión del portlet en ámbito de aplicación del portlet y devolver el valor establecido anteriormente, utilice el código de plugin siguiente:
```
[Plugin:SessionAttribute scope="application" key="key1" mode="remove"]
```