org.apache.cocoon.acting
Class ServerPagesAction

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

All Implemented Interfaces:

Disposable, Component, Composable, Configurable, LogEnabled, ThreadSafe, Action

public class ServerPagesAction
extends ConfigurableComposerAction
implements Disposable, ThreadSafe

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 :

   <action type="serverpages" src="myAction.xsp">
     <map:param name="output-attribute" value="xsp-action-result"/>
     ...
   </action>
 

Version:

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

Author:

Sylvain Wallez

Field Summary

static String	ACTION_RESULT_OBJECT
static String	ACTION_SUCCESS_OBJECT
static String	REDIRECTOR_OBJECT

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

manager

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

ServerPagesAction()

Method Summary

Map	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.
void	configure(Configuration conf) Configures the Action.
void	dispose()

Methods inherited from class org.apache.cocoon.acting.ConfigurableComposerAction

compose

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

REDIRECTOR_OBJECT

public static final String REDIRECTOR_OBJECT

See Also:

Constant Field Values

ACTION_RESULT_OBJECT

public static final String ACTION_RESULT_OBJECT

See Also:

Constant Field Values

ACTION_SUCCESS_OBJECT

public static final String ACTION_SUCCESS_OBJECT

See Also:

Constant Field Values

Constructor Detail

ServerPagesAction

public ServerPagesAction()

Method Detail

configure

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

Overrides:

configure in class AbstractConfigurableAction

Throws:

ConfigurationException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        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).

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.

Throws:

Exception - Indicates something is totally wrong