org.lsst.ccs.startup

Class BootUtils

java.lang.Object

org.lsst.ccs.startup.BootUtils

public class BootUtils
extends Object

A collection of static utilities linked to boot operations. Note that:

• a descriptive node represents a configuration description
• an effective node is the real subsystem and module hierarchy (ready to run)
• a "raw" subsystem is without configuration data

Author:

bamade

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BootUtils.LocalBootObject Very important class: when an instance is created you can have : a descriptive Node the names of subsystem, configuration, tag the corresponding Effective Node a Subsystem ready to run (but not started)

Constructor Summary

Constructors

Constructor and Description
BootUtils()

Method Summary

Modifier and Type	Method and Description
static void	bootFromCache()
static void	checkStaticCompatibleConfiguration(org.lsst.ccs.config.ConfigProfile profile) to be invoked before registering a ConfigProfile which is not meant to be used for changing values at runtime.
static org.lsst.gruth.jutils.DescriptiveNode	getDescriptiveNode(String pathName) gets a descriptive node from a file
static org.lsst.gruth.jutils.EffectiveNode	getEffectiveNode(org.lsst.gruth.jutils.DescriptiveNode descriptionNode) gets an effective node from a description node
static org.lsst.gruth.jutils.EffectiveNode	getEffectiveNodeFromFile(String pathName) gets an effective node from a file
static org.lsst.gruth.jutils.DescriptiveNode	getLatestInCache()
static Subsystem	getRawSubsystemFromEffectiveNode(org.lsst.gruth.jutils.EffectiveNode effectiveNode, org.lsst.ccs.config.ConfigProfile profile, String subsystemName, String configName, String tag, ConfigurationProxy confProxy)
static Subsystem	getSubsystemFromFile(String pathName)
static Subsystem	getSubsystemFromFile(String pathName, String propertiesFileName)
static Subsystem	getSubsystemFromFile(String pathName, String propertiesFileName, String subsystemAlias)
static Subsystem	rawSubsystemFromDescriptionNode(org.lsst.gruth.jutils.DescriptiveNode descriptionNode, org.lsst.ccs.config.ConfigProfile profile, String subsystemName, String configName, String tag, ConfigurationProxy confProxy)
static void	saveInCache(org.lsst.gruth.jutils.DescriptiveNode node, String subsystemName, String configName, String tag) saves the latest run configuration in a local cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

BootUtils

public BootUtils()

Method Detail

getDescriptiveNode

public static org.lsst.gruth.jutils.DescriptiveNode getDescriptiveNode(String pathName)
                                                                throws Exception

gets a descriptive node from a file

Parameters:

pathName -

Returns:

Throws:

Exception

getEffectiveNode

public static org.lsst.gruth.jutils.EffectiveNode getEffectiveNode(org.lsst.gruth.jutils.DescriptiveNode descriptionNode)
                                                            throws InvocationTargetException,
                                                                   NoSuchMethodException,
                                                                   IllegalAccessException

gets an effective node from a description node

Parameters:

descriptionNode -

Returns:

Throws:

InvocationTargetException

NoSuchMethodException

IllegalAccessException

getEffectiveNodeFromFile

public static org.lsst.gruth.jutils.EffectiveNode getEffectiveNodeFromFile(String pathName)
                                                                    throws Exception

gets an effective node from a file

Parameters:

pathName -

Returns:

Throws:

Exception

getRawSubsystemFromEffectiveNode

public static Subsystem getRawSubsystemFromEffectiveNode(org.lsst.gruth.jutils.EffectiveNode effectiveNode,
                                                         org.lsst.ccs.config.ConfigProfile profile,
                                                         String subsystemName,
                                                         String configName,
                                                         String tag,
                                                         ConfigurationProxy confProxy)

rawSubsystemFromDescriptionNode

public static Subsystem rawSubsystemFromDescriptionNode(org.lsst.gruth.jutils.DescriptiveNode descriptionNode,
                                                        org.lsst.ccs.config.ConfigProfile profile,
                                                        String subsystemName,
                                                        String configName,
                                                        String tag,
                                                        ConfigurationProxy confProxy)
                                                 throws Exception

Throws:

Exception

getSubsystemFromFile

public static Subsystem getSubsystemFromFile(String pathName)
                                      throws Exception

Throws:

Exception

getSubsystemFromFile

public static Subsystem getSubsystemFromFile(String pathName,
                                             String propertiesFileName)
                                      throws Exception

Throws:

Exception

getSubsystemFromFile

public static Subsystem getSubsystemFromFile(String pathName,
                                             String propertiesFileName,
                                             String subsystemAlias)
                                      throws Exception

Throws:

Exception

saveInCache

public static void saveInCache(org.lsst.gruth.jutils.DescriptiveNode node,
                               String subsystemName,
                               String configName,
                               String tag)

saves the latest run configuration in a local cache. This is saved in a file (see naming convention handled by baseNameFromNames that will reside in tha cache directory. The name of this file will be reported in another text file in this directory named "latest.txt".

TODO: The path of the cache directory is to be determined.

Parameters:

node -

subsystemName -

configName -

tag -

getLatestInCache

public static org.lsst.gruth.jutils.DescriptiveNode getLatestInCache()

bootFromCache

public static void bootFromCache()

checkStaticCompatibleConfiguration

public static void checkStaticCompatibleConfiguration(org.lsst.ccs.config.ConfigProfile profile)
                                               throws Exception

to be invoked before registering a ConfigProfile which is not meant to be used for changing values at runtime. This method creates a real dummy EffectiveNode to check for properties that have preconditions. This means that objects created this way should not affect the hardwares.

Parameters:

profile -

Throws:

Exception