com.dtolabs.rundeck.core.common

Class FrameworkProject

java.lang.Object

com.dtolabs.rundeck.core.common.FrameworkResource

com.dtolabs.rundeck.core.common.FrameworkProject

All Implemented Interfaces:

IFrameworkResource, IRundeckProject, IRundeckProjectConfig

public class FrameworkProject
extends FrameworkResource
implements IRundeckProject

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ETC_DIR_NAME
static java.lang.String	NODES_XML
static java.lang.String	PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES
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, IFilesystemFramework filesystemFramework, IFrameworkProjectMgr resourceMgr, IRundeckProjectConfig projectConfig, IRundeckProjectConfigModifier projectConfigModifier) Constructor

Method Summary

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)
static FrameworkProject	create(java.lang.String name, java.io.File projectsDir, IFilesystemFramework filesystemFramework, IFrameworkProjectMgr resourceMgr, java.util.function.Supplier<ResourceFormatGeneratorService> getResourceFormatGeneratorService, java.util.function.Supplier<ResourceModelSourceService> getResourceModelSourceService)
static void	createFileStructure(java.io.File projectDir) Creates the file structure for a project
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, java.util.Properties properties, boolean addDefault)
java.util.Date	getConfigLastModifiedTime()
java.io.File	getEtcDir() Gets the config dir for this project
IFrameworkProjectMgr	getFrameworkProjectMgr()
IProjectInfo	getInfo()
INodeSet	getNodeSet() Returns the set of nodes for the project
Authorization	getProjectAuthorization()
static java.io.File	getProjectEtcDir(java.io.File baseDir) Get the etc dir from the basedir
IProjectNodes	getProjectNodes()
java.util.Map<java.lang.String,java.lang.String>	getProjectProperties()
static java.io.File	getProjectPropertyFile(java.io.File baseDir) Get the project property file from the basedir
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name)
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<java.lang.String>	listChildNames()
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.
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	setProjectAuthorization(Authorization projectAuthorization)
void	setProjectNodesFactory(IProjectNodesFactory projectNodesFactory)
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

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

existsSubdir, getBaseDir, getLogger, getName, getSubdir, listSubdirNames, listSubdirs, removeSubDir, 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

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

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,
                        IFilesystemFramework filesystemFramework,
                        IFrameworkProjectMgr resourceMgr,
                        IRundeckProjectConfig projectConfig,
                        IRundeckProjectConfigModifier projectConfigModifier)

Constructor

Parameters:

name - Name of the project

basedir - the base directory for the Depot

resourceMgr - manager

projectConfig - config

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

getInfo

public IProjectInfo getInfo()

Specified by:

getInfo in interface IRundeckProject

getProjectEtcDir

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

Get the etc dir from the basedir

getProjectPropertyFile

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

Get the project property file from the basedir

getProperty

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

Specified by:

getProperty in interface IRundeckProject

Specified by:

getProperty in interface IRundeckProjectConfig

Parameters:

name - property name

Returns:

the property value by name

hasProperty

public boolean hasProperty(java.lang.String key)

Specified by:

hasProperty in interface IRundeckProject

Specified by:

hasProperty in interface IRundeckProjectConfig

Parameters:

key - property name

Returns:

true if present, false otherwise

getProperties

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

Specified by:

getProperties in interface IRundeckProject

Specified by:

getProperties in interface IRundeckProjectConfig

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

Specified by:

getProjectProperties in interface IRundeckProjectConfig

Returns:

the direct properties set for the project

getConfigLastModifiedTime

public java.util.Date getConfigLastModifiedTime()

Specified by:

getConfigLastModifiedTime in interface IRundeckProject

Specified by:

getConfigLastModifiedTime in interface IRundeckProjectConfig

Returns:

last modified time for configuration in epoch time

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,
                                      IFilesystemFramework filesystemFramework,
                                      IFrameworkProjectMgr resourceMgr,
                                      java.util.function.Supplier<ResourceFormatGeneratorService> getResourceFormatGeneratorService,
                                      java.util.function.Supplier<ResourceModelSourceService> getResourceModelSourceService)

Parameters:

getResourceFormatGeneratorService -

getResourceModelSourceService -

name - project name

projectsDir - projects dir

resourceMgr - resourcemanager

Returns:

Create a new Project object at the specified projects.directory

childCouldBeLoaded

public boolean childCouldBeLoaded(java.lang.String name)

listChildNames

public java.util.Collection<java.lang.String> listChildNames()

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

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,
                                             java.util.Properties properties,
                                             boolean addDefault)

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

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

getProjectNodes

public IProjectNodes getProjectNodes()

Specified by:

getProjectNodes in interface IRundeckProject

Returns:

the project nodes interface

getProjectAuthorization

public Authorization getProjectAuthorization()

Specified by:

getProjectAuthorization in interface IRundeckProject

Returns:

authorization for this project

setProjectAuthorization

public void setProjectAuthorization(Authorization projectAuthorization)

setProjectNodesFactory

public void setProjectNodesFactory(IProjectNodesFactory projectNodesFactory)