org.lsst.ccs.config.remote

Class RestFileServerRemoteDAO

java.lang.Object

org.lsst.ccs.config.remote.RestFileServerRemoteDAO

All Implemented Interfaces:

AutoCloseable, ConfigurationDAO

public class RestFileServerRemoteDAO
extends Object
implements ConfigurationDAO

An implementation of the ConfigurationDAQ using the CCS rest file server This implementation uses the following bootstrap properties

• org.lsst.ccs.config.remote.uri -- the file server to connect to. Default: ccs://lsst-camera-dev.slac.stanford.edu/RestFileServer/
• org.lsst.ccs.config.remote.cacheOnly -- if set to true forces offline mode, where configs are read from local disk cache only

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
RestFileServerRemoteDAO(String subsystemName) Create a RestFileServer DAO.

Method Summary

Modifier and Type	Method and Description
void	close() Called when the DAO is no longer used (typically at shutdown).
boolean	hasCategoryTagData(SingleCategoryTag singleCategoryTag) Utility method to test if the DAO has data for a SingleCategoryTag.
SingleCategoryTagData	loadCategoryTag(SingleCategoryTag singleCategoryTag) Load the configuration data for a SingleCategoryTag.
SingleCategoryTag	saveCategoryTagData(SingleCategoryTagData singleCategoryTagData) Save the data included in the provided SingleCategoryTag object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestFileServerRemoteDAO

public RestFileServerRemoteDAO(String subsystemName)

Create a RestFileServer DAO. The cache name must be unique for all machines running on a node (e.g. typically it will be the CCS subsystem name).

Parameters:

subsystemName - The subsystem name, also used as the cache name

Method Detail

loadCategoryTag

public SingleCategoryTagData loadCategoryTag(SingleCategoryTag singleCategoryTag)
                                      throws ConfigurationServiceException

Description copied from interface: ConfigurationDAO

Load the configuration data for a SingleCategoryTag. The provided SingleCategoryTag could contain generic versions as: default, latest, working. It is the responsibility of the DAO to resolve this version and return it as part of the SingleCategoryTag object it returns.

Specified by:

loadCategoryTag in interface ConfigurationDAO

Parameters:

singleCategoryTag - The object describing the data to be loaded for a single category tag.

Returns:

a SingleCategoryTagData containing the loaded configuration values and the comments associated to them. This object contains a SingleCategoryTag instance to clarify the version of the data that was actually loaded.

Throws:

ConfigurationServiceException - if the data cannot be found or loaded for the given SingleCategoryTag instance.

hasCategoryTagData

public boolean hasCategoryTagData(SingleCategoryTag singleCategoryTag)

Description copied from interface: ConfigurationDAO

Utility method to test if the DAO has data for a SingleCategoryTag. This method is currently used as we migrate from implicit to explicit source definition in the configuration loading/saving operations.

Specified by:

hasCategoryTagData in interface ConfigurationDAO

Parameters:

singleCategoryTag - a SingleCategoryTag object describing the requested data.

Returns:

false if there is no data available for the provided SingleCategoryTag. true otherwise.

saveCategoryTagData

public SingleCategoryTag saveCategoryTagData(SingleCategoryTagData singleCategoryTagData)
                                      throws ConfigurationServiceException

Description copied from interface: ConfigurationDAO

Save the data included in the provided SingleCategoryTag object. It is the responsibility of the DAO to resolve the version of the saved data and return it as part of the SingleCategoryTag object it returns.

Specified by:

saveCategoryTagData in interface ConfigurationDAO

Parameters:

singleCategoryTagData - The data to be saved; it includes the configuration parameter values and associated comments.

Returns:

a SingleCategoryTag instance containing the version in which the provided data was saved.

Throws:

ConfigurationServiceException - if the data could not be saved.

close

public void close()

Description copied from interface: ConfigurationDAO

Called when the DAO is no longer used (typically at shutdown).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ConfigurationDAO