org.figure8.join.businessfacades.environment
Interface ParameterManager

All Known Implementing Classes:

DefaultParameterManager

public interface ParameterManager

This is a sevrice interface defining methods for managing deployment parameters and their values according to the physical environment they allpy to and their deployment targets.
Implementation should define how parameter and parameter values are created, updated and retrieved.

Version:

$Revision: 1.2 $

Author:

Jerome Evrard

Method Summary

java.util.List	getAllParameters() Search all the defined parameter instances.
Parameter	getParameter(java.lang.String name) Get a parameter by its name.
ParameterValue	getParameterValue(long id) Retrieve the ParameterValue having this unique identifier
java.util.List	getParameterValues(java.lang.String environmentKey, java.lang.String targetName) Retrieve the list of current parameter values for a given environment and a given target.
void	removeParameter(Parameter parameter) Remove a parameter from datastore.
void	removeParameterValue(ParameterValue value) Remove a parameter value.
java.util.List	renderParameterValues(java.lang.String environmentKey, java.lang.String targetName) Retrieve and render the list of current parameter values for a given environment and a given target.
void	saveParameter(Parameter parameter) Save a parameter within datastore.
void	saveParameterValue(ParameterValue value) Save a parameter value wrapper within datastore.

Method Detail

saveParameter

void saveParameter(Parameter parameter)

Save a parameter within datastore.

Parameters:

parameter - The parameter to save

getAllParameters

java.util.List getAllParameters()

Search all the defined parameter instances.

Returns:

A list of org.figure8.join.businessobjects.environment.Parameter

getParameter

Parameter getParameter(java.lang.String name)

Get a parameter by its name.

Parameters:

name - The parameter name to get

Returns:

The parameter instance or null

removeParameter

void removeParameter(Parameter parameter)

Remove a parameter from datastore.

Parameters:

parameter - The parameter to remove.

saveParameterValue

void saveParameterValue(ParameterValue value)

Save a parameter value wrapper within datastore.

Parameters:

value - The parameter value to save

getParameterValues

java.util.List getParameterValues(java.lang.String environmentKey,
                                  java.lang.String targetName)

Retrieve the list of current parameter values for a given environment and a given target.

Parameters:

environmentKey - The key of the physical environment to retrieve values for

targetName - The name of the deployment target to retrieve values for

Returns:

A list of org.figure8.join.businessobjects.environment.ParameterValue

renderParameterValues

java.util.List renderParameterValues(java.lang.String environmentKey,
                                     java.lang.String targetName)

Retrieve and render the list of current parameter values for a given environment and a given target. Rendering consist in tranforming values expressed with meta-language.

Parameters:

environmentKey - The key of the physical environment to retrieve values for

targetName - The name of the deployment target to retrieve values for

Returns:

A list of org.figure8.join.businessobjects.environment.ParameterValue

getParameterValue

ParameterValue getParameterValue(long id)

Retrieve the ParameterValue having this unique identifier

Parameters:

id - The unique identifier of value ot retrieve

Returns:

The ParameterValue having this identifier or null if no one matches

removeParameterValue

void removeParameterValue(ParameterValue value)

Remove a parameter value.

Parameters:

value - The parameter value to remove.