com.dtolabs.rundeck.core.common

Class FrameworkProject

java.lang.Object

com.dtolabs.rundeck.core.common.FrameworkResource

com.dtolabs.rundeck.core.common.FrameworkResourceParent

com.dtolabs.rundeck.core.common.FrameworkProject

All Implemented Interfaces:

IFrameworkResource, IFrameworkResourceParent, IRundeckProject

public class FrameworkProject
extends FrameworkResourceParent
implements IRundeckProject

Represents a project in the framework. A project is a repository of installed managed entities organized by their type.

Nested Class Summary

Nested classes/interfaces inherited from class com.dtolabs.rundeck.core.common.FrameworkResourceParent

FrameworkResourceParent.NoSuchResourceException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ETC_DIR_NAME
static java.lang.String	FRAMEWORK_RESOURCES_ALLOWED_URL_PREFIX
static java.lang.String	NODES_XML
static java.lang.String	PROJECT_RESOURCES_ALLOWED_URL_PREFIX
static java.lang.String	PROJECT_RESOURCES_FILE_PROPERTY
static java.lang.String	PROJECT_RESOURCES_FILEFORMAT_PROPERTY
static java.lang.String	PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES
static java.lang.String	PROJECT_RESOURCES_URL_PROPERTY
static java.lang.String	PROP_FILENAME
static java.lang.String	RESOURCES_SOURCE_PROP_PREFIX

Fields inherited from class com.dtolabs.rundeck.core.common.FrameworkResource

VALID_RESOURCE_NAME_CHARSET_REGEX, VALID_RESOURCE_NAME_REGEX

Constructor Summary

Constructors

Constructor and Description
FrameworkProject(java.lang.String name, java.io.File basedir, FilesystemFramework filesystemFramework, IFrameworkProjectMgr resourceMgr) Constructor
FrameworkProject(java.lang.String name, java.io.File basedir, FilesystemFramework filesystemFramework, IFrameworkProjectMgr resourceMgr, java.util.Properties properties) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Set<Attribute>	authorizationEnvironment(java.lang.String project) Creates an authorization environment for a project.
boolean	childCouldBeLoaded(java.lang.String name) Default implementation checks whether a subdir under the basedir exists with the specified name.
static FrameworkProject	create(java.lang.String name, java.io.File projectsDir, FilesystemFramework filesystemFramework, IFrameworkProjectMgr resourceMgr)
static FrameworkProject	create(java.lang.String name, java.io.File projectsDir, FilesystemFramework filesystemFramework, IFrameworkProjectMgr resourceMgr, java.util.Properties properties)
IFrameworkResource	createChild(java.lang.String resourceType) Create a new type and store it
static void	createFileStructure(java.io.File projectDir) Creates the file structure for a project
static PropertyRetriever	createProjectPropertyRetriever(FilesystemFramework filesystemFramework, java.lang.String projectName)
boolean	deleteFileResource(java.lang.String path)
static boolean	exists(java.lang.String project, IFrameworkProjectMgr projectResourceMgr)
boolean	existsDirResource(java.lang.String path)
boolean	existsFileResource(java.lang.String path)
protected void	generateProjectPropertiesFile(boolean overwrite) Create project.properties file based on $RDECK_BASE/etc/project.properties
protected void	generateProjectPropertiesFile(boolean overwrite, java.util.Properties properties, boolean addDefaultProps) Create project.properties file based on $RDECK_BASE/etc/project.properties
protected void	generateProjectPropertiesFile(boolean overwrite, java.util.Properties properties, boolean merge, java.util.Set<java.lang.String> removePrefixes, boolean addDefaultProps) Create project.properties file based on $RDECK_BASE/etc/project.properties
java.util.Date	getConfigLastModifiedTime()
java.io.File	getEtcDir() Gets the config dir for this project
Framework	getFramework()
IFrameworkProjectMgr	getFrameworkProjectMgr()
INodeSet	getNodeSet() Returns the set of nodes for the project
Authorization	getProjectAuthorization()
IProjectNodes	getProjectNodes()
java.util.Map<java.lang.String,java.lang.String>	getProjectProperties()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name)
java.io.File	getPropertyFile()
PropertyRetriever	getPropertyRetriever()
java.util.ArrayList<java.lang.Exception>	getResourceModelSourceExceptions()
boolean	hasProperty(java.lang.String key)
static boolean	isInstalled(FrameworkProject d) Checks if project is installed by checking if it's basedir directory exists.
java.util.Collection	listChildNames() Default implementation lists the subdirectory names and adds any existing child names
java.util.List<java.lang.String>	listDirPaths(java.lang.String path)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listResourceModelConfigurations() list the configurations of resource model providers.
IFrameworkResource	loadChild(java.lang.String name)
long	loadFileResource(java.lang.String path, java.io.OutputStream output) Read a file at a path for the project
void	mergeProjectProperties(java.util.Properties properties, java.util.Set<java.lang.String> removePrefixes) Update the project properties file by setting updating the given properties, and removing any properties that have a prefix in the removePrefixes set
void	setFramework(Framework framework)
void	setProjectAuthorization(Authorization projectAuthorization)
void	setProjectNodes(IProjectNodes projectNodes)
void	setProjectProperties(java.util.Properties properties) Set the project properties file contents exactly
long	storeFileResource(java.lang.String path, java.io.InputStream input) Store a file at a path for the project
boolean	updateNodesResourceFile() Conditionally update the nodes resources file if a URL source is defined for it and return true if the update process was invoked and succeeded
void	updateNodesResourceFile(INodeSet nodeset) Update the resources file given an input Nodes set
void	updateNodesResourceFileFromUrl(java.lang.String providerURL, java.lang.String username, java.lang.String password) Update the nodes resources file from a specific URL, with BASIC authentication as provided or as defined in the URL's userInfo section.

