org.lsst.ccs.framework

Interface Configurable

All Superinterfaces:

ConfigurationBulkChangeHandler, HasLifecycle, UsesSubsystem

All Known Implementing Classes:

ConfigurableComponent, Module

Deprecated.

@Deprecated
public interface Configurable
extends ConfigurationBulkChangeHandler, HasLifecycle, UsesSubsystem

This interface is implemented by Objects that have access to current configuration service and to Component lookup Service.

It is mandatory that these objects are referenced and named in the description file when used.

Author:

bamade

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Configurable.Environment Deprecated. Use ComponentConfigurationEnvironment instead

Method Summary

Modifier and Type	Method and Description
default void	change(String parameterName, Object value) Deprecated.
default void	dropSubmittedChanges() Deprecated.
default <T> LinkedHashMap<String,T>	getChildren(Class<T> clazz) Deprecated. use getComponentLookup() from Subsystem instead
default Object	getComponentByName(String name) Deprecated. use getComponentLookup() from Subsystem instead
default Configurable.Environment	getEnvironment() Deprecated. Implement interface UsesSubsystem and use method ComponentConfigurationEnvironment getComponentConfigurationEnvironment() instead
default Map.Entry<String,Object>	getParent() Deprecated. use getComponentLookup() from Subsystem instead
default Object	getParentObject() Deprecated. use getComponentLookup() from Subsystem instead
default Map<String,String>	getSubmittedChanges() Deprecated.
default void	init() Deprecated. Use methods on HasLifecycle instead
default Boolean	isParameterConfigurable(String parameterName) Deprecated.
default void	postStart() Deprecated. Use methods on HasLifecycle instead
default Map<String,String>	printConfigurableParameters(String... categories) Deprecated.
default Map<String,Object>	setBulkParameter(Map<String,Object> parametersView) Deprecated. Use methods on ConfigurationBulkChangeHandler instead
default void	shutdownNow() Deprecated. Use methods on HasLifecycle instead
default void	start() Deprecated. Use methods on HasLifecycle instead
default void	submitChange(String parameterName, Object value) Deprecated.
default void	submitChanges(Map<String,Object> values) Deprecated.
default void	validateBulkChange(Map<String,Object> parametersView) Deprecated. Use methods on ConfigurationBulkChangeHandler instead

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Method Detail

getEnvironment

@Deprecated
default Configurable.Environment getEnvironment()

Deprecated. Implement interface UsesSubsystem and use method ComponentConfigurationEnvironment getComponentConfigurationEnvironment() instead

Get the Environment for this Configurable.

Returns:

the Environment for this Configurable.

getComponentByName

@Deprecated
default Object getComponentByName(String name)

Deprecated. use getComponentLookup() from Subsystem instead

Request for a component that bears the specified name.

Parameters:

name -

Returns:

a component that bears this name

getChildren

@Deprecated
default <T> LinkedHashMap<String,T> getChildren(Class<T> clazz)

Deprecated. use getComponentLookup() from Subsystem instead

return a map of children that are "assignable to" the argument class.

Type Parameters:

T -

Parameters:

clazz - could be an interface (or even Object.class)

Returns:

a map of children that are assignable to the argument class.

getParentObject

@Deprecated
default Object getParentObject()

Deprecated. use getComponentLookup() from Subsystem instead

Returns:

parent object or null if the current Configurable is the main

getParent

@Deprecated
default Map.Entry<String,Object> getParent()

Deprecated. use getComponentLookup() from Subsystem instead

Returns name and value of the parent object. The top component has a parent named "_EDEN_" and with value null

Returns:

name and value of the parent object

change

@Deprecated
 @Command(description="engineering mode change of parameter value",
         type=CONFIGURATION)
default void change(@Argument(name="parameterName",description="Configuration parameter name")
                                                                                                                                 String parameterName,
                                                                                                                                 @Argument(name="value",description="Configuration parameter value")
                                                                                                                                 Object value)

Deprecated.

Implementation of this method should be annotated as

  @Command(description = "engineering mode change of parameter value", type = CommandType.CONFIGURATION)
 

Parameters:

parameterName - the name of the parameter to change

