Apache » Cocoon »

Cocoon Core 2.2 homepage

Cocoon Core 2.2

SessionStateAction

Summary

Store the session's current state in a session attribute.

Basic information

Component typeAction
Cocoon blockcore
Java classorg.apache.cocoon.acting.SessionStateAction
Name in Sitemap
Cacheable

Documentation

To keep track of the state of a user's session, a string is

stored in a session attribute in order to allow to chose between

different pipelines in the sitemap accordingly.</p>

For added flexibility it is possible to use sub states as

well. For this declare your own name for the session state

attribute and give the number of sublevels plus the level to

modify. (This is one based!) Sub states below the current

one are removed from the session so that the default sub state will

be reentered when the user returns. If you don't like this

behaviour and prefer independent sub states, use this action

several times with different attribute names rather than sub

levels.

Global and local parameters:

state-key-prefix

String that identifies the attribute that stores the session state in the

          session object. When sublevels are used, this is a prefix ie. the

          number of the level is appended to the prefix. Example prefix is

          "__sessionState", sub-levels is 2, attributes

          "__sessionState1", "__sessionState2", and

          "__sessionState3" will be used to store the

          information.
new-state

String that identifies the current state
sub-levels

Number of sub levels to  use
state-level

Sub level to modify, this is one based
Errors and Improvements? If you see any errors or potential improvements in this document please help us: View, Edit or comment on the latest development version (registration required).