Methods inherited from class com.dtolabs.rundeck.core.common.FrameworkResourceParent

existsChild, existsChildResourceDirectory, getChild, getChildren, initialize, listChildren, remove

Methods inherited from class com.dtolabs.rundeck.core.common.FrameworkResource

getBaseDir, getLogger, getName, getParent, isValid, storeProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dtolabs.rundeck.core.common.IRundeckProject

getName

Methods inherited from interface com.dtolabs.rundeck.core.common.IFrameworkResource

getBaseDir, getName, getParent, isValid

Field Detail

PROP_FILENAME

public static final java.lang.String PROP_FILENAME

See Also:

Constant Field Values

ETC_DIR_NAME

public static final java.lang.String ETC_DIR_NAME

See Also:

Constant Field Values

NODES_XML

public static final java.lang.String NODES_XML

See Also:

Constant Field Values

PROJECT_RESOURCES_URL_PROPERTY

public static final java.lang.String PROJECT_RESOURCES_URL_PROPERTY

See Also:

Constant Field Values

PROJECT_RESOURCES_FILE_PROPERTY

public static final java.lang.String PROJECT_RESOURCES_FILE_PROPERTY

See Also:

Constant Field Values

PROJECT_RESOURCES_FILEFORMAT_PROPERTY

public static final java.lang.String PROJECT_RESOURCES_FILEFORMAT_PROPERTY

See Also:

Constant Field Values

PROJECT_RESOURCES_ALLOWED_URL_PREFIX

public static final java.lang.String PROJECT_RESOURCES_ALLOWED_URL_PREFIX

See Also:

Constant Field Values

FRAMEWORK_RESOURCES_ALLOWED_URL_PREFIX

public static final java.lang.String FRAMEWORK_RESOURCES_ALLOWED_URL_PREFIX

See Also:

Constant Field Values

RESOURCES_SOURCE_PROP_PREFIX

public static final java.lang.String RESOURCES_SOURCE_PROP_PREFIX

See Also:

Constant Field Values

PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES

public static final java.lang.String PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

FrameworkProject

public FrameworkProject(java.lang.String name,
                java.io.File basedir,
                FilesystemFramework filesystemFramework,
                IFrameworkProjectMgr resourceMgr)

Constructor

Parameters:

name - Name of the project

basedir - the base directory for the Depot

resourceMgr - manager

FrameworkProject

public FrameworkProject(java.lang.String name,
                java.io.File basedir,
                FilesystemFramework filesystemFramework,
                IFrameworkProjectMgr resourceMgr,
                java.util.Properties properties)

Constructor

Parameters:

name - Name of the project

basedir - the base directory for the Depot

resourceMgr - manager

properties - properties

Method Detail

authorizationEnvironment

public static java.util.Set<Attribute> authorizationEnvironment(java.lang.String project)

Creates an authorization environment for a project.

Parameters:

project - project name

Returns:

environment to evaluate authorization for a project

createProjectPropertyRetriever

public static PropertyRetriever createProjectPropertyRetriever(FilesystemFramework filesystemFramework,
                                               java.lang.String projectName)

Parameters:

filesystemFramework - filesystem

projectName - name of project

Returns:

Create a property retriever for a project given the framework basedir

listResourceModelConfigurations

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listResourceModelConfigurations()

list the configurations of resource model providers.

Specified by:

listResourceModelConfigurations in interface IRundeckProject

Returns:

a list of maps containing:

• type - provider type name
• props - configuration properties

create

public static FrameworkProject create(java.lang.String name,
                      java.io.File projectsDir,
                      FilesystemFramework filesystemFramework,
                      IFrameworkProjectMgr resourceMgr)

