java.lang.Object
- com.atlassian.bamboo.plugins.rest.service.PlanRestServiceImpl

All Implemented Interfaces:: PlanRestService

@Component
public class PlanRestServiceImpl
extends Object
implements PlanRestService

Provides plan info for plugin

Constructor Summary

Constructors
Constructor	Description
`PlanRestServiceImpl(BambooCachingPermissionManagerFacadeFactory bambooCachingPermissionManagerFacadeFactory, BambooUserManager bambooUserManager, CachedPlanManager cachedPlanManager, LabelManager labelManager, PlanExecutionManager planExecutionManager, PlanManager planManager, ResultsSummaryManager resultsSummaryManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`assertPlanExistsAndVisible(@NotNull PlanKey planKey)`	Checks if `Plan` exists and is visible for calling user
`void`	`assertPlanExistsAndVisible(@NotNull PlanKey planKey, @NotNull Class<? extends ImmutablePlan> clazz)`	Checks if `Plan` exists, has correct type and is visible for calling user
`@Nullable RestBranchLatestActive`	`createLatestActiveBranchResult(ImmutablePlan branch)`
`RestPlanBranchList`	`createPaginatedBranchResponse(List<? extends ImmutablePlan> branches, @Nullable com.atlassian.user.User user, javax.ws.rs.core.UriInfo uriInfo, boolean allBranches)`
`RestPlans`	`createPaginatedPlanResponse(List<? extends ImmutablePlan> plans, @Nullable com.atlassian.user.User user, javax.ws.rs.core.UriInfo uriInfo)`
`@Nullable ImmutablePlan`	`getBranchByName(@NotNull ImmutablePlan plan, @NotNull String branchName)`	Get branch of a given plan by name.
`List<ImmutableChainBranch>`	`getBranchesForChain(ImmutablePlan plan)`
`List<ImmutableJob>`	`getBranchesForJob(ImmutableJob job)`
`@NotNull ImmutableChain`	`getChainByKey(@NotNull PlanKey planKey)`	Returns a `Plan` if plan exists and is visible for calling user
`List<ImmutableJob>`	`getJobsForPlan(@NotNull PlanKey planKey, @NotNull javax.ws.rs.core.UriInfo uriInfo, @NotNull com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)`	Get a list of jobs of specified plan.
`@NotNull ImmutablePlan`	`getPlanByKey(@NotNull PlanKey planKey)`	Returns a `Plan` if plan exists and is visible for calling user In clustered mode, there is NO consistency guarantee.
`ImmutablePlan`	`getPlanByKeyUnchecked(@NotNull PlanKey planKey)`	Returns a `Plan` if plan exists.
`@NotNull ImmutablePlan`	`getPlanByKeyWithHighConsistencyGuarantee(@NotNull PlanKey planKey)`	Returns a `Plan` if plan exists and is visible for calling user.
`List<ImmutablePlan>`	`getPlans(@NotNull javax.ws.rs.core.UriInfo uriInfo, @NotNull com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)`	Get a list of plans.
`<T extends ImmutablePlan> List<T>`	`getPlans(Class<T> planType, @NotNull javax.ws.rs.core.UriInfo uriInfo, @NotNull com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)`	Get a list of plans.
`List<ImmutablePlan>`	`getPlansByProject(@NotNull Project project, @NotNull javax.ws.rs.core.UriInfo uriInfo)`	Get a list of plans that belong to a project.
`List<ImmutablePlan>`	`getPlansByProject(@NotNull Project project, @NotNull javax.ws.rs.core.UriInfo uriInfo, @NotNull com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)`	Get a list of plans that belong to a project.
`List<ImmutablePlan>`	`getRunnablePlans(@NotNull Project project, @NotNull javax.ws.rs.core.UriInfo uriInfo)`	Get a list of plans that can be run currently logged in user.
`List<ImmutableChainStage>`	`getStagesForPlan(@NotNull PlanKey planKey, @NotNull javax.ws.rs.core.UriInfo uriInfo, @NotNull com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)`	Get a list of stages of specified plan.
`boolean`	`isPlanCreationAllowed()`	Check whether or not a plan can be created or not (based on licensing etc)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanRestServiceImpl

@Inject
public PlanRestServiceImpl(BambooCachingPermissionManagerFacadeFactory bambooCachingPermissionManagerFacadeFactory,
                           BambooUserManager bambooUserManager,
                           CachedPlanManager cachedPlanManager,
                           LabelManager labelManager,
                           PlanExecutionManager planExecutionManager,
                           PlanManager planManager,
                           ResultsSummaryManager resultsSummaryManager)

Method Detail

getBranchesForChain

public List<ImmutableChainBranch> getBranchesForChain(ImmutablePlan plan)

Specified by:: getBranchesForChain in interface PlanRestService

getBranchesForJob
```
public List<ImmutableJob> getBranchesForJob(ImmutableJob job)
```
Specified by:

getBranchesForJob in interface PlanRestService

createPaginatedPlanResponse

public RestPlans createPaginatedPlanResponse(List<? extends ImmutablePlan> plans,
                                             @Nullable
                                             @Nullable com.atlassian.user.User user,
                                             javax.ws.rs.core.UriInfo uriInfo)

Specified by:: createPaginatedPlanResponse in interface PlanRestService

createPaginatedBranchResponse

public RestPlanBranchList createPaginatedBranchResponse(List<? extends ImmutablePlan> branches,
                                                        @Nullable
                                                        @Nullable com.atlassian.user.User user,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        boolean allBranches)

Specified by:: createPaginatedBranchResponse in interface PlanRestService; allBranches - return all branches, even if expand has 'favourites' parameter. This is because 'favourites' is about plans not branches and all branches of a favourite plan are to be shown
Returns:: filtered list of branches

createLatestActiveBranchResult

@Nullable
public @Nullable RestBranchLatestActive createLatestActiveBranchResult(ImmutablePlan branch)

Specified by:: createLatestActiveBranchResult in interface PlanRestService

getBranchByName
```
@Nullable
public @Nullable ImmutablePlan getBranchByName(@NotNull
                                               @NotNull ImmutablePlan plan,
                                               @NotNull
                                               @NotNull String branchName)
```
Description copied from interface: PlanRestService

Get branch of a given plan by name. If passed plan is Chain method will look after properly named chain branch. If passed plan is a Job method will look after corresponding job in a found chain branch.

Specified by:

getBranchByName in interface PlanRestService

Parameters:

plan - plan

branchName - name of the branch to be fetched

Returns:

ImmutableChainBranch, ImmutableJob or null if not found

getPlans
```
public List<ImmutablePlan> getPlans(@NotNull
                                    @NotNull javax.ws.rs.core.UriInfo uriInfo,
                                    @NotNull
                                    @NotNull com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
```
Description copied from interface: PlanRestService

Get a list of plans. This method provides filtering using the following query params:

favourite

if specified return only favourite plans

permission

if specified return only plans that user has this specific permission for

type

if specifies return only plans of specified type

Specified by:

getPlans in interface PlanRestService

Returns:

Filtered list of plans belonging to a project.