Package com.dtolabs.rundeck.core.common
Interface ProjectManager
-
- All Known Subinterfaces:
IFrameworkProjectMgr
- All Known Implementing Classes:
FrameworkProjectMgr
public interface ProjectManager
Managers project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 exceptionvoid
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 existsIRundeckProject
getFrameworkProject(java.lang.String name)
Get the specified existing projectjava.lang.String
getProjectDescription(java.lang.String projectName)
Gets the project descriptionboolean
isFrameworkProjectDisabled(java.lang.String projectName)
java.util.Collection<java.lang.String>
listFrameworkProjectNames()
List all the project namesjava.util.Collection<IRundeckProject>
listFrameworkProjects()
List all currentFrameworkProject
objectsIRundeckProjectConfig
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 currentFrameworkProject
objects- Returns:
- a Collection of
FrameworkProject
instances
-
listFrameworkProjectNames
java.util.Collection<java.lang.String> listFrameworkProjectNames()
List all the project names- Returns:
-
countFrameworkProjects
int countFrameworkProjects()
- Returns:
- number of projects
-
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 projectproperties
- 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 projectproperties
- config properties- Returns:
- new project
- Throws:
java.lang.IllegalArgumentException
- if the project already exists
-
disableFrameworkProject
void disableFrameworkProject(java.lang.String projectName)
Disables a project so it becomes unavailable without deleting it.- Parameters:
projectName
- name of the project.
-
enableFrameworkProject
void enableFrameworkProject(java.lang.String projectName)
Enables a previously disabled project.- Parameters:
projectName
- name of the project.
-
isFrameworkProjectDisabled
boolean isFrameworkProjectDisabled(java.lang.String projectName)
- Returns:
- true if the project exists and is disabled. false otherwise.
-
getProjectDescription
java.lang.String getProjectDescription(java.lang.String projectName)
Gets the project description- Parameters:
projectName
- Project name identifier- Returns:
- The description if any. null otherwise.
-
-