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

org.apache.cocoon.acting
Class AbstractComplementaryConfigurableAction

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.AbstractComplementaryConfigurableAction

All Implemented Interfaces:

Component, Configurable, LogEnabled, Serviceable, Action

Direct Known Subclasses:

AbstractDatabaseAction, AbstractValidatorAction, DatabaseAction

public abstract class AbstractComplementaryConfigurableAction
extends ConfigurableServiceableAction

Set up environment for configurable form handling data. This group of actions are unique in that they employ a terciary mapping. Each configuration file must use the same format in order to be effective. The name of the root configuration element is irrelevant.

Version:

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

Author:

Berin Loritsch

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

AbstractComplementaryConfigurableAction()

Method Summary

protected Configuration	getConfiguration(String descriptor) Set up the complementary configuration file.
protected Configuration	getConfiguration(String descriptor, boolean reloadable) Deprecated. please use the getConfiguration(String, SourceResolver, boolean) version of this method instead.
protected Configuration	getConfiguration(String descriptor, SourceResolver resolver, boolean reloadable) Set up the complementary configuration file.

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

service

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

configure

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

Constructor Detail

AbstractComplementaryConfigurableAction

public AbstractComplementaryConfigurableAction()

Method Detail

getConfiguration

protected Configuration getConfiguration(String descriptor)
                                  throws ConfigurationException

Set up the complementary configuration file. Please note that multiple Actions can share the same configurations. By using this approach, we can limit the number of config files. Also note that the configuration file does not have to be a file. Defaults to reload configuration file it has changed.

Throws:

ConfigurationException

getConfiguration

protected Configuration getConfiguration(String descriptor,
                                         boolean reloadable)
                                  throws ConfigurationException

Deprecated. please use the getConfiguration(String, SourceResolver, boolean) version of this method instead.

Throws:

ConfigurationException

getConfiguration

protected Configuration getConfiguration(String descriptor,
                                         SourceResolver resolver,
                                         boolean reloadable)
                                  throws ConfigurationException

Set up the complementary configuration file. Please note that multiple Actions can share the same configurations. By using this approach, we can limit the number of config files. Also note that the configuration file does not have to be a file.

Throws:

ConfigurationException