Skip navigation links
A B C D E F G H I L M N O P R S T V W 

A

addConfigurationHandlerForObject(String, Object) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
addSingleCategoryTagData(SingleCategoryTagData, AgentInfo) - Method in class org.lsst.ccs.config.CategoryDataChain
Add a SingleCategoryTagData to the chain of existing SingleCategoryTagData.

B

buildConfigChangerMap(Class, Object) - Static method in class org.lsst.ccs.config.ConfigurationHandlerBuilder
Introspects the class for @ConfigChanger methods.
buildParameterFieldsMap(Class, Object) - Static method in class org.lsst.ccs.config.ConfigurationHandlerBuilder
Introspect the class for @ConfigurationParameter fields.
BulkSettingException - Exception in org.lsst.ccs.config
An exception occurring during the setting step of a bulk change.
BulkSettingException(String) - Constructor for exception org.lsst.ccs.config.BulkSettingException
 
BulkSettingException(Throwable) - Constructor for exception org.lsst.ccs.config.BulkSettingException
 
BulkSettingException(String, Throwable) - Constructor for exception org.lsst.ccs.config.BulkSettingException
 
BulkValidationException - Exception in org.lsst.ccs.config
An exception occurring during the validation step of a bulk change.
BulkValidationException(Throwable) - Constructor for exception org.lsst.ccs.config.BulkValidationException
 

C

CategoryDataChain - Class in org.lsst.ccs.config
A Class to chain together SingleCategoryTagData entries for a given category.
CategoryDataChain(String) - Constructor for class org.lsst.ccs.config.CategoryDataChain
 
categoryDataChainMap - Variable in class org.lsst.ccs.config.ConfigurationLoadedData
 
