com.opensymphony.xwork2.config
Interface Configuration

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DefaultConfiguration, MockConfiguration

public interface Configuration
extends java.io.Serializable

XWork configuration.

Author:
Mike

Method Summary
 void addPackageConfig(java.lang.String name, PackageConfig packageConfig)
           
 void destroy()
          Allow the Configuration to clean up any resources that have been used.
 Container getContainer()
           
 java.util.Set<java.lang.String> getLoadedFileNames()
           
 PackageConfig getPackageConfig(java.lang.String name)
           
 java.util.Set<java.lang.String> getPackageConfigNames()
           
 java.util.Map<java.lang.String,PackageConfig> getPackageConfigs()
           
 RuntimeConfiguration getRuntimeConfiguration()
          The current runtime configuration.
 java.util.List<UnknownHandlerConfig> getUnknownHandlerStack()
           
 void rebuildRuntimeConfiguration()
           
 void reload(java.util.List<ConfigurationProvider> providers)
          Deprecated. Since 2.1
 java.util.List<PackageProvider> reloadContainer(java.util.List<ContainerProvider> containerProviders)
           
 PackageConfig removePackageConfig(java.lang.String packageName)
          Removes a package from the the list of packages.
 void setUnknownHandlerStack(java.util.List<UnknownHandlerConfig> unknownHandlerStack)
           
 

Method Detail

rebuildRuntimeConfiguration

void rebuildRuntimeConfiguration()

getPackageConfig

PackageConfig getPackageConfig(java.lang.String name)

getPackageConfigNames

java.util.Set<java.lang.String> getPackageConfigNames()

getPackageConfigs

java.util.Map<java.lang.String,PackageConfig> getPackageConfigs()

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.

Returns:
the current runtime configuration

addPackageConfig

void addPackageConfig(java.lang.String name,
                      PackageConfig packageConfig)

removePackageConfig

PackageConfig removePackageConfig(java.lang.String packageName)
Removes a package from the the list of packages. Changes to the configuration won't take effect until buildRuntimeConfiguration is called.

Parameters:
packageName - the name of the package to remove
Returns:
the package removed (if any)

destroy

void destroy()
Allow the Configuration to clean up any resources that have been used.


reload

@Deprecated
void reload(java.util.List<ConfigurationProvider> providers)
            throws ConfigurationException
Deprecated. Since 2.1

Parameters:
providers -
Throws:
ConfigurationException

reloadContainer

java.util.List<PackageProvider> reloadContainer(java.util.List<ContainerProvider> containerProviders)
                                                throws ConfigurationException
Parameters:
containerProviders -
Throws:
ConfigurationException
Since:
2.1

getContainer

Container getContainer()
Returns:
the container

getLoadedFileNames

java.util.Set<java.lang.String> getLoadedFileNames()

getUnknownHandlerStack

java.util.List<UnknownHandlerConfig> getUnknownHandlerStack()
Returns:
list of unknown handlers
Since:
2.1

setUnknownHandlerStack

void setUnknownHandlerStack(java.util.List<UnknownHandlerConfig> unknownHandlerStack)
Parameters:
unknownHandlerStack -
Since:
2.1


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