value - the value to affect to this parameter

submitChange

@Deprecated
 @Command(description="submit a potential change for a parameter",
         type=CONFIGURATION)
default void submitChange(@Argument(name="parameterName",description="Configuration parameter name")
                                                                                                                                      String parameterName,
                                                                                                                                      @Argument(name="value",description="Configuration parameter value")
                                                                                                                                      Object value)

Deprecated.

Submit a change for a parameter. The change will be effective once commitChange is issued.

Parameters:

parameterName - the name of the parameter

value - the new value to submit for this parameter

submitChanges

@Deprecated
 @Command(description="submit potential changes for parameters",
         type=CONFIGURATION)
default void submitChanges(Map<String,Object> values)

Deprecated.

Submit a collection of changes. If one submission fails all preceding submissions are dropped. The changes will be validated and set when issuing Subsystem.commitBulkChange()

Parameters:

values - a map of parameter name and the new value to submit for this parameter

printConfigurableParameters

@Deprecated
 @Command(description="displays the current values of the parameters that belong to the given categories",
         type=CONFIGURATION)
default Map<String,String> printConfigurableParameters(String... categories)

Deprecated.

getSubmittedChanges

@Deprecated
 @Command(description="prints the current state of the submitted changes",
         type=CONFIGURATION)
default Map<String,String> getSubmittedChanges()

Deprecated.

dropSubmittedChanges

@Deprecated
 @Command(description="drops the submitted changes for this component",
         type=CONFIGURATION)
default void dropSubmittedChanges()

Deprecated.

isParameterConfigurable

@Deprecated
default Boolean isParameterConfigurable(String parameterName)

Deprecated.

init

@Deprecated
default void init()

Deprecated. Use methods on HasLifecycle instead

Description copied from interface: HasLifecycle

This method is called from the top level Subsystem during the initialization phase.

Specified by:

init in interface HasLifecycle

start

@Deprecated
default void start()

Deprecated. Use methods on HasLifecycle instead

Description copied from interface: HasLifecycle

This method is called from the top level Subsystem when it is being started.

Specified by:

start in interface HasLifecycle

postStart

@Deprecated
default void postStart()
                            throws HardwareException

Deprecated. Use methods on HasLifecycle instead

Description copied from interface: HasLifecycle

once all hardware components have been started this method is invoked. it notifies all component that now the subsystem is going to end initialization phase that could be the place to start ticks (module) or to "home" hardwares (that's the reason why this method throws a HardwareException) TO-DO: Does this really need to throw a HardwareException? Don't we have other Hardware specific interfaces?

Specified by:

postStart in interface HasLifecycle

Throws:

HardwareException

shutdownNow

@Deprecated
default void shutdownNow()

Deprecated. Use methods on HasLifecycle instead

Description copied from interface: HasLifecycle

This object is ready to perform end of life operations. (hardwares have been stopped before by stop command) TO-DO: Who stopped the hardware? See comments in postStart() method. Make sure the hardware interfaces are properly specified.

Specified by:

shutdownNow in interface HasLifecycle

validateBulkChange

@Deprecated
default void validateBulkChange(Map<String,Object> parametersView)

Deprecated. Use methods on ConfigurationBulkChangeHandler instead

Description copied from interface: ConfigurationBulkChangeHandler

Override with more advanced parameter validation checking. This method is meant to throw an exception when one or more parameters have a proposed value that is decided as not valid by the user.

Specified by:

validateBulkChange in interface ConfigurationBulkChangeHandler

Parameters:

parametersView - the whole set of parameters for this component with their value to be validated. it maps the parameter names to their value.

setBulkParameter

@Deprecated
default Map<String,Object> setBulkParameter(Map<String,Object> parametersView)

Deprecated. Use methods on ConfigurationBulkChangeHandler instead

Description copied from interface: ConfigurationBulkChangeHandler

Override with by hand setting of the parameters in parametersView

Specified by:

setBulkParameter in interface ConfigurationBulkChangeHandler

Parameters:

parametersView - a map of parameter names with the new value for this parameter

Returns:

the subset of parameters of the input map that are not handled by this method.