com.dtolabs.rundeck.core.common
Interface IFrameworkProjectMgr

All Superinterfaces:

IFrameworkResource, IFrameworkResourceParent, IPropertyLookup, PropertyRetriever

All Known Implementing Classes:

FrameworkProjectMgr

public interface IFrameworkProjectMgr
extends IFrameworkResourceParent, IPropertyLookup

A set of interfaces for managing a set of Depots

Method Summary

FrameworkProject	createFrameworkProject(java.lang.String projectName) Create a new project.
FrameworkProject	createFrameworkProject(java.lang.String projectName, java.util.Properties properties) Create a new project if it doesn't exist, otherwise returns existing project
FrameworkProject	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
Framework	getFramework() Gets the instance of the framework for this resource mgr
FrameworkProject	getFrameworkProject(java.lang.String name) Get the specified existing project
boolean	isConfiguredObjectDeploymentsCheck(java.lang.String projectName) checks if project is configured to use resources.properties lookups
java.util.Collection	listFrameworkProjects() List all current FrameworkProject objects
void	removeFrameworkProject(java.lang.String projectName) Remove a project definition

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

childCouldBeLoaded, createChild, existsChild, existsChildResourceDirectory, getChild, initialize, listChildNames, listChildren, loadChild, remove

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

getBaseDir, getName, getParent, isValid

Methods inherited from interface com.dtolabs.rundeck.core.utils.IPropertyLookup

getPropertiesMap, getProperty, hasProperty

Method Detail

getFramework

Framework getFramework()

Gets the instance of the framework for this resource mgr

Returns:

Framework instance

listFrameworkProjects

java.util.Collection listFrameworkProjects()

List all current FrameworkProject objects

Returns:

a Collection of FrameworkProject instances

getFrameworkProject

FrameworkProject getFrameworkProject(java.lang.String name)

Get the specified existing project

Parameters:

name - Depot name

Returns:

FrameworkProject instance

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

isConfiguredObjectDeploymentsCheck

boolean isConfiguredObjectDeploymentsCheck(java.lang.String projectName)

checks if project is configured to use resources.properties lookups

Parameters:

projectName - name of project

Returns:

true if configured for lookups

createFrameworkProject

FrameworkProject createFrameworkProject(java.lang.String projectName)

Create a new project. This also creates its structure

Parameters:

projectName - Name of project

Returns:

newly created FrameworkProject

createFrameworkProject

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

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

Parameters:

projectName - Name of the project

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

removeFrameworkProject

void removeFrameworkProject(java.lang.String projectName)

Remove a project definition

Parameters:

projectName - name of the project

createFrameworkProjectStrict

FrameworkProject 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