com.atlassian.bamboo.plugins.rest.resource

Class ProjectResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.ProjectResource

public class ProjectResource
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectResource(BambooPermissionManager bambooPermissionsManager, BambooUserManager bambooUserManager, CachedPlanManager cachedPlanManager, LabelManager labelManager, ProjectManager projectManager, PlanRestService planRestService)

Method Summary

Modifier and Type	Method and Description
RestProjects	getAllProjects(boolean showEmpty, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method used to list all projects defined in Bamboo.
RestProject	getProject(String projectKey, boolean showEmpty, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method used to retrieve information for project specified as project key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectResource

public ProjectResource(BambooPermissionManager bambooPermissionsManager,
                       BambooUserManager bambooUserManager,
                       CachedPlanManager cachedPlanManager,
                       LabelManager labelManager,
                       ProjectManager projectManager,
                       PlanRestService planRestService)

Method Detail

getAllProjects

public RestProjects getAllProjects(boolean showEmpty,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Method used to list all projects defined in Bamboo. Permissions for projects are checked based on Plan permissions (no project level permissions in Bamboo) Projects without any plan visible for user are not listed Possible expand parameters projects - list of projects projects.project - list of projects with project details projects.project.plans - list of project details and plans for project projects.project.plans.plan - list of project details and plans for project with plan details

Parameters:

showEmpty - flag to display projects without plans. As Bamboo doesn't have project level permissions only user with global BambooPermission.ADMINISTRATION permission can see empty projects.

uriInfo -

authenticationContext -

Returns:

list of Bamboo projects

getProject

public RestProject getProject(String projectKey,
                              boolean showEmpty,
                              @Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @Context
                              com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Method used to retrieve information for project specified as project key. Possible expand parameters plans - list of plans for project plans.plan - list of plans with plan details (only plans visible - READ permission for user) plans.plan.actions - list of plans with plan details and actions available for user for plan

Parameters:

projectKey - project key

showEmpty - flag to return project without plans. As Bamboo doesn't have project level permissions only user with global BambooPermission.ADMINISTRATION permission can see empty projects.

uriInfo -

authenticationContext -

Returns:

project data (optionally plan info and plan details)