CategoryHandler - Class in org.lsst.ccs.config
Handles a category of parameters.
checkAgainstConstraints(Object) - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
close() - Method in interface org.lsst.ccs.config.ConfigurationDAO
Called when the DAO is no longer used (typically at shutdown).
close() - Method in class org.lsst.ccs.config.RemoteFileServer
Close the connection to the underlying FileSystem.
commitBulkChange(ConfigurationDescription) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
This commit operation should operate under the control of a configuration lock.
commitBulkChange(ConfigurationDescription, String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
compareTo(ConfigurationParameterHandler) - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
ConfigurationBulkChangeHandler - Interface in org.lsst.ccs.config
An interface that gives a component more control on how to validate / set a bulk change of configuration parameters.
ConfigurationDAO - Interface in org.lsst.ccs.config
DAO interface to configuration data.
ConfigurationHandler - Class in org.lsst.ccs.config
Encapsulates the logic of setting configurable parameters for a given component.
ConfigurationHandlerBuilder - Class in org.lsst.ccs.config
Builder for ComponentConfigurationHandler objects.
ConfigurationHandlerSet - Class in org.lsst.ccs.config
A set of several ConfigurationHandlers.
ConfigurationHandlerSet(boolean, boolean) - Constructor for class org.lsst.ccs.config.ConfigurationHandlerSet
 
ConfigurationHandlerSet() - Constructor for class org.lsst.ccs.config.ConfigurationHandlerSet
 
ConfigurationHandlerSet.CollectionDataChainProcessor - Class in org.lsst.ccs.config
 
ConfigurationLoadedData - Class in org.lsst.ccs.config
A class containing the loaded configuration data.
ConfigurationLoadedData() - Constructor for class org.lsst.ccs.config.ConfigurationLoadedData
 
ConfigurationParameterDataChainProcessor - Interface in org.lsst.ccs.config
A class meant to process a stack of parameter values, as defined when loading multiple tags, and return a single parameter value.
ConfigurationParameterDescription - Class in org.lsst.ccs.config
A configuration parameter description class.
ConfigurationParameterDescription() - Constructor for class org.lsst.ccs.config.ConfigurationParameterDescription
 
ConfigurationParameterHandler - Class in org.lsst.ccs.config
 
ConfigurationParameterTaggedValue - Class in org.lsst.ccs.config
A class that matches the value of a configuration parameter with the SingleCategoryTag from which it originated.
ConfigurationParameterTaggedValue(String, String, SingleCategoryTag) - Constructor for class org.lsst.ccs.config.ConfigurationParameterTaggedValue
 
ConfigurationServiceException - Exception in org.lsst.ccs.config
Exception standing for issues accessing the configuration service.
ConfigurationServiceException(String, Throwable) - Constructor for exception org.lsst.ccs.config.ConfigurationServiceException
 
ConfigurationView - Class in org.lsst.ccs.config
A view of the configuration parameters values, ordered by the component they belong to.
ConfigurationView() - Constructor for class org.lsst.ccs.config.ConfigurationView
 
ConfigurationView(ConfigurationView) - Constructor for class org.lsst.ccs.config.ConfigurationView
 
ConfigurationView(ConfigurationDescription) - Constructor for class org.lsst.ccs.config.ConfigurationView
 
ConfigurationView(SingleCategoryTagData) - Constructor for class org.lsst.ccs.config.ConfigurationView
 
containsPath(ParameterPath) - Method in class org.lsst.ccs.config.ConfigurationView
 
convert(String) - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 

D

diff(ConfigurationView) - Method in class org.lsst.ccs.config.ConfigurationView
Performs a diff view between this view and the one passed as argument.
dropAllSubmittedChanges() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
dropSubmittedChangesForCategories(Set<String>) - Method in class org.lsst.ccs.config.ConfigurationHandler
 
dropSubmittedChangesForCategories(Set<String>) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
dropSubmittedChangesForComponent(String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 

E

exists(Path) - Method in class org.lsst.ccs.config.RemoteFileServer
Check if a file exists in the remote file server

F

fullDataString() - Method in class org.lsst.ccs.config.SingleCategoryTagData
Dump the content of this object in a String.

G

getAllSubmittedChanges() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getAsParameterPathMap() - Method in class org.lsst.ccs.config.ConfigurationView
 
getAsProperties() - Method in class org.lsst.ccs.config.ConfigurationView
 
getBufferedWriter(Path, OpenOption...) - Method in class org.lsst.ccs.config.RemoteFileServer
Get an BufferedWriter for writing data for a given Path and OpenOptions.
getCategories() - Method in class org.lsst.ccs.config.ConfigurationLoadedData
 
getCategory() - Method in class org.lsst.ccs.config.CategoryDataChain
Get the category for this CategoryDataChain.
getCategory() - Method in class org.lsst.ccs.config.CategoryHandler
 
getCategory() - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
getCategory() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
getCategoryHandler(String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getCategorySet() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getCommentParameter(String) - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
getConditionParameter(String) - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
getConfigChangerMethod() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
getConfigurableComponents() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getConfigurationData() - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
getConfigurationDataForAgent(AgentInfo) - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
getConfigurationDescription() - Method in class org.lsst.ccs.config.ConfigurationLoadedData
 
getConfigurationDescription() - Method in class org.lsst.ccs.config.ConfigurationView
 
getConfigurationHandlerForGroovy(String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getConfigurationParameterDescription(String) - Method in interface org.lsst.ccs.config.HasConfigurationParameterDescription
Get a custom ConfigurationParameterDescription for the specified parameter name.
getConfigurationParameterHandler(String) - Method in class org.lsst.ccs.config.CategoryHandler
 
getConfigurationParameterHandler(String) - Method in class org.lsst.ccs.config.ConfigurationHandler
 
getConfigurationParameterHandler(ParameterPath) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getConfigurationParameterTaggedValues() - Method in class org.lsst.ccs.config.CategoryDataChain
Get a copy of the ConfiguraiontParameterTaggedValue map.
getConfigurationParameterValueList(String) - Method in class org.lsst.ccs.config.CategoryDataChain
For a given parameter path get the List of the ConfigurationParameterTaggedValues as defined in the data chain.
getConfigurationView(Map<String, ConfigurationParameterDataChainProcessor>) - Method in class org.lsst.ccs.config.ConfigurationLoadedData
 
getCurrentValuesForComponent(String, Set<String>) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
Returns a live map of the values of the configurable parameters for the given component.
getDataChainProcessor(String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getDataChainProcessorsMap() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getDataPoviderInfoList() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getDescription() - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
getFileSystem() - Method in class org.lsst.ccs.config.RemoteFileServer
Get the underlying FileSystem.
getInputStream(Path, OpenOption...) - Method in class org.lsst.ccs.config.RemoteFileServer
Get an InputStream for reading data for a given Path and OpenOptions.
getInputStream(String) - Method in class org.lsst.ccs.config.WriterProvider
 
getInstance() - Static method in class org.lsst.ccs.config.WriterProvider
 
getLiveConfigurationView() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getLoadedDataForCategory(String) - Method in class org.lsst.ccs.config.ConfigurationLoadedData
 
getName() - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
getOutputStream(Path, OpenOption...) - Method in class org.lsst.ccs.config.RemoteFileServer
Get an OutputStream for writing data for a given Path and OpenOptions.
getParameterCategory() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet.CollectionDataChainProcessor
 
getParameterCategory() - Method in interface org.lsst.ccs.config.ConfigurationParameterDataChainProcessor
The parameter category.
getParameterPath() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet.CollectionDataChainProcessor
 
getParameterPath() - Method in interface org.lsst.ccs.config.ConfigurationParameterDataChainProcessor
The parameter path.
getParameterPath() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
getParameterPath() - Method in class org.lsst.ccs.config.ConfigurationParameterTaggedValue
 
getParameters() - Method in class org.lsst.ccs.config.CategoryHandler
 
getParameterSet(String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getParameterType() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
getParameterValue() - Method in class org.lsst.ccs.config.ConfigurationParameterTaggedValue
 
getPathValue(ParameterPath) - Method in class org.lsst.ccs.config.ConfigurationView
 
getPrintWriter(String) - Method in class org.lsst.ccs.config.WriterProvider
 
getProperties(String) - Method in class org.lsst.ccs.config.WriterProvider
 
getSingleCategoryTag() - Method in class org.lsst.ccs.config.ConfigurationParameterTaggedValue
 
getSingleCategoryTag() - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
getSingleCategoryTagData(SingleCategoryTag) - Method in class org.lsst.ccs.config.CategoryDataChain
 
getSingleCategoryTagList() - Method in class org.lsst.ccs.config.CategoryDataChain
 
getSubmittedChangesForCategories(Set<String>) - Method in class org.lsst.ccs.config.ConfigurationHandler
 
getSubmittedChangesForCategories(Set<String>) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getSubmittedChangesForComponent(String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
getTopMostCategoryTag() - Method in class org.lsst.ccs.config.CategoryDataChain
 
getUnits() - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
getUnits() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
getValuesForComponent(String) - Method in class org.lsst.ccs.config.ConfigurationView
 

H

hasConfigChangerMethod() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
HasConfigurationParameterDescription - Interface in org.lsst.ccs.config
Interface to be implemented by classes that wish to overwrite the configuration parameter description as specified by the ConfigurationParameter annotation.
hasRuntimeParameters() - Method in class org.lsst.ccs.config.ConfigurationHandler
 
hasSubmittedChanges() - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 

I

initialize(String, String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
initialize(String, ConfigurationView, String, boolean, boolean) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
IS_CONFIG_DUAL - Static variable in class org.lsst.ccs.config.PackCst
Set to true in agent properties for agents that which to fully interact with the remote configuration service.
IS_CONFIG_REMOTE - Static variable in class org.lsst.ccs.config.PackCst
Set to true in agent properties for agents that which to fully interact with the remote configuration service.
isBuild() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
isBuildParameter(String, String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
isBulkChanger() - Method in class org.lsst.ccs.config.ConfigurationHandler
 
isCollection() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
Is this configuration parameter a Collection?
isEmpty() - Method in class org.lsst.ccs.config.ConfigurationView
 
isEnabled() - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
isFinal() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 
isFinalParameter(String, String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
isParameterConfigurable(String, String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
isParameterReadOnly(String, String) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
isReadOnly() - Method in class org.lsst.ccs.config.ConfigurationParameterHandler
 

L

load(InputStream) - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
loadCategories(ConfigurationView) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
loadCategories(ConfigurationView, boolean) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
loadCategoryTag(SingleCategoryTag) - Method in interface org.lsst.ccs.config.ConfigurationDAO
Load the configuration data for a SingleCategoryTag.

M

mergeSingleCategoryTagData(SingleCategoryTagData) - Method in class org.lsst.ccs.config.SingleCategoryTagData
 

N

needsSaving() - Method in class org.lsst.ccs.config.CategoryDataChain
 
needsSaving() - Method in class org.lsst.ccs.config.SingleCategoryTagData
 

O

org.lsst.ccs.config - package org.lsst.ccs.config
Classes responsible for managing the configuration of a subsystem.

P

PackCst - Class in org.lsst.ccs.config
Constants for this package.
printProperty(String, String) - Method in class org.lsst.ccs.config.PropertiesPrintWriter
 
processDataChain(List<String>) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet.CollectionDataChainProcessor
 
processDataChain(List<String>) - Method in interface org.lsst.ccs.config.ConfigurationParameterDataChainProcessor
Process a List of values and return the String representation.
processDataChainToObject(List<String>) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet.CollectionDataChainProcessor
 
processDataChainToObject(List<String>) - Method in interface org.lsst.ccs.config.ConfigurationParameterDataChainProcessor
Process a List of values and return the corresponding Object.
PropertiesPrintWriter - Class in org.lsst.ccs.config
a PrintWriter dedicated to writing properties files.
PropertiesPrintWriter(String, String) - Constructor for class org.lsst.ccs.config.PropertiesPrintWriter
 
putAll(ConfigurationView) - Method in class org.lsst.ccs.config.ConfigurationView
 
putCategoryDataChain(CategoryDataChain) - Method in class org.lsst.ccs.config.ConfigurationLoadedData
 
putConfigurationLoadedData(ConfigurationLoadedData) - Method in class org.lsst.ccs.config.ConfigurationLoadedData
 
putParameterValue(String, String) - Method in class org.lsst.ccs.config.ConfigurationView
 
putParameterValue(String, String, String) - Method in class org.lsst.ccs.config.ConfigurationView
 
putValuesForComponent(String, Map<String, String>) - Method in class org.lsst.ccs.config.ConfigurationView
 

R

RemoteFileServer - Class in org.lsst.ccs.config
A wrapper class to grant access to a remote FileSystem.
RemoteFileServer(String, String) - Constructor for class org.lsst.ccs.config.RemoteFileServer
Create an instance of a remote file server with a given cache name.The cache name will be used as the mount point for a local cache.
RemoteFileServer(String, String, Properties) - Constructor for class org.lsst.ccs.config.RemoteFileServer
 
removeConfigurationParameter(String) - Method in class org.lsst.ccs.config.SingleCategoryTagData
 
removeValueForPath(ParameterPath) - Method in class org.lsst.ccs.config.ConfigurationView
 
REQUIRE_COMPLETE_CONFIGURATIONS - Static variable in class org.lsst.ccs.config.PackCst
Set to true if configuration files must be complete in order to be loadable.

S

saveCategoryTagData(SingleCategoryTagData) - Method in interface org.lsst.ccs.config.ConfigurationDAO
Save the data included in the provided SingleCategoryTag object.
setConfigurationDescription(ConfigurationDescription) - Method in class org.lsst.ccs.config.ConfigurationView
 
setParameterBulk(Map<String, Object>) - Method in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler
Set one or more configuration parameters to a new value.
setSingleParameter(String, String, Object) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
setSingleParameter(String, String, Object, boolean) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
SingleCategoryTagData - Class in org.lsst.ccs.config
A Class containing data for a single Configuration Category Tag.
SingleCategoryTagData(SingleCategoryTag) - Constructor for class org.lsst.ccs.config.SingleCategoryTagData
 
SingleCategoryTagData(SingleCategoryTagData) - Constructor for class org.lsst.ccs.config.SingleCategoryTagData
 
submitChange(String, String, Object, boolean) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 
submitChange(String, String, Object) - Method in class org.lsst.ccs.config.ConfigurationHandlerSet
 

T

toString() - Method in class org.lsst.ccs.config.ConfigurationParameterTaggedValue
 

V

validateBulkChange(Map<String, Object>) - Method in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler
Validate a set of proposed changes of configuration parameters of this component.

W

withCategory(String) - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
withDescription(String) - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
withIsEnabled(boolean) - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
withName(String) - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
withUnits(String) - Method in class org.lsst.ccs.config.ConfigurationParameterDescription
 
WriterProvider - Class in org.lsst.ccs.config
Generic interface for writing, reading and finding properties files against a pattern.
WriterProvider() - Constructor for class org.lsst.ccs.config.WriterProvider
 
A B C D E F G H I L M N O P R S T V W 
Skip navigation links

Copyright © 2023 LSST. All rights reserved.