Parameters:

name - project name

projectsDir - projects dir

resourceMgr - resourcemanager

Returns:

Create a new Project object at the specified projects.directory

create

public static FrameworkProject create(java.lang.String name,
                      java.io.File projectsDir,
                      FilesystemFramework filesystemFramework,
                      IFrameworkProjectMgr resourceMgr,
                      java.util.Properties properties)

Parameters:

name - project name

projectsDir - projects dir

resourceMgr - resourcemanager

properties - project properties

Returns:

Create a new Project object at the specified projects.directory

loadChild

public IFrameworkResource loadChild(java.lang.String name)

Specified by:

loadChild in interface IFrameworkResourceParent

Parameters:

name - child name

Returns:

Load a specified child by name, returning null if it does not exist

childCouldBeLoaded

public boolean childCouldBeLoaded(java.lang.String name)

Description copied from class: FrameworkResourceParent

Default implementation checks whether a subdir under the basedir exists with the specified name. (Calls FrameworkResourceParent.existsChildResourceDirectory(String)) Should be overridden by subtypes if this is not the desired behavior.

Specified by:

childCouldBeLoaded in interface IFrameworkResourceParent

Overrides:

childCouldBeLoaded in class FrameworkResourceParent

Parameters:

name - child name

Returns:

true if the child resource could be loaded from a file resource

listChildNames

public java.util.Collection listChildNames()

Description copied from class: FrameworkResourceParent

Default implementation lists the subdirectory names and adds any existing child names

Specified by:

listChildNames in interface IFrameworkResourceParent

Overrides:

listChildNames in class FrameworkResourceParent

Returns:

A Collection of Strings

createChild

public IFrameworkResource createChild(java.lang.String resourceType)

Create a new type and store it

Specified by:

createChild in interface IFrameworkResourceParent

Overrides:

createChild in class FrameworkResourceParent

Parameters:

resourceType - name of child

Returns:

new child

getPropertyFile

public java.io.File getPropertyFile()

getFrameworkProjectMgr

public IFrameworkProjectMgr getFrameworkProjectMgr()

exists

public static boolean exists(java.lang.String project,
             IFrameworkProjectMgr projectResourceMgr)

getEtcDir

public java.io.File getEtcDir()

Gets the config dir for this project

Returns:

etc directory

getNodeSet

public INodeSet getNodeSet()
                    throws NodeFileParserException

Returns the set of nodes for the project

Specified by:

getNodeSet in interface IRundeckProject

Returns:

an instance of INodeSet

Throws:

NodeFileParserException - on parse error

updateNodesResourceFile

public boolean updateNodesResourceFile()
                                throws UpdateUtils.UpdateException

Conditionally update the nodes resources file if a URL source is defined for it and return true if the update process was invoked and succeeded

Specified by:

updateNodesResourceFile in interface IRundeckProject

Returns:

true if the update succeeded, false if it was not performed

Throws:

UpdateUtils.UpdateException - if an error occurs while trying to update the resources file

updateNodesResourceFileFromUrl

public void updateNodesResourceFileFromUrl(java.lang.String providerURL,
                                  java.lang.String username,
                                  java.lang.String password)
                                    throws UpdateUtils.UpdateException

Update the nodes resources file from a specific URL, with BASIC authentication as provided or as defined in the URL's userInfo section.

Specified by:

updateNodesResourceFileFromUrl in interface IRundeckProject

Parameters:

providerURL - URL to retrieve resources file definition

username - username or null

password - or null

Throws:

UpdateUtils.UpdateException - if an error occurs during the update process

updateNodesResourceFile

public void updateNodesResourceFile(INodeSet nodeset)
                             throws UpdateUtils.UpdateException

Update the resources file given an input Nodes set

Specified by:

updateNodesResourceFile in interface IRundeckProject

Parameters:

nodeset - nodes

Throws:

UpdateUtils.UpdateException - if an error occurs while trying to update the resources file or generate nodes

getProperty

public java.lang.String getProperty(java.lang.String name)

Specified by:

getProperty in interface IRundeckProject

Parameters:

name - property name

Returns:

the property value by name

hasProperty

public boolean hasProperty(java.lang.String key)

Specified by:

hasProperty in interface IRundeckProject

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Specified by:

getProperties in interface IRundeckProject

Returns:

the merged properties available for the project

getProjectProperties

public java.util.Map<java.lang.String,java.lang.String> getProjectProperties()

Specified by:

getProjectProperties in interface IRundeckProject

Returns:

the direct properties set for the project

getPropertyRetriever

public PropertyRetriever getPropertyRetriever()

Returns:

