org.lsst.ccs.bus.data

Class ConfigurationInfo

java.lang.Object

org.lsst.ccs.bus.data.ConfigurationInfo

All Implemented Interfaces:

Serializable

public final class ConfigurationInfo
extends Object
implements Serializable

A Class containing the Agent's configuration information.

Author:

The LSST CCS Team

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationInfo.Builder A builder for a {

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VERSION
static int	LATEST_VERSION
static int	UNDEF_VERSION

Constructor Summary

Constructors

Constructor and Description
ConfigurationInfo()

Method Summary

Modifier and Type	Method and Description
List<ConfigurationParameterInfo>	diff(ConfigurationInfo ci) Get the list of ConfigurationParameterInfo object whose value has changed between the old and the new ConfigurationInfo.
List<ConfigurationParameterInfo>	getAllParameterInfo() Returns a list of ConfigurationParameterInfo.
Set<String>	getCategorySet()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getCCSTimeStamp() Get the CCSTimeStamp of when this object was created.
String	getConfigNameForCategory(String category)
String	getConfigurationDescription() Get the String representation of the Configuration Description.
String	getConfigurationName() Deprecated. use getConfigurationDescription instead
ConfigurationState	getConfigurationState()
Integer	getConfigVersion(String cat)
ConfigurationParameterInfo	getCurrentParameterInfo(String pathName) Return the ConfigurationParameterInfo of a given configurable parameter
Map<String,ConfigurationParameterInfo>	getCurrentParameterInfoFor(String componentName) Returns the ConfigurationParameterInfo of each parameter that belongs to the specified configurable component.
Map<String,ConfigurationParameterInfo>	getCurrentParameterInfoForCategory(String category) Returns the current ConfigurationParameterInfo of each parameter that belong to the specified category.
String	getCurrentValueForParameter(String pathName) Return the current value of a given configurable parameter
Map<String,String>	getCurrentValuesFor(String componentName) Returns the current value of each parameter that belong to the specified configurable component.
Map<String,String>	getCurrentValuesForCategory(String category) Returns the current value of each parameter that belong to the specified category.
String	getDescriptionName() Returns the subsystem description name, ie the name of the description file the subsystem is started with.
String	getGlobalName()
List<ConfigurationParameterInfo>	getLatestChanges() Returns a list of the last changes that occurred since the previous ConfigurationInfo publication.
static Map<String,List<ConfigurationParameterInfo>>	getParameterInfoGroupByCategory(List<ConfigurationParameterInfo> parmList) Groups the ConfigurationParameterInfo objects of the input list by the category they belong to.
static Map<String,List<ConfigurationParameterInfo>>	getParameterInfoGroupByComponent(List<ConfigurationParameterInfo> parmList) Groups the ConfigurationParameterInfo objects of the input list by the component they belong to.
String	getTaggedCategories() Returns the String representation of the categories.
boolean	hasCategory(String category) Tests if category is one of the subsystem parameter categories.
boolean	hasChanges()
boolean	hasChangesForCategory(String category) Returns true if there are unsaved changes for the specified category.
void	setConfigurationState(ConfigurationState state)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final int DEFAULT_VERSION

See Also:

Constant Field Values

LATEST_VERSION

public static final int LATEST_VERSION

See Also:

Constant Field Values

UNDEF_VERSION

public static final int UNDEF_VERSION

See Also:

Constant Field Values

Constructor Detail

ConfigurationInfo

public ConfigurationInfo()

Method Detail

getDescriptionName

public String getDescriptionName()

Returns the subsystem description name, ie the name of the description file the subsystem is started with.

Returns:

the subsystem description name

getCCSTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getCCSTimeStamp()

Get the CCSTimeStamp of when this object was created.

Returns:

The CCSTimeStamp when this object was created.

getConfigurationDescription

public String getConfigurationDescription()

Get the String representation of the Configuration Description. It contains all the categories/tags/versions for the current configuration.

Returns:

getConfigurationName

@Deprecated
public String getConfigurationName()

Deprecated. use getConfigurationDescription instead

Returns:

the String representation of the configuration state

getGlobalName

public String getGlobalName()

getTaggedCategories

public String getTaggedCategories()

Returns the String representation of the categories. ex : "catA:A1,catB:B2*,def4"

Returns:

the string representation of the categories.

hasChangesForCategory

public boolean hasChangesForCategory(String category)

Returns true if there are unsaved changes for the specified category.

Parameters:

category -

Returns:

true if there are unsaved changes for the specified category, false otherwise.

hasChanges

public boolean hasChanges()

Returns:

true if there are no unsaved changes for all categories.

getConfigNameForCategory

public String getConfigNameForCategory(String category)

Parameters:

category -

Returns:

the base configuration name for the specified category.

getConfigVersion

public Integer getConfigVersion(String cat)

Parameters:

cat -

Returns:

the version of the configuration applied to the given category.

hasCategory

public boolean hasCategory(String category)

Tests if category is one of the subsystem parameter categories.

Parameters:

category -

Returns:

true if category is one of the parameter categories of the subsystem.

getCategorySet

public Set<String> getCategorySet()

Returns:

the set of categories the configurable parameters of this {

getConfigurationState

public ConfigurationState getConfigurationState()

Returns:

the configuration state

setConfigurationState

public void setConfigurationState(ConfigurationState state)

toString

public String toString()

Overrides:

toString in class Object

Returns:

a String representation of the {

getAllParameterInfo

public List<ConfigurationParameterInfo> getAllParameterInfo()

Returns a list of ConfigurationParameterInfo. Each element of this list represents the current view of a configurable parameter.

Returns:

a List of ConfigurationParameterInfo

getCurrentParameterInfo

public ConfigurationParameterInfo getCurrentParameterInfo(String pathName)

Return the ConfigurationParameterInfo of a given configurable parameter

Parameters:

pathName - the path name of a parameter, ie moduleName/parameterName, old format moduleName//parameterName is still supported but should be replaced)

Returns:

the ConfigurationParameterInfo for the provided path.

getCurrentParameterInfoForCategory

public Map<String,ConfigurationParameterInfo> getCurrentParameterInfoForCategory(String category)

Returns the current ConfigurationParameterInfo of each parameter that belong to the specified category.

Parameters:

category -

Returns:

a Map of pathName and the corresponding ConfigurationParameterInfo.

getCurrentParameterInfoFor

public Map<String,ConfigurationParameterInfo> getCurrentParameterInfoFor(String componentName)

Returns the ConfigurationParameterInfo of each parameter that belongs to the specified configurable component.

Parameters:

componentName - the name of the component

Returns:

a Map of parameter names and corresponding ConfigurationParameterInfo.

diff

public List<ConfigurationParameterInfo> diff(ConfigurationInfo ci)

Get the list of ConfigurationParameterInfo object whose value has changed between the old and the new ConfigurationInfo. The returned ConfigurationParameterInfo objects belong to the new ConfigurationParameterInfo.

Parameters:

ci - The ConfigurationInfo object from which we want to calculate the difference

Returns:

The List of ConfigurationParameterInfo objects that have changed.

getLatestChanges

public List<ConfigurationParameterInfo> getLatestChanges()

Returns a list of the last changes that occurred since the previous ConfigurationInfo publication.

• If a single change is processed, the returned list contains this change only.
• If a bulk change is processed, the returned list contains all the changes that have been submitted, validated and successfully set during this bulk change session.

Returns:

the list of recent changes.

getCurrentValuesForCategory

public Map<String,String> getCurrentValuesForCategory(String category)

Returns the current value of each parameter that belong to the specified category.

Parameters:

category -

Returns:

a Map of parameter pathName and their current value.

getCurrentValuesFor

public Map<String,String> getCurrentValuesFor(String componentName)

Returns the current value of each parameter that belong to the specified configurable component.

Parameters:

componentName - the name of the component

Returns:

a Map of parameter names to their current value.

getCurrentValueForParameter

public String getCurrentValueForParameter(String pathName)

Return the current value of a given configurable parameter

Parameters:

pathName - the path name of a parameter, ie moduleName/parameterName, old format moduleName//parameterName is still supported but should be replaced)

Returns:

a String representation of the parameter's value

getParameterInfoGroupByComponent

public static Map<String,List<ConfigurationParameterInfo>> getParameterInfoGroupByComponent(List<ConfigurationParameterInfo> parmList)

Groups the ConfigurationParameterInfo objects of the input list by the component they belong to.

Parameters:

parmList -

Returns:

a Map of component name to the list of their parameters.

getParameterInfoGroupByCategory

public static Map<String,List<ConfigurationParameterInfo>> getParameterInfoGroupByCategory(List<ConfigurationParameterInfo> parmList)

Groups the ConfigurationParameterInfo objects of the input list by the category they belong to.

Parameters:

parmList -

Returns:

a Map of category names to the list of parameters that belong to this category.