Assistência ao utilizador para autores de conteúdo

Suplemento SessionAttribute

Utilize o suplemento de apresentação SessionAttribute para obter, definir ou remover atributos da sessão da portlet ou servlet. Ao aceder à sessão da portlet, também pode especificar o âmbito dos atributos da sessão como âmbito da aplicação ou da portlet.

A sintaxe deste suplemento é a seguinte:

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

Este suplemento utiliza os seguintes atributos:

scope

Utilize este atributo para especificar o âmbito da sessão e do atributo com o qual pretende trabalhar:

aplicação: Aceda à sessão da portlet no âmbito da aplicação de portlet.
portlet: Aceda à sessão da portlet no âmbito da portlet. Este âmbito corresponde à predefinição.
servlet: Aceda à sessão da servlet.

key

Utilize este atributo para especificar o nome do atributo de sessão que pretende obter, definir ou remover.

mode

Utilize este atributo para especificar a operação que pretende realizar:

get: Obtenha o atributo especificado da sessão e devolva o valor do atributo.
set: Defina o atributo especificado para a sessão.
eliminar: Elimine o atributo especificado da sessão.
remove: Remova o atributo especificado da sessão e devolva o valor do atributo definido anteriormente.

Value

Utilize este atributo para especificar o valor do atributo que pretende que seja definido. Se um atributo com o mesmo nome existir no pedido, esse atributo é substituído pelo novo valor. Se pretender definir um atributo no pedido, esse atributo é obrigatório.

defaultValue

Utilize este atributo para especificar o valor que pretende que seja devolvido se o parâmetro de sessão endereçado não existir ou tiver um valor de null.

escape

Utilize este atributo para definir a mudança de código que pretende que seja utilizada para escrever o URL. Especifique um dos valores xml, json, javascript ou none. O valor predefinido é none. Este valor apenas é avaliado se o atributo mode estiver definido como get ou remove.

Exemplos

Para obter o atributo com a chave key1 da sessão da portlet no âmbito da portlet, utilize um dos seguintes controlos do suplemento:
```
[Plugin:SessionAttribute key="key1"]
[Plugin:SessionAttribute scope="portlet" key="key1"]
```
Para obter o atributo com a chave key1 da sessão da portlet no âmbito da aplicação da portlet, utilize o seguinte controlo do suplemento:
```
[Plugin:SessionAttribute scope="application" key="key1"] 
```
Para obter o atributo com a chave key1 da sessão da servlet e para devolver o valor defaultValue se o atributo não estiver definido ou tiver um valor de null, utilize o seguinte controlo do suplemento:
```
[Plugin:SessionAttribute scope="servlet" key="key1" defaultValue="defaultValue"] 
```
Para definir o atributo com a chave key1 e o valor value1 para a sessão da portlet no âmbito da sessão da portlet, utilize um dos seguintes controlos do suplemento:
```
[Plugin:SessionAttribute key="key1" value="value1"] 
[Plugin:SessionAttribute mode="set" key="key1" value="value1"]
```
Para eliminar o atributo com a chave key1 da sessão da portlet no âmbito da aplicação da portlet sem devolver o valor anterior, utilize o modo delete ou transmita um valor em branco:
```
[Plugin:SessionAttribute key="key1" mode="delete"]
[Plugin:SessionAttribute key="key1" value=""]
```
Para remover o atributo com a chave key1 da sessão da portlet no âmbito da aplicação da portlet e devolver o valor definido anteriormente, utilize o seguinte controlo do suplemento:
```
[Plugin:SessionAttribute scope="application" key="key1" mode="remove"]
```