Allows actions to be written in XSP. This allows to use XSP to produce
XML fragments that are later reused in generators.
This action works in concert with the "action" logicheet, that offers
actions-related services such as redirect or result map access, and the
"capture" logicsheet that allows to capture parts of XSP-generated XML
either as an XMLizable containing serialized SAX events,
or as a DOM Node.
As for generators, the XSP file name is set using the "src" attribute.
This action accepts a single parameter, "output-attribute", which names
the request attribute where the XSP-generated document will be stored
(as an XMLizable). If this parameter is omitted, the
XSP result is discarded (often the case when inner fragments are captured
with the "capture" logicsheet").
When "output-attribute" is set, the action status defaults to "success",
meaning child sitemap statements are executed. This allows to use an
existing XSP without modification with this action.
When "output-attribute" isn't set, the action status defaults to "failure".
The XSP must then use the "action" logicsheet to set its status.
Example :
act(Redirector redirector,
SourceResolver resolver,
Map objectModel,
String source,
Parameters parameters)
Controls the processing against some values of the
Dictionary objectModel and returns a
Map object with values used in subsequent
sitemap substitution patterns.
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.
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.
objectModel - The Map with object of the
calling environment which can be used
to select values this controller may need
(ie Request, Response).
source - A source String to the Action
parameters - 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.
org.apache.avalon.framework.logger.AbstractLogEnabled