org.apache.cocoon.acting
Class AbstractComplementaryConfigurableAction

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.acting.AbstractAction
          extended byorg.apache.cocoon.acting.AbstractConfigurableAction
              extended byorg.apache.cocoon.acting.ConfigurableServiceableAction
                  extended byorg.apache.cocoon.acting.AbstractComplementaryConfigurableAction
All Implemented Interfaces:
org.apache.cocoon.acting.Action, Configurable, Serviceable
Direct Known Subclasses:
AbstractValidatorAction

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:
$Id: AbstractComplementaryConfigurableAction.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
static boolean DESCRIPTOR_RELOADABLE_DEFAULT
          Should descriptors be reloaded?
 
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, org.apache.cocoon.environment.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.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
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

DESCRIPTOR_RELOADABLE_DEFAULT

public static final boolean DESCRIPTOR_RELOADABLE_DEFAULT
Should descriptors be reloaded?

See Also:
Constant Field Values
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,
                                         org.apache.cocoon.environment.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


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.