org.sape.carbon.services.carbonmanagement
Interface CarbonManagementServiceConfiguration

All Superinterfaces:

ComponentConfiguration, Configuration

public interface CarbonManagementServiceConfiguration

extends ComponentConfiguration

This interface defines the configuration of the DefaultCarbonManagementServiceImpl. Each component listed by the DontReconfigure array will not be reconfigured when refreshAllComponentConfigurations is called. Each entry in the DeploymentPropertyNames array will be returned by getDeploymentProperties.
Copyright 2002 Sapient

Since:

carbon 1.2

Version:

$Revision: 1.3 $($Author: jreed $ / $Date: 2003/04/15 18:53:53 $)

Author:

Douglas Voet, Dec 20, 2002

Field Summary

Fields inherited from interface org.sape.carbon.core.component.ComponentConfiguration

ComponentTemplateName

Method Summary

void	addDeploymentPropertyNames(String deploymentPropertyName) Adds a deployment property name
void	addDontReconfigure(String componentName) Adds a component that will not be reconfigured on a call to refreshAllComponentConfigurations.
String[]	getDeploymentPropertyNames() Gets the array of deployment property names.
String	getDeploymentPropertyNames(int index) Gets a deployment property name at the given index.
String[]	getDontReconfigure() Gets the array of components that will not be reconfigured on a call to refreshAllComponentConfigurations.
String	getDontReconfigure(int index) Gets a components that will not be reconfigured on a call to refreshAllComponentConfigurations.
void	setDeploymentPropertyNames(int index, String deploymentPropertyName) Replaces a deployment property name
void	setDeploymentPropertyNames(String[] deploymentPropertyNames) Sets the array of deployment property names.
void	setDontReconfigure(int index, String componentName) Replaces a component that will not be reconfigured on a call to refreshAllComponentConfigurations.
void	setDontReconfigure(String[] componentNames) Sets the array of components that will not be reconfigured on a call to refreshAllComponentConfigurations.

Methods inherited from interface org.sape.carbon.core.component.ComponentConfiguration

getComponentDescription, getComponentTemplateName, getFunctionalImplementationClass, getFunctionalInterface, setComponentDescription, setComponentTemplateName, setFunctionalImplementationClass, setFunctionalInterface

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Method Detail

getDontReconfigure

public String[] getDontReconfigure()

Gets the array of components that will not be reconfigured on a call to refreshAllComponentConfigurations.

Returns:

array of components that are not reconfigured

getDontReconfigure

public String getDontReconfigure(int index)

Gets a components that will not be reconfigured on a call to refreshAllComponentConfigurations.

Parameters:

index - index of component in the array to return

Returns:

component at given index

setDontReconfigure

public void setDontReconfigure(String[] componentNames)

Sets the array of components that will not be reconfigured on a call to refreshAllComponentConfigurations.

Parameters:

componentNames - array of components that are not reconfigured

setDontReconfigure

public void setDontReconfigure(int index,
                               String componentName)

Replaces a component that will not be reconfigured on a call to refreshAllComponentConfigurations.

Parameters:

index - index of the component to replace

componentName - component that isn't reconfigured

addDontReconfigure

public void addDontReconfigure(String componentName)

Adds a component that will not be reconfigured on a call to refreshAllComponentConfigurations.

Parameters:

componentName - component that isn't reconfigured

getDeploymentPropertyNames

public String[] getDeploymentPropertyNames()

Gets the array of deployment property names.

Returns:

array of deployment property names

getDeploymentPropertyNames

public String getDeploymentPropertyNames(int index)

Gets a deployment property name at the given index.

Parameters:

index - index of deployment property name to get

Returns:

deployment property name at given index

setDeploymentPropertyNames

public void setDeploymentPropertyNames(String[] deploymentPropertyNames)

Sets the array of deployment property names.

Parameters:

deploymentPropertyNames - array of deployment property names

setDeploymentPropertyNames

public void setDeploymentPropertyNames(int index,
                                       String deploymentPropertyName)

Replaces a deployment property name

Parameters:

index - index of the component to replace

deploymentPropertyName - new deployment property name

addDeploymentPropertyNames

public void addDeploymentPropertyNames(String deploymentPropertyName)

Adds a deployment property name

Parameters:

deploymentPropertyName - new deployment property name