Apache » Cocoon »

Cocoon Core 2.2 homepage

Cocoon Core 2.2

PropagatorAction

Summary

This is the action used to propagate parameters into a store using an {@link org.apache.cocoon.components.modules.output.OutputModule}. It simply propagates given expression. Additionaly it will make all propagated values available via returned Map.

Basic information

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

Documentation

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.

XML

request-attr

store-empty-parameters

Propagate parameters with empty values.

boolean

true

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.

String

as determined by configuration

PropagatorAction:store-empty-parameters

Propagate parameters with empty values.

boolean

as determined by configuration

any other

Any other parameter will be propagated.

String