com.dtolabs.rundeck.core.common

Class FrameworkProjectMgr

java.lang.Object

com.dtolabs.rundeck.core.common.FrameworkResource

com.dtolabs.rundeck.core.common.FrameworkResourceParent

com.dtolabs.rundeck.core.common.FrameworkProjectMgr

All Implemented Interfaces:

IFrameworkProjectMgr, IFrameworkResource, IFrameworkResourceParent, ProjectManager

public class FrameworkProjectMgr
extends FrameworkResourceParent
implements IFrameworkProjectMgr

Filesystem based project manager

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 org.apache.log4j.Logger	log

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

VALID_RESOURCE_NAME_CHARSET_REGEX, VALID_RESOURCE_NAME_REGEX

Method Summary

Methods

Modifier and Type	Method and Description
boolean	childCouldBeLoaded(java.lang.String name) Default implementation checks whether a subdir under the basedir exists with the specified name.
IFrameworkResource	createChild(java.lang.String projectName) create a new child resource
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.
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
java.util.Properties	getProperties()
java.util.Collection<java.lang.String>	listFrameworkProjectNames() List the project names
java.util.Collection<IRundeckProject>	listFrameworkProjects() List all current FrameworkProject objects
IFrameworkResource	loadChild(java.lang.String name)
IRundeckProjectConfig	loadProjectConfig(java.lang.String projectName)
void	removeFrameworkProject(java.lang.String projectName) Remove a project definition
java.lang.String	toString()

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

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

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

getBaseDir, getLogger, getName, getParent, isValid, storeProperties

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.IFrameworkResource

getBaseDir, getName, getParent, isValid

Field Detail

log

public static final org.apache.log4j.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 the project names

Specified by:

listFrameworkProjectNames in interface ProjectManager

Returns:

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)

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

toString

public java.lang.String toString()

Overrides:

toString in class FrameworkResource

getProperties

public java.util.Properties getProperties()

createChild

public IFrameworkResource createChild(java.lang.String projectName)

Description copied from class: FrameworkResourceParent

create a new child resource

Specified by:

createChild in interface IFrameworkResourceParent

Overrides:

createChild in class FrameworkResourceParent

Parameters:

projectName - name of child

Returns:

new child

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