org.lsst.ccs.subsystem.demo.main

Class DemoConfigurable

java.lang.Object

org.lsst.ccs.subsystem.demo.main.DemoConfigurable

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler

public class DemoConfigurable
extends Object
implements org.lsst.ccs.config.ConfigurationBulkChangeHandler

Example component to demonstrate how to manage configuration changes for a component.

Author:

emarin

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Integer>	currentParms
protected double	doubleValue
protected String	info Being final, this parameter can be set only via groovy or the safe configuration.
protected int	max
protected int	min A simple range defined in the annotation.
protected String	name

Constructor Summary

Constructors

Constructor and Description
DemoConfigurable()

Method Summary

Modifier and Type	Method and Description
void	setCurrentParms(Object currentParms) THIRD STEP : Single Setting.
void	setDoubleValue(double value)
void	setParameterBulk(Map<String,Object> parametersView) SECOND STEP : BULK SETTING (Optional).
void	validateBulkChange(Map<String,Object> parametersView) FIRST STEP : VALIDATION (Optional).

Methods inherited from class java.lang.Object

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

Field Detail

name

@LookupName
protected String name

info

@ConfigurationParameter(isFinal=true)
protected volatile String info

Being final, this parameter can be set only via groovy or the safe configuration. It is not part of any other configuration. The field itself should NOT be set as final.

doubleValue

@ConfigurationParameter
protected volatile double doubleValue

currentParms

@ConfigurationParameter(maxLength=-1)
protected final Map<String,Integer> currentParms

min

@ConfigurationParameter(range="0..10",
                        units="counts")
protected volatile int min

A simple range defined in the annotation. It will be checked at the validation step.

max

@ConfigurationParameter(units="counts")
protected volatile int max

Constructor Detail

DemoConfigurable

public DemoConfigurable()

Method Detail

validateBulkChange

public void validateBulkChange(Map<String,Object> parametersView)

FIRST STEP : VALIDATION (Optional). Where more advanced validation of parameters can be performed. In the following, the constraint involves two different parameters. If an exception is thrown, the configuration change is interrupted and the configuration state is guaranteed to be unchanged.

Specified by:

validateBulkChange in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

Parameters:

parametersView - a map of all parameters for that component, with values corresponding to the proposed changes

setParameterBulk

public void setParameterBulk(Map<String,Object> parametersView)

SECOND STEP : BULK SETTING (Optional). Invoked prior to any other setter method. Parameters that need to have their value modified in order to reach the requested configuration have a corresponding entry in the passed map. It is the responsibility of the subsystem developer to set the field correctly.

Specified by:

setParameterBulk in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

Parameters:

parametersView - a map of parameter name to their new value to assign.

setCurrentParms

@ConfigurationParameterChanger
public void setCurrentParms(Object currentParms)

THIRD STEP : Single Setting. using the @ConfigurationParameterChanger annotation. It is called only if the parameter wasn't already set in the setParameterBulk method. Parameters that are still not set once all @ConfigurationParameterChanger methods have been called are attempted to be set via reflection.

Parameters:

currentParms -

setDoubleValue

@ConfigurationParameterChanger
public void setDoubleValue(double value)