com.jcorporate.expresso.kernel.management
Class ComponentConfigBridge

java.lang.Object
  com.jcorporate.expresso.kernel.management.ComponentConfigBridge

public class ComponentConfigBridge

extends Object

Provides getting and setting of configuration information for individual components

Version:

$Revision: 1.4 $ on $Date: 2004/11/17 20:48:17 $

Author:

Michael Rimov

Constructor Summary

ComponentConfigBridge()
Creates a new ComponentConfigBridge object.

Method Summary

ComponentConfig	getConfiguration(ExpressoComponent sourceComponent) Given a component, retrieve the component config object for this component.
void	setConfiguration(ExpressoComponent targetComponent, ComponentConfig newConfiguration) Resets the configuration for a component.
void	updateSystemConfiguration(ExpressoComponent changedComponent, ExpressoServicesConfig allServicesConfiguration, ComponentConfig newConfiguration) Updates the system configuration to that of the component that has been changed

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentConfigBridge

public ComponentConfigBridge()

Creates a new ComponentConfigBridge object.

Method Detail

updateSystemConfiguration

public void updateSystemConfiguration(ExpressoComponent changedComponent,
                                      ExpressoServicesConfig allServicesConfiguration,
                                      ComponentConfig newConfiguration)
                               throws ConfigurationException

Updates the system configuration to that of the component that has been changed

Parameters:

changedComponent - The changed component to be updated

allServicesConfiguration - The Complete Expresso Services Config usually obtained from the RootContainerInterface

newConfiguration - the new Configuration of the component. This can be obtained from this objects getConfiguration() method

Throws:

ConfigurationException - upon error.

setConfiguration

public void setConfiguration(ExpressoComponent targetComponent,
                             ComponentConfig newConfiguration)
                      throws ConfigurationException

Resets the configuration for a component. It is intended for this function to be used at Runtime. It locks the entire ComponentConfigBridge class so that only one component configuration by one administrator can take place at a time.

Parameters:

targetComponent - the Component to configure

newConfiguration - the new configuration information to set for the component

Throws:

ConfigurationException - if there is an error configuring the component.

getConfiguration

public ComponentConfig getConfiguration(ExpressoComponent sourceComponent)
                                 throws ConfigurationException

Given a component, retrieve the component config object for this component. It is intended for this function to be used at Runtime (as opposed to startup time). It locks the entire ComponentConfigBridge class so that only one component configuration by one administrator can take place at a time.

This function only retrieves the configuration of the target configuration, not its children.

Parameters:

sourceComponent - the Component to retrieve the configuration for.

Returns:

a filled out ComponentConfig object for the given target component

Throws:

ConfigurationException - upon error