com.opensymphony.xwork2.config
Class ConfigurationManager

java.lang.Object
  extended by com.opensymphony.xwork2.config.ConfigurationManager

public class ConfigurationManager
extends Object

ConfigurationManager - central for XWork Configuration management, including its ConfigurationProvider.

Version:
$Date: 2008-06-21 11:29:39 +0200 (Sa, 21 Jun 2008) $ $Id: ConfigurationManager.java 1833 2008-06-21 09:29:39Z rainerh $
Author:
Jason Carreira, tm_jee

Field Summary
protected  Configuration configuration
           
private  List<ContainerProvider> containerProviders
           
protected  String defaultFrameworkBeanName
           
protected static Logger LOG
           
private  List<PackageProvider> packageProviders
           
protected  Lock providerLock
           
 
Constructor Summary
ConfigurationManager()
           
ConfigurationManager(String name)
           
 
Method Summary
 void addConfigurationProvider(ConfigurationProvider provider)
          Deprecated. Since 2.1, use #addContainerProvider()
 void addContainerProvider(ContainerProvider provider)
          adds a configuration provider to the List of ConfigurationProviders.
 void clearConfigurationProviders()
          Deprecated. Since 2.1, use clearContainerProviders()
 void clearContainerProviders()
           
 void conditionalReload()
          Reloads the Configuration files if the configuration files indicate that they need to be reloaded.
 void destroyConfiguration()
          Destroy its managing Configuration instance
 Configuration getConfiguration()
          Get the current XWork configuration object.
 List<ConfigurationProvider> getConfigurationProviders()
          Deprecated. Since 2.1, use getContainerProviders()
 List<ContainerProvider> getContainerProviders()
          Get the current list of ConfigurationProviders.
 void reload()
           
 void setConfiguration(Configuration configuration)
           
 void setConfigurationProviders(List<ConfigurationProvider> configurationProviders)
          Deprecated. Since 2.1, use #setContainerProvider()
 void setContainerProviders(List<ContainerProvider> containerProviders)
          Set the list of configuration providers
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static final Logger LOG

configuration

protected Configuration configuration

providerLock

protected Lock providerLock

containerProviders

private List<ContainerProvider> containerProviders

packageProviders

private List<PackageProvider> packageProviders

defaultFrameworkBeanName

protected String defaultFrameworkBeanName
Constructor Detail

ConfigurationManager

public ConfigurationManager()

ConfigurationManager

public ConfigurationManager(String name)
Method Detail

getConfiguration

public Configuration getConfiguration()
Get the current XWork configuration object. By default an instance of DefaultConfiguration will be returned

See Also:
DefaultConfiguration

setConfiguration

public void setConfiguration(Configuration configuration)

getConfigurationProviders

@Deprecated
public List<ConfigurationProvider> getConfigurationProviders()
Deprecated. Since 2.1, use getContainerProviders()

Get the current list of ConfigurationProviders. If no custom ConfigurationProviders have been added, this method will return a list containing only the default ConfigurationProvider, XMLConfigurationProvider. if a custom ConfigurationProvider has been added, then the XmlConfigurationProvider must be added by hand.

WARNING: This returns only ContainerProviders that can be cast into ConfigurationProviders

Returns:
the list of registered ConfigurationProvider objects
See Also:
ConfigurationProvider

getContainerProviders

public List<ContainerProvider> getContainerProviders()
Get the current list of ConfigurationProviders. If no custom ConfigurationProviders have been added, this method will return a list containing only the default ConfigurationProvider, XMLConfigurationProvider. if a custom ConfigurationProvider has been added, then the XmlConfigurationProvider must be added by hand.

TODO: the lazy instantiation of XmlConfigurationProvider should be refactored to be elsewhere. the behavior described above seems unintuitive.

Returns:
the list of registered ConfigurationProvider objects
See Also:
ConfigurationProvider

setConfigurationProviders

@Deprecated
public void setConfigurationProviders(List<ConfigurationProvider> configurationProviders)
Deprecated. Since 2.1, use #setContainerProvider()

Set the list of configuration providers

Parameters:
configurationProviders -

setContainerProviders

public void setContainerProviders(List<ContainerProvider> containerProviders)
Set the list of configuration providers

Parameters:
containerProviders -

addConfigurationProvider

@Deprecated
public void addConfigurationProvider(ConfigurationProvider provider)
Deprecated. Since 2.1, use #addContainerProvider()

adds a configuration provider to the List of ConfigurationProviders. a given ConfigurationProvider may be added more than once

Parameters:
provider - the ConfigurationProvider to register

addContainerProvider

public void addContainerProvider(ContainerProvider provider)
adds a configuration provider to the List of ConfigurationProviders. a given ConfigurationProvider may be added more than once

Parameters:
provider - the ConfigurationProvider to register

clearConfigurationProviders

@Deprecated
public void clearConfigurationProviders()
Deprecated. Since 2.1, use clearContainerProviders()

clears the registered ConfigurationProviders. this method will call destroy() on each of the registered ConfigurationProviders

See Also:
ContainerProvider.destroy()

clearContainerProviders

public void clearContainerProviders()

destroyConfiguration

public void destroyConfiguration()
Destroy its managing Configuration instance


conditionalReload

public void conditionalReload()
Reloads the Configuration files if the configuration files indicate that they need to be reloaded.


reload

public void reload()


Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.