com.ibm.commerce.foundation.common.config

Class ComponentConfigurationRegistry

java.lang.Object

com.ibm.commerce.foundation.common.config.ComponentConfigurationRegistry

public class ComponentConfigurationRegistry
extends java.lang.Object

Component configuration registry. Reads configuration files from the configuration directory, as needed, and loads them into the registry. The configuration directory is WC_INSTALL/xml/config/comp_id. (i.e. WC_INSTALL/xml/config/com.ibm.commerce.catalog) If any problems are encountered during component registration, a ComponentConfigurationException is raised and the configuration of the component will not be stored. i.e. Failed to read a configuration file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
ComponentConfiguration	getComponentConfiguration(java.lang.String astrComponentId) Gets the component configuration for the component by the specified component ID.
static ComponentConfigurationRegistry	instance() Gets the registry instance
ComponentConfiguration	reloadComponentConfiguration(java.lang.String astrComponentId) Forcefully reloads the component configuration from the configuration files for the component by the specified component ID.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

instance

public static ComponentConfigurationRegistry instance()

Gets the registry instance

Returns:

The registry instance

getComponentConfiguration

public ComponentConfiguration getComponentConfiguration(java.lang.String astrComponentId)

Gets the component configuration for the component by the specified component ID. The component configuration is loaded when the configuration is first requested for this component. If any errors occur while loading the configuration, a ComponentConfigurationException is thrown.

Parameters:

astrComponentId - the component ID.

Returns:

The configuration for the component specified; null if no configuration is available for the specified component ID.

reloadComponentConfiguration

public ComponentConfiguration reloadComponentConfiguration(java.lang.String astrComponentId)

Forcefully reloads the component configuration from the configuration files for the component by the specified component ID. This operation overrides the reload settings for this given component.

Parameters:

astrComponentId - the component ID.

Returns:

The newly reloaded configuration for the component specified; null if no configuration is available for the specified component ID.