org.apache.cocoon.acting
Class AbstractMultiAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.AbstractConfigurableAction
              org.apache.cocoon.acting.ConfigurableServiceableAction
                  org.apache.cocoon.acting.AbstractMultiAction

All Implemented Interfaces:

Component, Configurable, LogEnabled, Serviceable, Action

public abstract class AbstractMultiAction
extends ConfigurableServiceableAction

The AbstractMultiAction provides a way to call methods of an action specified by the method parameter or request parameter. This can be extremly useful for action-sets or as action-sets replacement. Example: will call the method "doSave" of the MultiAction

Version:

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

Author:

Torsten Curdt

Field Summary

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

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

AbstractMultiAction()

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.

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

service

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

AbstractMultiAction

public AbstractMultiAction()

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

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.

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