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

Method Summary

Modifier and Type	Method and Description
static void	bootFromCache()
static SubsystemDescription	buildSubsystemDescription(String pathName)
static DescriptiveNode	getLatestInCache()
static Subsystem	getSubsystemFromFile(String descriptionName) Builds a Subsystem instance out of a description file.
static Subsystem	getSubsystemFromFile(String descriptionName, String configName) Builds a Subsystem given a description name and an initial configuration.
static Subsystem	getSubsystemFromFile(String pathName, String propertiesFileName, String subsystemAlias) Builds a Subsystem given a description name, an initial configuration and a alias.
static void	saveInCache(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

Method Detail

getSubsystemFromFile

public static Subsystem getSubsystemFromFile(String descriptionName)
                                      throws Exception

Builds a Subsystem instance out of a description file.

Parameters:

descriptionName -

Returns:

a subsystem ready to run.

Throws:

Exception

getSubsystemFromFile

public static Subsystem getSubsystemFromFile(String descriptionName,
                                             String configName)
                                      throws Exception

Builds a Subsystem given a description name and an initial configuration.

Parameters:

descriptionName - the name of the subsystem description

configName - the name of the configuration the subsystem is started with

Returns:

a ready to run subsystem

Throws:

Exception

getSubsystemFromFile

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

Builds a Subsystem given a description name, an initial configuration and a alias. The subsystem will be named "alias" on the buses.

Parameters:

pathName -

propertiesFileName -

subsystemAlias -

Returns:

A ready to run subsystem

Throws:

Exception

buildSubsystemDescription

public static SubsystemDescription buildSubsystemDescription(String pathName)
                                                      throws Exception

Throws:

Exception

saveInCache

public static void saveInCache(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 DescriptiveNode getLatestInCache()

bootFromCache

public static void bootFromCache()