Package com.dtolabs.rundeck.core.common

Interface ProjectManager

    • Method Detail

      • 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

      • 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

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