This project has retired. For details please refer to its Attic page.

org.apache.cocoon.acting
Class AbstractConfigurableAction

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

All Implemented Interfaces:

Component, Configurable, LogEnabled, Action

Direct Known Subclasses:

ConfigurableComposerAction, ConfigurableServiceableAction, HttpCacheAction, HttpHeaderAction, RequestParameterExistsAction, SessionPropagatorAction, SessionStateAction

public abstract class AbstractConfigurableAction
extends AbstractAction
implements Configurable

AbstractConfigurableAction gives you the infrastructure for easily deploying more Actions that take default parameters.

Version:

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

Author:

Christian Haul

Field Summary

protected HashMap

settings Stores (global) configuration parameters as key / value pairs.

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

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

AbstractConfigurableAction()

Method Summary

void	configure(Configuration conf) Configures the Action.

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

Methods inherited from interface org.apache.cocoon.acting.Action

act

Field Detail

settings

protected HashMap settings

Stores (global) configuration parameters as key / value pairs.

Constructor Detail

AbstractConfigurableAction

public AbstractConfigurableAction()

Method Detail

configure

public void configure(Configuration conf)
               throws ConfigurationException

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

Throws:

ConfigurationException