org.apache.cocoon.acting
Class SessionStateAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.AbstractConfigurableAction
              org.apache.cocoon.acting.SessionStateAction

All Implemented Interfaces:

Component, Configurable, LogEnabled, ThreadSafe, Action

public class SessionStateAction
extends AbstractConfigurableAction
implements ThreadSafe

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

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.

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

Version:

CVS $Id: SessionStateAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Christian Haul

See Also:

WildcardSessionAttributeMatcher, SessionAttributeSelector

Field Summary

protected int	mylevel
protected String	newstate
protected String	statekey
protected int	sublevels

Fields inherited from class org.apache.cocoon.acting.AbstractConfigurableAction

settings

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

SessionStateAction()

Method Summary

Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters par) Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns.
void	configure(Configuration conf) Configures the Action.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

statekey

protected String statekey

newstate

protected String newstate

sublevels

protected int sublevels

mylevel

protected int mylevel

Constructor Detail

SessionStateAction

public SessionStateAction()

Method Detail

configure

public void configure(Configuration conf)
               throws ConfigurationException

Configures the Action.

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractConfigurableAction

Throws:

ConfigurationException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String src,
               Parameters par)
        throws Exception

Description copied from interface: Action

Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns. NOTE: This interface is designed so that implentations can be ThreadSafe. When an action is ThreadSafe, only one instance serves all requests : this reduces memory usage and avoids pooling.

Specified by:

act in interface Action

resolver - The SourceResolver in charge

objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).

src - A source String to the Action

par - The Parameters for this invocation

Returns:

Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.

Throws:

Exception - Indicates something is totally wrong