org.lsst.ccs.bootstrap

Class BootstrapUtils

java.lang.Object

org.lsst.ccs.bootstrap.BootstrapUtils

public abstract class BootstrapUtils
extends Object

Utility methods for the Bootstrap application.

Author:

turri

Field Summary

Fields

Modifier and Type	Field and Description
static String	CCS_RESOURCE_PATH_ENV_VAR Environment variable that defines the resource path.

Constructor Summary

Constructors

Constructor and Description
BootstrapUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static Properties	getApplicationDefinitionProperties(String application) Get the application definition properties file for a given application name.
static String	getBootstrapLibraryPath()
static List<String>	getBootstrapListOfApplications() Get the list of available applications for the current Bootstrap configuration.
static List<String>	getBootstrapListOfTransports() Get the list of available transport protocols for the current Bootstrap configuration.
static ResourcesTree	getBootstrapResourcesTree() Get the ResourceTree for this Bootstrap environment.
static String	getCCSDistributionRootDirectory() Get the root directory of the CCS distribution from which the Bootstrap code has been launched.
static String	getDistributionJarFilesDirectory() Get the jar files directory in the distribution.
static String	getDistributionJniDirectory() Get the jni directory in the distribution.
static String	getDistributionLibDirectory() Get the lib directory in the distribution.
static String	getDistributionResourcesDirectory() Get the Distribution resources directory.
static Properties	getMergedProperties(String propertyFile) Get the merged properties in the current bootstrap environment.
static List<String>	getOrderedListOfResourceDirectories() Get the ordered list of resource directories.
static Properties	getPropertiesForTransport(String transport) Get the transport definition properties file for a given transport name.

Methods inherited from class java.lang.Object

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

Field Detail

CCS_RESOURCE_PATH_ENV_VAR

public static final String CCS_RESOURCE_PATH_ENV_VAR

Environment variable that defines the resource path.

See Also:

Constant Field Values

Constructor Detail

BootstrapUtils

public BootstrapUtils()

Method Detail

getBootstrapResourcesTree

public static ResourcesTree getBootstrapResourcesTree()

Get the ResourceTree for this Bootstrap environment. It contains all the resources defined in the resource directory list.

Returns:

getOrderedListOfResourceDirectories

public static List<String> getOrderedListOfResourceDirectories()

Get the ordered list of resource directories. The built in default is: - Distribution resources directory: distribution/etc/ - System resources directory: /etc/ccs/ - User resources directory: ~/.ccs/etc/ By setting the environment variable CCS_RESOURCE_PATH, the developer can change which resource directories are searched and in which order. When the CCS_RESOURCE_PATH environment variable is set, the distribution resource directory will be still searched first, before any of the directories provided by the user. This list is built once and its result is cached.

Returns:

The list of ordered directories used to search for resources.

getDistributionResourcesDirectory

public static String getDistributionResourcesDirectory()

Get the Distribution resources directory.

Returns:

The resources directory in the distribution.

getDistributionLibDirectory

public static String getDistributionLibDirectory()

Get the lib directory in the distribution.

Returns:

the lib files directory.

getDistributionJniDirectory

public static String getDistributionJniDirectory()

Get the jni directory in the distribution.

Returns:

the jni files directory.

getDistributionJarFilesDirectory

public static String getDistributionJarFilesDirectory()

Get the jar files directory in the distribution.

Returns:

the jar files directory.

getCCSDistributionRootDirectory

public static String getCCSDistributionRootDirectory()

Get the root directory of the CCS distribution from which the Bootstrap code has been launched.

Returns:

The root directory of the CCS distribution. It ends with a file.separator.

getBootstrapListOfApplications

public static List<String> getBootstrapListOfApplications()

Get the list of available applications for the current Bootstrap configuration.

Returns:

The list of application names.

getBootstrapListOfTransports

public static List<String> getBootstrapListOfTransports()

Get the list of available transport protocols for the current Bootstrap configuration.

Returns:

The list of available transports.

getPropertiesForTransport

public static Properties getPropertiesForTransport(String transport)

Get the transport definition properties file for a given transport name.

Parameters:

transport - The name of the application.

Returns:

The Properties that define the application.

getApplicationDefinitionProperties

public static Properties getApplicationDefinitionProperties(String application)

Get the application definition properties file for a given application name.

Parameters:

application - The name of the application.

Returns:

The Properties that define the application.

getMergedProperties

public static Properties getMergedProperties(String propertyFile)

Get the merged properties in the current bootstrap environment.

getBootstrapLibraryPath

public static String getBootstrapLibraryPath()