com.dtolabs.rundeck.core.common

Interface ProjectManager

All Known Subinterfaces:

IFrameworkProjectMgr

All Known Implementing Classes:

FrameworkProjectMgr

public interface ProjectManager

Managers project

Method Summary

Modifier and Type	Method and Description
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
boolean	existsFrameworkProject(java.lang.String project) Checks if project by that name exists
IRundeckProject	getFrameworkProject(java.lang.String name) Get the specified existing project
java.util.Collection<java.lang.String>	listFrameworkProjectNames() List the project names
java.util.Collection<IRundeckProject>	listFrameworkProjects() List all current FrameworkProject objects
IRundeckProjectConfig	loadProjectConfig(java.lang.String project)
void	removeFrameworkProject(java.lang.String projectName) Remove a project definition

Method Detail

listFrameworkProjects

java.util.Collection<IRundeckProject> listFrameworkProjects()

List all current FrameworkProject objects

Returns:

a Collection of FrameworkProject instances

listFrameworkProjectNames

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

List the project names

Returns:

getFrameworkProject

IRundeckProject getFrameworkProject(java.lang.String name)

Get the specified existing project

Parameters:

name - Depot name

Returns:

IRundeckProject instance

loadProjectConfig

IRundeckProjectConfig loadProjectConfig(java.lang.String project)

existsFrameworkProject

boolean existsFrameworkProject(java.lang.String project)

Checks if project by that name exists

Parameters:

project - project name

Returns:

true if that project exists. false otherwise

createFrameworkProject

IRundeckProject createFrameworkProject(java.lang.String projectName)

Create a new project. This also creates its structure

Parameters:

projectName - Name of project

Returns:

newly created FrameworkProject

createFrameworkProject

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

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

removeFrameworkProject

void removeFrameworkProject(java.lang.String projectName)

Remove a project definition

Parameters:

projectName - name of the project

createFrameworkProjectStrict

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

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

Parameters:

projectName - name of project

properties - config properties

Returns:

new project

Throws:

java.lang.IllegalArgumentException - if the project already exists