org.apache.cocoon.acting
Class PropagatorAction

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.acting.AbstractAction
          extended byorg.apache.cocoon.acting.ServiceableAction
              extended byorg.apache.cocoon.acting.PropagatorAction
All Implemented Interfaces:
org.apache.cocoon.acting.Action, Configurable, Serviceable, ThreadSafe

public class PropagatorAction
extends org.apache.cocoon.acting.ServiceableAction
implements Configurable, ThreadSafe

This is the action used to propagate parameters into a store using an OutputModule. It simply propagates given expression. Additionaly it will make all propagated values available via returned Map.

Example configuration:

 <map:action type="...." name="...." logger="...">
   <output-module name="session-attr">
      <!-- optional configuration for output module -->
   </output-module>
   <store-empty-parameters>true</store-empty-parameters>
   <defaults>
     <default name="..." value="...."/>
     <default name="..." value="..."/>
   </defaults>
 </map:action>
 

Example use:

 <map:act type="session-propagator">
      <paramater name="example" value="{example}"/>
      <paramater name="example1" value="xxx"/>
      <parameter name="PropagatorAction:store-empty-parameters" value="true"/>
      <parameter name="PropagatorAction:output-module" value="session-attr"/>
 </map:act>
 

Configuration

output-module Nested element configuring output to use. Name attribute holds output module hint. XMLrequest-attr
store-empty-parameters Propagate parameters with empty values. booleantrue
defaults Parent for default parameters to propagate. XML
defaults/default Name attribute holds parameter name, value attribute holds parameter value. Will be used when not set on use. parameter

Parameters

PropagatorAction:output-module Alternative output module hint to use. A null configuration will be passed to a module selected this way. Stringas determined by configuration
PropagatorAction:store-empty-parameters Propagate parameters with empty values. booleanas determined by configuration
any other Any other parameter will be propagated. String

Version:
$Id: PropagatorAction.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
 
Fields inherited from class org.apache.cocoon.acting.ServiceableAction
manager
 
Fields inherited from class org.apache.cocoon.acting.AbstractAction
EMPTY_MAP
 
Fields inherited from interface org.apache.cocoon.acting.Action
ROLE
 
Constructor Summary
PropagatorAction()
           
 
Method Summary
 Map act(org.apache.cocoon.environment.Redirector redirector, org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String source, Parameters parameters)
           
 void configure(Configuration config)
           
 
Methods inherited from class org.apache.cocoon.acting.ServiceableAction
service
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropagatorAction

public PropagatorAction()
Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException
Specified by:
configure in interface Configurable
Throws:
ConfigurationException

act

public Map act(org.apache.cocoon.environment.Redirector redirector,
               org.apache.cocoon.environment.SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception
Specified by:
act in interface org.apache.cocoon.acting.Action
Throws:
Exception


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.