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

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

public class PlanResource
extends java.lang.Object

Plan service is supposed to be used to retrieve full list of plans and plan details

Constructor Summary

PlanResource(BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, LabelManager labelManager, PlanManager planManager, VariableDefinitionManager variableDefinitionManager)

Method Summary

RestPlans	getAllPlanList(javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Method used to list all plans on Bamboo service that user is allowed to see (READ permission).
RestPlan	getPlan(java.lang.String projectKey, java.lang.String buildKey, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
RestPlan	getPlanAlias(java.lang.String projectKey, java.lang.String buildKey, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanResource

public PlanResource(BambooPermissionManager bambooPermissionManager,
                    BambooUserManager bambooUserManager,
                    LabelManager labelManager,
                    PlanManager planManager,
                    VariableDefinitionManager variableDefinitionManager)

Method Detail

getAllPlanList

public RestPlans getAllPlanList(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Method used to list all plans on Bamboo service that user is allowed to see (READ permission). Should be invoked as /rest/api/latest/plan

Possible expand parameters plans - list of plans plans.plan - list of plans with plan details plans.plan.actions

Returns:

list of plans on Bamboo server

getPlan

public RestPlan getPlan(java.lang.String projectKey,
                        java.lang.String buildKey,
                        @Context
                        javax.ws.rs.core.UriInfo uriInfo,
                        @Context
                        com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

getPlanAlias

public RestPlan getPlanAlias(java.lang.String projectKey,
                             java.lang.String buildKey,
                             @Context
                             javax.ws.rs.core.UriInfo uriInfo,
                             @Context
                             com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)