org.guvnor.common.services.project.service

Interface ProjectService<T extends Project>

public interface ProjectService<T extends Project>

Method Summary

Methods

Modifier and Type	Method and Description
void	addGroup(Project project, String group) Add a group to a project; limiting access to users with the group
void	copy(org.uberfire.backend.vfs.Path pathToPomXML, String newName, String comment)
void	delete(org.uberfire.backend.vfs.Path pathToPomXML, String comment)
Set<Project>	getProjects(Repository repository, String branch) Gets a list of the projects in a particular repository
boolean	isPom(org.uberfire.backend.vfs.Path resource) Return true if the file is the Project's pom.xml file
WorkingSetSettings	loadWorkingSetConfig(org.uberfire.backend.vfs.Path project)
Package	newPackage(Package pkg, String packageName) Creates a new package as a child of the provide package.
T	newProject(Repository repository, POM pom, String baseURL) Creates a new project to the given path.
void	removeGroup(Project project, String group) Remove a group from a project
org.uberfire.backend.vfs.Path	rename(org.uberfire.backend.vfs.Path pathToPomXML, String newName, String comment)
Package	resolveDefaultPackage(Project project)
Package	resolvePackage(org.uberfire.backend.vfs.Path resource) Given a Resource path resolve it to the containing Package Path.
Set<Package>	resolvePackages(Package pkg)
Set<Package>	resolvePackages(Project project) Given a Project resolves the calculation of all the packages for this project.
Package	resolveParentPackage(Package pkg)
Project	resolveParentProject(org.uberfire.backend.vfs.Path resource)
T	resolveProject(org.uberfire.backend.vfs.Path resource) Given a Resource path resolve it to the containing Project Path.
Project	resolveToParentProject(org.uberfire.backend.vfs.Path resource)

Method Detail

loadWorkingSetConfig

WorkingSetSettings loadWorkingSetConfig(org.uberfire.backend.vfs.Path project)

resolveProject

T resolveProject(org.uberfire.backend.vfs.Path resource)

Given a Resource path resolve it to the containing Project Path. A Project path is the folder containing pom.xml

Parameters:

resource -

Returns:

Path to the folder containing the Project's pom.xml file or null if the resource was not in a Project

resolveParentProject

Project resolveParentProject(org.uberfire.backend.vfs.Path resource)

resolveToParentProject

Project resolveToParentProject(org.uberfire.backend.vfs.Path resource)

getProjects

Set<Project> getProjects(Repository repository,
                       String branch)

Gets a list of the projects in a particular repository

Parameters:

repository -

branch - the branch where we are looking for the projects

Returns:

resolvePackage

Package resolvePackage(org.uberfire.backend.vfs.Path resource)

Given a Resource path resolve it to the containing Package Path. A Package path is the folder containing the resource. The folder must be within a valid Project structure and at least reference /src/main/java, /src/main/resources, src/test/java or src/test/resources (or deeper).

Parameters:

resource -

Returns:

Path to the folder containing the resource file or null if the resource is not in a Package.

resolvePackages

Set<Package> resolvePackages(Project project)

Given a Project resolves the calculation of all the packages for this project.

Parameters:

project -

Returns:

Collection containing all the packages for the project.

resolvePackages

Set<Package> resolvePackages(Package pkg)

resolveDefaultPackage

Package resolveDefaultPackage(Project project)

resolveParentPackage

Package resolveParentPackage(Package pkg)

isPom

boolean isPom(org.uberfire.backend.vfs.Path resource)

Return true if the file is the Project's pom.xml file

Parameters:

resource -

Returns:

newProject

T newProject(Repository repository,
           POM pom,
           String baseURL)

Creates a new project to the given path.

Parameters:

repository -

pom -

baseURL - the base URL where the Guvnor is hosted in web container

Returns:

newPackage

Package newPackage(Package pkg,
                 String packageName)

Creates a new package as a child of the provide package.

Parameters:

pkg -

packageName -

Returns:

addGroup

void addGroup(Project project,
            String group)

Add a group to a project; limiting access to users with the group

Parameters:

project - The Project

group - The required group

removeGroup

void removeGroup(Project project,
               String group)

Remove a group from a project

Parameters:

project - The Project

group - The group

rename

org.uberfire.backend.vfs.Path rename(org.uberfire.backend.vfs.Path pathToPomXML,
                                   String newName,
                                   String comment)

delete

void delete(org.uberfire.backend.vfs.Path pathToPomXML,
          String comment)

copy

void copy(org.uberfire.backend.vfs.Path pathToPomXML,
        String newName,
        String comment)