Class SessionPropagatorAction

  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.acting.AbstractAction
          extended by org.apache.cocoon.acting.AbstractConfigurableAction
              extended by org.apache.cocoon.acting.SessionPropagatorAction
All Implemented Interfaces:
Component, Configurable, LogEnabled, ThreadSafe, Action

public class SessionPropagatorAction
extends AbstractConfigurableAction
implements ThreadSafe

This is the action used to propagate parameters into session. It simply propagates given expression to the session. If session does not exist, action fails. Additionaly it will make all propagated values available via returned Map.

 <map:act type="session-propagator">
      <paramater name="example" value="{example}">
      <paramater name="example1" value="xxx">

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

Field Summary
Fields inherited from class org.apache.cocoon.acting.AbstractConfigurableAction
Fields inherited from class org.apache.cocoon.acting.AbstractAction
Fields inherited from interface org.apache.cocoon.acting.Action
Constructor Summary
Method Summary
 Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters parameters)
          Main invocation routine.
 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

Constructor Detail


public SessionPropagatorAction()
Method Detail


public void configure(Configuration conf)
               throws ConfigurationException
Description copied from class: AbstractConfigurableAction
Configures the Action. Takes the children from the Configuration and stores them them as key (configuration name) and value (configuration value) in settings.
This automates parsing of flat string-only configurations. For nested configurations, override this function in your action.

Specified by:
configure in interface Configurable
configure in class AbstractConfigurableAction


public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String src,
               Parameters parameters)
        throws Exception
Main invocation routine.

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
parameters - The Parameters for this invocation
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.
Exception - Indicates something is totally wrong

Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.