org.sape.carbon.services.deployment
Interface DeploymentServiceConfiguration

All Superinterfaces:

ComponentConfiguration, Configuration

public interface DeploymentServiceConfiguration

extends ComponentConfiguration

Configuration interface for the Deployment Service

Since:

carbon 1.0

Version:

$Revision: 1.8 $($Author: dvoet $ / $Date: 2003/09/24 20:31:11 $)
Copyright 2002 Sapient

Author:

Douglas Voet, April 2002

Field Summary

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

ComponentTemplateName

Method Summary

String	getCurrentDeploymentNodeName() Gets the name to be used for the LinkNode that will be used to link to the current deployment's configuration file.
String	getDeploymentsNodeAbsoluteName() Gets the name of the root Node for deployments.
String	getEnvironmentName() Returns the name of the environment.
NameLookup	getEnvironmentNameLookup()
String	getInstanceName() Returns the name of the instance.
NameLookup	getInstanceNameLookup()
void	setCurrentDeploymentNodeName(String name) Sets the value of CurrentDeploymentNodeName.
void	setDeploymentsNodeAbsoluteName(String name) Sets the value of DeploymentsNodeAbsoluteName.
void	setEnvironmentName(String name) Sets the name of the environment.
void	setEnvironmentNameLookup(NameLookup environmentNameLookup)
void	setInstanceName(String name) Sets the name of the instance.
void	setInstanceNameLookup(NameLookup instanceNameLookup)

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

getDeploymentsNodeAbsoluteName

public String getDeploymentsNodeAbsoluteName()

Gets the name of the root Node for deployments. This name is an absolute path and must be a Folder. The the LinkNode to the current deployment configuration will be placed under this Node. All environment Nodes must be under this Node and the instance specific Nodes must be under the environment Nodes.

Example Node structure:

 / (root)
  +deployment
  | +deployments
  | | +development
  | | | +eng1
  | | | +eng2
  | | | +eng3
  | | +production
  | | | +instance1
  | | | +instance2
  | | | +instance3
  | | | +instance4
 

In this scenario, this method would return "/deployment/deployments"

Returns:

String the node name

setDeploymentsNodeAbsoluteName

public void setDeploymentsNodeAbsoluteName(String name)

Sets the value of DeploymentsNodeAbsoluteName.

Parameters:

name - new value of DeploymentsNodeAbsoluteName

getCurrentDeploymentNodeName

public String getCurrentDeploymentNodeName()

Gets the name to be used for the LinkNode that will be used to link to the current deployment's configuration file. This name should be used when accessing deployment specific configurations. For example, if the value of CurrentDeploymentNodeName were "CurrentDeployment" one would reference values in the current deployment like:
{/deployment/deployments/CurrentDeployment$PropertyName}
or
{/deployment/deployments/CurrentDeployment/subconfiguration$PropertyName}

Returns:

String

setCurrentDeploymentNodeName

public void setCurrentDeploymentNodeName(String name)

Sets the value of CurrentDeploymentNodeName.

Parameters:

name - new value of CurrentDeploymentNodeName

getEnvironmentName

public String getEnvironmentName()

Returns the name of the environment.

Returns:

name of the environment

setEnvironmentName

public void setEnvironmentName(String name)

Sets the name of the environment.

Parameters:

name - the name of the environment

getInstanceName

public String getInstanceName()

Returns the name of the instance.

Returns:

the name of the instance

setInstanceName

public void setInstanceName(String name)

Sets the name of the instance.

Parameters:

name - the name of the instance

getEnvironmentNameLookup

public NameLookup getEnvironmentNameLookup()

setEnvironmentNameLookup

public void setEnvironmentNameLookup(NameLookup environmentNameLookup)

getInstanceNameLookup

public NameLookup getInstanceNameLookup()

setInstanceNameLookup

public void setInstanceNameLookup(NameLookup instanceNameLookup)