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

java.lang.Object
  com.atlassian.bamboo.plugins.rest.resource.ProjectResource

public class ProjectResource
extends java.lang.Object

User: mwent Date: May 22, 2009 Time: 1:04:59 PM

Constructor Summary

ProjectResource(FilteringPlanManager planManager, BambooUserManager bambooUserManager, LabelManager labelManager, ProjectManager projectManager)

Method Summary

RestProjects

getAllProjects(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(java.lang.String projectKey, 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 Should be invoked as /rest/api/latest/project/PROJECTKEY 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

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectResource

public ProjectResource(FilteringPlanManager planManager,
                       BambooUserManager bambooUserManager,
                       LabelManager labelManager,
                       ProjectManager projectManager)

Method Detail

getAllProjects

public RestProjects getAllProjects(@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 Should be invoked as /rest/api/latest/project

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

Returns:

list of Bamboo projects

getProject

public RestProject getProject(java.lang.String projectKey,
                              @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 Should be invoked as /rest/api/latest/project/PROJECTKEY

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 -

Returns:

project data (optionally plan info and plan details)