org.lsst.ccs.bootstrap.resources

Class BootstrapResourceUtils

java.lang.Object

org.lsst.ccs.bootstrap.resources.BootstrapResourceUtils

Deprecated.

Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

@Deprecated
public abstract class BootstrapResourceUtils
extends Object

Utility methods for loading Bootstrap Resources.

The utility methods provided in this class are meant to be used throughout the CCS environment to load resources in the Bootstrap environment.

For a description on how to control the Bootstrap environment please refer to the following manual.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
BootstrapResourceUtils() Deprecated.

Method Summary

Modifier and Type	Method and Description
static Set<Object>	getAllKeysInProperties(Properties props) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static Properties	getBootstrapProperties(String fileName) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static Properties	getBootstrapProperties(String fileName, Class clazz) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static InputStream	getBootstrapPropertiesInputStream(String fileName, Class clazz) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static InputStream	getBootstrapResource(String resourceName) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static InputStream	getBootstrapResource(String resourceName, Class clazz) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static Properties	getBootstrapSystemProperties() Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static String	getPathOfPropertiesFileInUserResourceDirectories(String propertyFileName) Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead
static String	getTopUserResourceDirectory() Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Methods inherited from class java.lang.Object

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

Constructor Detail

BootstrapResourceUtils

public BootstrapResourceUtils()

Deprecated.

Method Detail

getBootstrapSystemProperties

@Deprecated
public static Properties getBootstrapSystemProperties()

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Return the Bootstrap System Properties object.

This function builds a Properties object by searching and chaining properties according to the following search criteria

• System Properties: System Properties are the first Properties to be added to the merge chain.
• Bootstrap Resources search : The Bootstrap Resources directories (defined by the environment variable CCS_RESOURCE_PATH) are searched in the reversed order. In each directory properties are merged by searching for application and global properties files (these files are loaded from the file system).
• Command line : Properties specified from the command line with the -D option are added to the top of the Properties chain.

Returns:

The merged Properties object.

getPathOfPropertiesFileInUserResourceDirectories

@Deprecated
public static String getPathOfPropertiesFileInUserResourceDirectories(String propertyFileName)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility function to find the top most property file in the user provided resource directories (as specified in the CCS_RESOURCE_PATH environment variable). If the CCS_RESOURCE_PATH environment variable is not specified null will be returned. If specified the first property file will be returned scanning the resource directories in CCS_RESOURCE_PATH left to right.

Parameters:

propertyFileName - The name of the property file to get

Returns:

The full path of the property file.

getTopUserResourceDirectory

@Deprecated
public static String getTopUserResourceDirectory()

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility function to get the top User defined Resource Directory. This is the left-most directory defined in environment variable CCS_RESOURCE_PATH. If not defined, null is returned.

Returns:

the top user defined Resource directory. Null if not defined.

getBootstrapProperties

@Deprecated
public static Properties getBootstrapProperties(String fileName,
                                                            Class clazz)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility function to fetch Properties in the Bootstrap environment.

This function builds a Properties object by searching and chaining properties according to the following search criteria

• Classpath search: getResourceAsStream is invoked on the provided class. The method is first invoked for fileName. If not input stream is found it is then invoked for "/"+fileName
• System Properties: if the parameter includeSystem is set to true, System Properties are added to the chain
• Bootstrap Resources search: The Bootstrap Resources directories (defined by the environment variable CCS_RESOURCE_PATH) are searched in the reversed order. In each directory properties are merged by searching for application, global and topic (defined by fileName) properties files (these files are loaded from the file system). If fileName is a path to a properties file, two searches are performed for each resource directory: the first one is for the fully qualified path; if this yields no result, the properties file is then searched at the root of each resource directory.
• Command line: Properties specified from the command line with the -D option are added to the top of the Properties chain.

Parameters:

fileName - The name of the properties file to load. This can be a path.

clazz - The class on which getResourceAsStream is invoked for the classpath search. If null BootstrapResourceUtils.class is used.

Returns:

The merged Properties object.

getBootstrapProperties

@Deprecated
public static Properties getBootstrapProperties(String fileName)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility function to fetch Properties in the Bootstrap environment.

This function is similar to #getBootstrapProperties(java.lang.String, boolean, java.lang.Class) . In this case the Class object is set to null and it defaults to BootstrapResourceUtils.class.

Parameters:

fileName - The name of the properties file to load. This can be a path.

Returns:

The merged Properties object.

See Also:

#getBootstrapProperties(java.lang.String, boolean, java.lang.Class)

getBootstrapPropertiesInputStream

@Deprecated
public static InputStream getBootstrapPropertiesInputStream(String fileName,
                                                                        Class clazz)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Get an InputStream corresponding to the Bootstrap Properties object.

This function is similar to #getBootstrapProperties(java.lang.String, boolean, java.lang.Class) . Rather than a Properties object it returns the InputStream corresponsing to that Properties object. This is done by invoking Properties.store(java.io.OutputStream, java.lang.String) on a ByteArrayOutputStream and then returning an ByteArrayInputStream.

Parameters:

fileName - The name of the properties file to load. This can be a path.

clazz - The class on which getResourceAsStream is invoked for the classpath search. If null BootstrapResourceUtils.class is used.

Returns:

See Also:

BootstrapResourceUtils#getBootstrapProperties(java.lang.String, boolean, java.lang.Class)

getBootstrapResource

@Deprecated
public static InputStream getBootstrapResource(String resourceName,
                                                           Class clazz)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility functions to look for resources (excluding Properties) in the Bootstrap environment.

This function will search for the desired resource following the search criteria described below. It will return an InputStream for the first resource found.

Search Criteria:

• Bootstrap Resources search: The Bootstrap Resources directories (defined by the environment variable CCS_RESOURCE_PATH) are searched in the defined order. If fileName is a path to a resource, two searches are performed for each resource directory: the first one is for the fully qualified path; if this yields no result, the resource file is then searched at the root of each resource directory.
• Classpath search: getResourceAsStrean is invoked on the provided clazz. The method is first invoked for fileName. If not input stream is found it is then invoked for "/"+fileName

For Properties refer to {@link #getBootstrapProperties(java.lang.String, boolean,java.lang.Class).

Parameters:

resourceName - The name of the resource. This can be a path.

clazz - The class on which getResourceAsStream is invoked for the classpath search. If null BootstrapResourceUtils.class is used.

Returns:

The InputStream of the first found resource.

getBootstrapResource

@Deprecated
public static InputStream getBootstrapResource(String resourceName)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility functions to look for resources (excluding Properties) in the Bootstrap environment.

Internally it invokes getBootstrapResource(java.lang.String,java.lang.Class) with Class set to BootstrapResourceUtils.class.

Parameters:

resourceName - The name of the resource. This can be a path.

Returns:

The InputStream of the first found resource.

See Also:

getBootstrapResource(java.lang.String, java.lang.Class)

getAllKeysInProperties

@Deprecated
public static Set<Object> getAllKeysInProperties(Properties props)

Deprecated. Use class org.lsst.ccs.bootstrap.BootstrapResourceUtils instead

Utility method to fetch all the keys in a properties file, including its parent, to loop over them.

This method keeps into account if a Properties object has a parent and goes down the parent chain to fetch all the keys.

Parameters:

props - The Properties object

Returns:

The Set