Package com.dtolabs.rundeck.core.common

Class FilesystemFramework

java.lang.Object

com.dtolabs.rundeck.core.common.FilesystemFramework

All Implemented Interfaces:

IFilesystemFramework

public class FilesystemFramework
extends java.lang.Object
implements IFilesystemFramework

Filesystem based configuration for framework

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_LIBEXT_CACHE_DIR_NAME
static java.lang.String	DEFAULT_LIBEXT_DIR_NAME
static java.lang.String	FRAMEWORK_LIBEXT_CACHE_DIR
static java.lang.String	FRAMEWORK_LIBEXT_DIR
static java.lang.String	SYSTEM_PROP_LIBEXT
static java.lang.String	SYSTEM_PROP_LIBEXT_CACHE

Constructor Summary

Constructors

Constructor	Description
FilesystemFramework(java.io.File baseDir, java.io.File projectsDir)

Method Summary

Modifier and Type	Method	Description
static PropertyLookup	createPropertyLookupFromBasedir(java.io.File baseDir)
static PropertyRetriever	createPropertyRetriever(java.io.File baseDir)
java.io.File	getBaseDir()
java.io.File	getConfigDir()
static java.io.File	getConfigDir(java.io.File baseDir)
Framework	getFramework()
java.io.File	getFrameworkProjectsBaseDir()
static FilesystemFramework	getInstanceWithoutProjectsDir(java.lang.String rdeck_base_dir)	Returns an instance of Framework object.
java.io.File	getLibextCacheDir()
java.io.File	getLibextCacheDir(IFramework fwk)
java.io.File	getLibextDir()
java.io.File	getLibextDir(IFramework fwk)
static java.lang.String	getProjectsBaseDir(java.io.File baseDir)
static java.io.File	getPropertyFile(java.io.File configDir)
IPropertyLookup	getPropertyLookup()
void	setBaseDir(java.io.File baseDir)
void	setFramework(Framework framework)

Methods inherited from class java.lang.Object

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

Field Detail

FRAMEWORK_LIBEXT_DIR

public static final java.lang.String FRAMEWORK_LIBEXT_DIR

See Also:

Constant Field Values

FRAMEWORK_LIBEXT_CACHE_DIR

public static final java.lang.String FRAMEWORK_LIBEXT_CACHE_DIR

See Also:

Constant Field Values

DEFAULT_LIBEXT_DIR_NAME

public static final java.lang.String DEFAULT_LIBEXT_DIR_NAME

See Also:

Constant Field Values

DEFAULT_LIBEXT_CACHE_DIR_NAME

public static final java.lang.String DEFAULT_LIBEXT_CACHE_DIR_NAME

See Also:

Constant Field Values

SYSTEM_PROP_LIBEXT

public static final java.lang.String SYSTEM_PROP_LIBEXT

See Also:

Constant Field Values

SYSTEM_PROP_LIBEXT_CACHE

public static final java.lang.String SYSTEM_PROP_LIBEXT_CACHE

See Also:

Constant Field Values

Constructor Detail

FilesystemFramework

public FilesystemFramework(java.io.File baseDir,
                           java.io.File projectsDir)

Method Detail

getProjectsBaseDir

public static java.lang.String getProjectsBaseDir(java.io.File baseDir)

Parameters:

baseDir - base dir

Returns:

the path for the projects directory from the basedir

getConfigDir

public java.io.File getConfigDir()

Specified by:

getConfigDir in interface IFilesystemFramework

Returns:

the config dir

getConfigDir

public static java.io.File getConfigDir(java.io.File baseDir)

Parameters:

baseDir - base dir

Returns:

the config dir for the framework given a basedir

getInstanceWithoutProjectsDir

public static FilesystemFramework getInstanceWithoutProjectsDir(java.lang.String rdeck_base_dir)

Returns an instance of Framework object. Loads the framework.projects.dir property value, or defaults to basedir/projects

Parameters:

rdeck_base_dir - path name to the rdeck_base

Returns:

a Framework instance

getFrameworkProjectsBaseDir

public java.io.File getFrameworkProjectsBaseDir()

Specified by:

getFrameworkProjectsBaseDir in interface IFilesystemFramework

getLibextDir

public java.io.File getLibextDir(IFramework fwk)

Specified by:

getLibextDir in interface IFilesystemFramework

Returns:

the directory containing plugins/extensions for the framework.

getLibextDir

public java.io.File getLibextDir()

Specified by:

getLibextDir in interface IFilesystemFramework

Returns:

the directory containing plugins/extensions for the framework.

getLibextCacheDir

public java.io.File getLibextCacheDir()

Specified by:

getLibextCacheDir in interface IFilesystemFramework

Returns:

the cache directory used by the plugin system

getLibextCacheDir

public java.io.File getLibextCacheDir(IFramework fwk)

Specified by:

getLibextCacheDir in interface IFilesystemFramework

getPropertyFile

public static java.io.File getPropertyFile(java.io.File configDir)

Parameters:

configDir - config dir

Returns:

the framework property file from the config dir

createPropertyRetriever

public static PropertyRetriever createPropertyRetriever(java.io.File baseDir)

Parameters:

baseDir - base dir

Returns:

Create a safe framework property retriever given a basedir

createPropertyLookupFromBasedir

public static PropertyLookup createPropertyLookupFromBasedir(java.io.File baseDir)

Parameters:

baseDir - base dir

Returns:

Create a safe framework property retriever given a basedir

getPropertyLookup

public IPropertyLookup getPropertyLookup()

Specified by:

getPropertyLookup in interface IFilesystemFramework

Returns:

a framework property lookup for this basedir

getBaseDir

public java.io.File getBaseDir()

Specified by:

getBaseDir in interface IFilesystemFramework

setBaseDir

public void setBaseDir(java.io.File baseDir)

getFramework

public Framework getFramework()

setFramework

public void setFramework(Framework framework)