com.opensymphony.xwork.config
Interface Configuration

All Known Implementing Classes:

DefaultConfiguration, MockConfiguration

public interface Configuration

XWork configuration.

Version:

$Date: 2007-11-25 08:06:04 -0600 (Sun, 25 Nov 2007) $ $Id: Configuration.java 1682 2007-11-25 14:06:04Z tm_jee $

Author:

Mike, tmjee

Method Summary

void	addPackageConfig(String name, PackageConfig packageConfig) Add a PackageConfig with package name specified as name
void	destroy() Allow the Configuration to clean up any resources that have been used.
PackageConfig	getPackageConfig(String name) Return the PackageConfig (package configuration) for package with named as name
Set	getPackageConfigNames() Return the PackageConfigs name as a Set.
Map	getPackageConfigs() Return the PackageConfig as a Map with the key as the package name and its value as the corresponding PackageConfig
String	getParameter(String name) Return the configuration parameter value for with parameter name as name.
Map	getParameters() Return the configuration parameters in xwork.xml
RuntimeConfiguration	getRuntimeConfiguration() The current runtime configuration.
void	rebuildRuntimeConfiguration() Rebuild the RuntimeConfiguration of XWork's configuration.
void	reload() Reload xwork configuration, once this is done, we need to grab the RuntimeConfiguration using getRuntimeConfiguration()
void	removePackageConfig(String name) Remove the PackageConfig for package with name as name.
void	setParameter(String name, String value) Set the configuration parameter.

Method Detail

rebuildRuntimeConfiguration

void rebuildRuntimeConfiguration()

Rebuild the RuntimeConfiguration of XWork's configuration.

getParameters

Map getParameters()

Return the configuration parameters in xwork.xml

    
      
         
         ....
      
      ....
    
 

Returns:

Map

getParameter

String getParameter(String name)

Return the configuration parameter value for with parameter name as name.

Parameters:

name - parameter name

Returns:

String

setParameter

void setParameter(String name,
                  String value)

Set the configuration parameter.

Parameters:

name - parameter name

value - parameter value

getPackageConfig

PackageConfig getPackageConfig(String name)

Return the PackageConfig (package configuration) for package with named as name

Parameters:

name - package name

Returns:

PackageConfig

getPackageConfigNames

Set getPackageConfigNames()

Return the PackageConfigs name as a Set.

Returns:

Set

getPackageConfigs

Map getPackageConfigs()

Return the PackageConfig as a Map with the key as the package name and its value as the corresponding PackageConfig

Returns:

Map

getRuntimeConfiguration

RuntimeConfiguration getRuntimeConfiguration()

The current runtime configuration. Currently, if changes have been made to the Configuration since the last time buildRuntimeConfiguration() was called, you'll need to make sure to get it using this method.

Returns:

the current runtime configuration

addPackageConfig

void addPackageConfig(String name,
                      PackageConfig packageConfig)

Add a PackageConfig with package name specified as name

Parameters:

name -

packageConfig -

destroy

void destroy()

Allow the Configuration to clean up any resources that have been used.

reload

void reload()
            throws ConfigurationException

Reload xwork configuration, once this is done, we need to grab the RuntimeConfiguration using getRuntimeConfiguration()

Throws:

ConfigurationException

removePackageConfig

void removePackageConfig(String name)

Remove the PackageConfig for package with name as name.

Parameters:

name - package name to be removed