a PropertyRetriever interface for project-scoped properties

createFileStructure

public static void createFileStructure(java.io.File projectDir)
                                throws java.io.IOException

Creates the file structure for a project

Parameters:

projectDir - The project base directory

Throws:

java.io.IOException - on io error

existsFileResource

public boolean existsFileResource(java.lang.String path)

Specified by:

existsFileResource in interface IRundeckProject

Parameters:

path - path relative to the project

Returns:

true if it exists

existsDirResource

public boolean existsDirResource(java.lang.String path)

Specified by:

existsDirResource in interface IRundeckProject

Parameters:

path - path relative to the project

Returns:

true if it is a directory

listDirPaths

public java.util.List<java.lang.String> listDirPaths(java.lang.String path)

Specified by:

listDirPaths in interface IRundeckProject

Parameters:

path - path relative to the project

Returns:

list of paths within the directory

deleteFileResource

public boolean deleteFileResource(java.lang.String path)

Specified by:

deleteFileResource in interface IRundeckProject

Parameters:

path - path relative to the project

Returns:

true if it is deleted, false if it was not deleted

storeFileResource

public long storeFileResource(java.lang.String path,
                     java.io.InputStream input)
                       throws java.io.IOException

Description copied from interface: IRundeckProject

Store a file at a path for the project

Specified by:

storeFileResource in interface IRundeckProject

Parameters:

path - path relative to the project

input - input

Throws:

java.io.IOException - if an IO error occurs

loadFileResource

public long loadFileResource(java.lang.String path,
                    java.io.OutputStream output)
                      throws java.io.IOException

Description copied from interface: IRundeckProject

Read a file at a path for the project

Specified by:

loadFileResource in interface IRundeckProject

Parameters:

path - path relative to the project

output - output

Returns:

length of data loaded

Throws:

java.io.IOException - if an IO error occurs

generateProjectPropertiesFile

protected void generateProjectPropertiesFile(boolean overwrite)

Create project.properties file based on $RDECK_BASE/etc/project.properties

Parameters:

overwrite - Overwrite existing properties file

generateProjectPropertiesFile

protected void generateProjectPropertiesFile(boolean overwrite,
                                 java.util.Properties properties,
                                 boolean addDefaultProps)

Create project.properties file based on $RDECK_BASE/etc/project.properties

Parameters:

overwrite - Overwrite existing properties file

properties - properties

addDefaultProps - true to add default properties

generateProjectPropertiesFile

protected void generateProjectPropertiesFile(boolean overwrite,
                                 java.util.Properties properties,
                                 boolean merge,
                                 java.util.Set<java.lang.String> removePrefixes,
                                 boolean addDefaultProps)

Create project.properties file based on $RDECK_BASE/etc/project.properties

Parameters:

overwrite - Overwrite existing properties file

properties - properties to use

merge - if true, merge existing properties that are not replaced

removePrefixes - set of property prefixes to remove from original

addDefaultProps - true to add default properties

mergeProjectProperties

public void mergeProjectProperties(java.util.Properties properties,
                          java.util.Set<java.lang.String> removePrefixes)

Update the project properties file by setting updating the given properties, and removing any properties that have a prefix in the removePrefixes set

Specified by:

mergeProjectProperties in interface IRundeckProject

Parameters:

properties - new properties to put in the file

removePrefixes - prefixes of properties to remove from the file

setProjectProperties

public void setProjectProperties(java.util.Properties properties)

Set the project properties file contents exactly

Specified by:

setProjectProperties in interface IRundeckProject

Parameters:

properties - new properties to use in the file

getConfigLastModifiedTime

public java.util.Date getConfigLastModifiedTime()

Specified by:

getConfigLastModifiedTime in interface IRundeckProject

Returns:

last modified time for configuration in epoch time

isInstalled

public static boolean isInstalled(FrameworkProject d)

Checks if project is installed by checking if it's basedir directory exists.

Parameters:

d - Depot object to check.

Returns:

true if project exists

getResourceModelSourceExceptions

public java.util.ArrayList<java.lang.Exception> getResourceModelSourceExceptions()

Returns:

the set of exceptions produced by the last attempt to invoke all node providers

getFramework

public Framework getFramework()

setFramework

public void setFramework(Framework framework)

getProjectNodes

public IProjectNodes getProjectNodes()

Specified by:

getProjectNodes in interface IRundeckProject

Returns:

the project nodes interface

setProjectNodes

public void setProjectNodes(IProjectNodes projectNodes)

getProjectAuthorization

public Authorization getProjectAuthorization()

Specified by:

getProjectAuthorization in interface IRundeckProject

Returns:

authorization for this project

setProjectAuthorization

public void setProjectAuthorization(Authorization projectAuthorization)