Package com.dtolabs.rundeck.core.common

Class FrameworkProjectMgr

java.lang.Object

com.dtolabs.rundeck.core.common.FrameworkResource

com.dtolabs.rundeck.core.common.FrameworkProjectMgr

All Implemented Interfaces:

IFrameworkProjectMgr, IFrameworkResource, ProjectManager

public class FrameworkProjectMgr
extends FrameworkResource
implements IFrameworkProjectMgr

Filesystem based project manager

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	log

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

VALID_RESOURCE_DESCRIPTION_CHARSET_REGEX, VALID_RESOURCE_DESCRIPTION_REGEX, VALID_RESOURCE_NAME_CHARSET_REGEX, VALID_RESOURCE_NAME_REGEX

Method Summary

Modifier and Type	Method	Description
boolean	childCouldBeLoaded(java.lang.String name)
int	countFrameworkProjects()
IRundeckProject	createFrameworkProject(java.lang.String projectName)	Create a new project.
IRundeckProject	createFrameworkProject(java.lang.String projectName, java.util.Properties properties)
IRundeckProject	createFrameworkProjectStrict(java.lang.String projectName, java.util.Properties properties)	Create a new project if it doesn't, otherwise throw exception
FrameworkProject	createFSFrameworkProject(java.lang.String projectName)	Create a new project.
void	disableFrameworkProject(java.lang.String projectName)	Disables a project so it becomes unavailable without deleting it.
void	enableFrameworkProject(java.lang.String projectName)	Enables a previously disabled project.
boolean	existsFrameworkProject(java.lang.String project)	Checks if project by that name exists
FilesystemFramework	getFilesystemFramework()
FrameworkProject	getFrameworkProject(java.lang.String name)	Get the specified existing project
IProjectNodesFactory	getNodesFactory()
java.lang.String	getProjectDescription(java.lang.String projectName)	Gets the project description
java.util.Properties	getProperties()
boolean	isFrameworkProjectDisabled(java.lang.String projectName)
java.util.List<java.lang.String>	listChildNames()
java.util.Collection<java.lang.String>	listFrameworkProjectNames()	List all the project names
java.util.Collection<IRundeckProject>	listFrameworkProjects()	List all current FrameworkProject objects
FrameworkProject	loadChild(java.lang.String name)
IRundeckProjectConfig	loadProjectConfig(java.lang.String projectName)
void	removeFrameworkProject(java.lang.String projectName)	Remove a project definition
void	setNodesFactory(IProjectNodesFactory nodesFactory)
java.lang.String	toString()

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

existsSubdir, getBaseDir, getLogger, getName, getSubdir, listSubdirNames, listSubdirs, removeSubDir

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.slf4j.Logger log

Method Detail

createFrameworkProject

public IRundeckProject createFrameworkProject(java.lang.String projectName)

Description copied from interface: ProjectManager

Create a new project. This also creates its structure

Specified by:

createFrameworkProject in interface ProjectManager

Parameters:

projectName - Name of the project

Returns:

newly created FrameworkProject

createFSFrameworkProject

public FrameworkProject createFSFrameworkProject(java.lang.String projectName)

Description copied from interface: IFrameworkProjectMgr

Create a new project. This also creates its structure

Specified by:

createFSFrameworkProject in interface IFrameworkProjectMgr

Parameters:

projectName - Name of the project

Returns:

newly created FrameworkProject

getFilesystemFramework

public FilesystemFramework getFilesystemFramework()

createFrameworkProject

public IRundeckProject createFrameworkProject(java.lang.String projectName,
                                              java.util.Properties properties)

Specified by:

createFrameworkProject in interface ProjectManager

Parameters:

projectName - Name of the project

properties - additional properties to include in the project's properties file

Returns:

Create a new project if it doesn't exist, otherwise returns existing project

createFrameworkProjectStrict

public IRundeckProject createFrameworkProjectStrict(java.lang.String projectName,
                                                    java.util.Properties properties)

Create a new project if it doesn't, otherwise throw exception

Specified by:

createFrameworkProjectStrict in interface ProjectManager

Parameters:

projectName - name of project

properties - config properties

Returns:

new project

Throws:

java.lang.IllegalArgumentException - if the project already exists

removeFrameworkProject

public void removeFrameworkProject(java.lang.String projectName)

Remove a project definition

Specified by:

removeFrameworkProject in interface ProjectManager

Parameters:

projectName - name of the project

listFrameworkProjects

public java.util.Collection<IRundeckProject> listFrameworkProjects()

Description copied from interface: ProjectManager

List all current FrameworkProject objects

Specified by:

listFrameworkProjects in interface ProjectManager

Returns:

a collection of Project objects

listFrameworkProjectNames

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

Description copied from interface: ProjectManager

List all the project names

Specified by:

listFrameworkProjectNames in interface ProjectManager

Returns:

countFrameworkProjects

public int countFrameworkProjects()

Specified by:

countFrameworkProjects in interface ProjectManager

Returns:

number of projects

disableFrameworkProject

public void disableFrameworkProject(java.lang.String projectName)

Description copied from interface: ProjectManager

Disables a project so it becomes unavailable without deleting it.

Specified by:

disableFrameworkProject in interface ProjectManager

Parameters:

projectName - name of the project.

enableFrameworkProject

public void enableFrameworkProject(java.lang.String projectName)

Description copied from interface: ProjectManager

Enables a previously disabled project.

Specified by:

enableFrameworkProject in interface ProjectManager

Parameters:

projectName - name of the project.

isFrameworkProjectDisabled

public boolean isFrameworkProjectDisabled(java.lang.String projectName)

Specified by:

isFrameworkProjectDisabled in interface ProjectManager

Returns:

true if the project exists and is disabled. false otherwise.

getProjectDescription

public java.lang.String getProjectDescription(java.lang.String projectName)

Description copied from interface: ProjectManager

Gets the project description

Specified by:

getProjectDescription in interface ProjectManager

Parameters:

projectName - Project name identifier

Returns:

The description if any. null otherwise.

listChildNames

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

getFrameworkProject

public FrameworkProject getFrameworkProject(java.lang.String name)

Description copied from interface: ProjectManager

Get the specified existing project

Specified by:

getFrameworkProject in interface ProjectManager

Parameters:

name - The name of the project

Returns:

an existing Project object and returns it

loadProjectConfig

public IRundeckProjectConfig loadProjectConfig(java.lang.String projectName)

Specified by:

loadProjectConfig in interface ProjectManager

existsFrameworkProject

public boolean existsFrameworkProject(java.lang.String project)

Description copied from interface: ProjectManager

Checks if project by that name exists

Specified by:

existsFrameworkProject in interface ProjectManager

Parameters:

project - The name of the project

Returns:

true if project exists in framework.

childCouldBeLoaded

public boolean childCouldBeLoaded(java.lang.String name)

toString

public java.lang.String toString()

Overrides:

toString in class FrameworkResource

getProperties

public java.util.Properties getProperties()

loadChild

public FrameworkProject loadChild(java.lang.String name)

getNodesFactory

public IProjectNodesFactory getNodesFactory()

setNodesFactory

public void setNodesFactory(IProjectNodesFactory nodesFactory)