com.atlassian.bamboo.migration.plan
Class PlanManagerDecorator

java.lang.Object
  com.atlassian.bamboo.migration.plan.PlanManagerDecorator

All Implemented Interfaces:

PlanManager

Direct Known Subclasses:

RiggedPlanManager

public class PlanManagerDecorator
extends java.lang.Object
implements PlanManager

Pass-through decorator for PlanManager

Constructor Summary

PlanManagerDecorator(PlanManager planManager)

Method Summary

boolean	assertPlanPermission(PlanIdentifier plan) Used to validate user permission for plan.
void	createPlan(Plan plan) Same as savePlan, but create permissions used instead of edit permissions.
void	deletePlan(Plan plan) Removes the plan object from the database.
java.util.Set<ImmutableChain>	filterFavouritedPlans(java.util.Collection<? extends ImmutableChain> plans, com.atlassian.user.User user) Return a set of Plans that are a subset of the given TopLevelPlans collection that are favourited by the User
java.util.List<TopLevelPlan>	getAllPlans() Returns all TopLevelPlan's
<T extends Plan> java.util.List<T>	getAllPlans(java.lang.Class<T> planType) Returns all Plan's filtered by Class.
<T extends Plan> java.util.List<T>	getAllPlansByProject(Project project, java.lang.Class<T> planType) Returns all Plan's filtered by Project and Class, including the plans marked for deletion.
<T extends Plan> java.util.Collection<T>	getAllPlansMarkedForDeletion(java.lang.Class<T> planType) Returns a list of Plans that are com.atlassian.bamboo.plan.Plan#markForDeletion() for the given type
java.util.List<TopLevelPlan>	getAllPlansUnrestricted() Returns all TopLevelPlan's ignoring permissions
java.util.Set<ImmutableChain>	getFavouritePlans(com.atlassian.user.User user)
Plan	getPlanById(long id) Returns a Plan by its id
<T extends Plan> T	getPlanById(long id, java.lang.Class<T> planType) Returns a Plan by its id and Class
Plan	getPlanByKey(PlanKey planKey) Returns a Plan by its PlanKey
<T extends Plan> T	getPlanByKey(PlanKey planKey, java.lang.Class<T> planType) Returns a Plan by its PlanKey and Class
Plan	getPlanByKey(java.lang.String planKey) Returns a Plan by its planKey
<T extends Plan> T	getPlanByKey(java.lang.String planKey, java.lang.Class<T> planType) Returns a Plan by its planKey and Class
<T extends Plan> T	getPlanByKeyIfOfType(PlanKey planKey, java.lang.Class<T> planType) Returns a Plan by its planKey and if it's of the type Class.
<T extends Plan> T	getPlanByKeyIfOfType(java.lang.String planKey, java.lang.Class<T> planType) Returns a Plan by its planKey and if it's of the type Class.
<T extends Plan> T	getPlanByName(java.lang.String projectKey, java.lang.String planName, java.lang.Class<T> planType) Returns a Plan from a project with the given plan name and Class It is not possible to use this method if the planType parameter is a marker interface type such as Plan, Buildable or TopLevelPlan since it is possible to have a Chain and a Job that share the same name.
<T extends Plan> T	getPlanByPartialKeyAndName(PlanKey partialPlanKey, java.lang.String planName, java.lang.Class<T> planType) Returns a Plan that matches the start of the given PlanKey and the full plan name
Plan	getPlanByResultKey(PlanResultKey planResultKey) Returns a Plan by a PlanResultKey
<T extends Plan> T	getPlanByResultKey(PlanResultKey planResultKey, java.lang.Class<T> planType) Returns a Plan from a PlanResultKey and Class
java.lang.Class<? extends Plan>	getPlanClass(PlanKey planKey)
int	getPlanCount()
<T extends Plan> int	getPlanCount(java.lang.Class<T> planType) How many plans filtered by Class currently exist
PlanIdentifier	getPlanIdentifierForPermissionCheckingByKey(java.lang.String planKey) Returns a Plan skeleton skeleton providing ONLY id and key, that matches the given key This method should be used only for permission checking using Acegi If Job key is provided as a parameter, parent Chain will be returned anyway, as Acegi assertions are defined only for TopLevelPlans
<T extends Plan> java.util.List<PlanIdentifier>	getPlanIdentifiersForProject(ProjectIdentifier project, java.lang.Class<T> planType, boolean includeMarkedForDeletion) Retrieve a list of plans for a given project.
java.util.List<TopLevelPlan>	getPlansByProject(Project project) Returns all TopLevelPlan's filtered by Project
<T extends Plan> java.util.List<T>	getPlansByProject(Project project, java.lang.Class<T> planType) Returns all Plan's filtered by Project and Class
<T extends Plan> java.util.Map<Project,java.util.Collection<T>>	getProjectPlanMap(java.lang.Class<T> planType, boolean includeEmptyProjects) Return mapping of Project to Plan of given type
boolean	isChainNameConflicting(java.lang.String projectKey, long planIdToIgnore, java.lang.String planName) Verifies whether a Chain name is unique with the given project
boolean	isPlanCreationAllowed() Check whether or not a plan can be created or not (based on licensing etc)
java.util.Map<PlanKey,PlanKey>	movePlanToProject(Plan plan, Project project, java.lang.String newPlanKey, java.lang.String newBuildName) Moves plan to a selected project.
void	savePlan(Plan plan) Saves the Plan
void	setPlanSuspendedState(Plan plan, boolean newState) Persists enable/disable state of a plan.
void	triggerConfigUpdatedEventsForPlansInProject(Project project) Triggers updated events for every plan in a project regardless of permissions.
void	updateNamesAndDescription(java.lang.String projectName, java.lang.String buildName, java.lang.String description, Plan plan) Updates project and plan names and plan description.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanManagerDecorator

public PlanManagerDecorator(PlanManager planManager)

Method Detail

getPlanById

@Nullable
public Plan getPlanById(long id)
                 throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by its id

Specified by:

getPlanById in interface PlanManager

Parameters:

id - of the plan

Returns:

plan with the given id, null if it doesn't exist

Throws:

IncorrectPlanTypeException - if plan cannot be found

getPlanById

@Nullable
public <T extends Plan> T getPlanById(long id,
                                               java.lang.Class<T> planType)
                           throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by its id and Class

Specified by:

getPlanById in interface PlanManager

Parameters:

id - of the plan

planType - - the type of the plan to retrieve

Returns:

plan with the given id, if found AND is of the correct type.

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

getPlanByKey

@Nullable
public Plan getPlanByKey(@NotNull
                                  java.lang.String planKey)
                  throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by its planKey

Specified by:

getPlanByKey in interface PlanManager

Parameters:

planKey - of the plan to find

Returns:

plan by the id if found, otherwise null

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type (should never happen)

getPlanIdentifierForPermissionCheckingByKey

@Nullable
public PlanIdentifier getPlanIdentifierForPermissionCheckingByKey(@NotNull
                                                                           java.lang.String planKey)

Description copied from interface: PlanManager

Returns a Plan skeleton skeleton providing ONLY id and key, that matches the given key This method should be used only for permission checking using Acegi

If Job key is provided as a parameter, parent Chain will be returned anyway, as Acegi assertions are defined only for TopLevelPlans

Specified by:

getPlanIdentifierForPermissionCheckingByKey in interface PlanManager

Parameters:

planKey - of the plan to find

Returns:

plan by the id if found, otherwise null

getPlanClass

public java.lang.Class<? extends Plan> getPlanClass(@NotNull
                                                    PlanKey planKey)

Specified by:

getPlanClass in interface PlanManager

getPlanByKey

@Nullable
public <T extends Plan> T getPlanByKey(@NotNull
                                                java.lang.String planKey,
                                                java.lang.Class<T> planType)
                            throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by its planKey and Class

Specified by:

getPlanByKey in interface PlanManager

Parameters:

planKey - to search for

planType - - the type of the plan to retrieve

Returns:

plan with the given plan key, if found AND is of the correct type.

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

getPlanByKeyIfOfType

@Nullable
public <T extends Plan> T getPlanByKeyIfOfType(@NotNull
                                                        java.lang.String planKey,
                                                        @NotNull
                                                        java.lang.Class<T> planType)

Description copied from interface: PlanManager

Returns a Plan by its planKey and if it's of the type Class. Does not throw IncorrectPlanTypeException. Should only be used when the type of the plan can not be known.

Specified by:

getPlanByKeyIfOfType in interface PlanManager

Returns:

null if the plan doesn't exist, or it's not of the found type

getPlanByKeyIfOfType

@Nullable
public <T extends Plan> T getPlanByKeyIfOfType(@NotNull
                                                        PlanKey planKey,
                                                        @NotNull
                                                        java.lang.Class<T> planType)

Description copied from interface: PlanManager

Returns a Plan by its planKey and if it's of the type Class. Does not throw IncorrectPlanTypeException. Should only be used when the type of the plan can not be known.

Specified by:

getPlanByKeyIfOfType in interface PlanManager

Parameters:

planKey - to search for

planType - the type of the plan to retrieve

Returns:

null if the plan doesn't exist, or it's not of the found type

getPlanByKey

@Nullable
public Plan getPlanByKey(@NotNull
                                  PlanKey planKey)
                  throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by its PlanKey

Specified by:

getPlanByKey in interface PlanManager

Parameters:

planKey - to search for

Returns:

plan

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type (should never happen)

assertPlanPermission

public boolean assertPlanPermission(@NotNull
                                    PlanIdentifier plan)

Description copied from interface: PlanManager

Used to validate user permission for plan.

Specified by:

assertPlanPermission in interface PlanManager

Parameters:

plan - to check the permissions of

Returns:

true if the current user has read(?) permissions on the plan

getPlanByKey

@Nullable
public <T extends Plan> T getPlanByKey(@NotNull
                                                PlanKey planKey,
                                                java.lang.Class<T> planType)
                            throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by its PlanKey and Class

Specified by:

getPlanByKey in interface PlanManager

Parameters:

planKey - to search for

planType - - the type of the plan to retrieve

Returns:

plan with the given key, if found AND is of the correct type.

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

getPlanByResultKey

@Nullable
public Plan getPlanByResultKey(@NotNull
                                        PlanResultKey planResultKey)
                        throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan by a PlanResultKey

Specified by:

getPlanByResultKey in interface PlanManager

Parameters:

planResultKey - to look for the parent plan

Returns:

the parent plan for the given planResultKey

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type (should never happen)

getPlanByResultKey

@Nullable
public <T extends Plan> T getPlanByResultKey(@NotNull
                                                      PlanResultKey planResultKey,
                                                      java.lang.Class<T> planType)
                                  throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan from a PlanResultKey and Class

Specified by:

getPlanByResultKey in interface PlanManager

Parameters:

planResultKey - to look for the parent plan

planType - - the type of the plan to retrieve

Returns:

parent plan for the given planResultKey, if found AND is of the correct type.

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

getPlanByName

@Nullable
public <T extends Plan> T getPlanByName(@NotNull
                                                 java.lang.String projectKey,
                                                 @NotNull
                                                 java.lang.String planName,
                                                 java.lang.Class<T> planType)
                             throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan from a project with the given plan name and Class

It is not possible to use this method if the planType parameter is a marker interface type such as Plan, Buildable or TopLevelPlan since it is possible to have a Chain and a Job that share the same name.

Specified by:

getPlanByName in interface PlanManager

Parameters:

projectKey - of the project to look for the plan in

planName - - name of the plan inside the project: this is just the plan component of the name (i.e does not include the project component)

planType - - the type of the plan to retrieve

Returns:

plan with the given name and project key, if found, unique, AND is of the correct type.

Throws:

IncorrectPlanTypeException - if the result is not unique

isChainNameConflicting

public boolean isChainNameConflicting(@NotNull
                                      java.lang.String projectKey,
                                      long planIdToIgnore,
                                      @NotNull
                                      java.lang.String planName)

Description copied from interface: PlanManager

Verifies whether a Chain name is unique with the given project

Specified by:

isChainNameConflicting in interface PlanManager

Parameters:

projectKey - of the project to look for the plan in

planIdToIgnore - the id of the plan that has to be ignored during lookup (when you're saving a Plan, you should supply the plan id here)

planName - - name of the plan inside the project: this is just the plan component of the name (i.e does not include the project component)

Returns:

true if the name is in conflict

getPlanByPartialKeyAndName

@Nullable
public <T extends Plan> T getPlanByPartialKeyAndName(@NotNull
                                                              PlanKey partialPlanKey,
                                                              @NotNull
                                                              java.lang.String planName,
                                                              java.lang.Class<T> planType)
                                          throws IncorrectPlanTypeException

Description copied from interface: PlanManager

Returns a Plan that matches the start of the given PlanKey and the full plan name

Specified by:

getPlanByPartialKeyAndName in interface PlanManager

Parameters:

partialPlanKey - - the start of the plan key

planName - - name of the plan to search for: this is just the plan component of the name (i.e does not include the project component)

planType - - the type of the plan to retrieve

Returns:

plan with the given name, and partial key, if found AND is of the correct type

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

getAllPlans

@NotNull
public java.util.List<TopLevelPlan> getAllPlans()

Description copied from interface: PlanManager

Returns all TopLevelPlan's

Specified by:

getAllPlans in interface PlanManager

Returns:

plans

getAllPlansUnrestricted

public java.util.List<TopLevelPlan> getAllPlansUnrestricted()

Description copied from interface: PlanManager

Returns all TopLevelPlan's ignoring permissions

Specified by:

getAllPlansUnrestricted in interface PlanManager

Returns:

getAllPlans

@NotNull
public <T extends Plan> java.util.List<T> getAllPlans(java.lang.Class<T> planType)

Description copied from interface: PlanManager

Returns all Plan's filtered by Class. Does not include plans marked for deletion.

Specified by:

getAllPlans in interface PlanManager

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlansByProject

@NotNull
public java.util.List<TopLevelPlan> getPlansByProject(Project project)

Description copied from interface: PlanManager

Returns all TopLevelPlan's filtered by Project

Specified by:

getPlansByProject in interface PlanManager

Parameters:

project - - that the plans will belong to

Returns:

TopLevelPlan plans contained within the given project

getPlansByProject

@NotNull
public <T extends Plan> java.util.List<T> getPlansByProject(Project project,
                                                                    java.lang.Class<T> planType)

Description copied from interface: PlanManager

Returns all Plan's filtered by Project and Class

Specified by:

getPlansByProject in interface PlanManager

Parameters:

project - - that the plans will belong to

planType - - the type of the plan to retrieve

Returns:

plans contained within the given project and of the given type

getAllPlansByProject

@NotNull
public <T extends Plan> java.util.List<T> getAllPlansByProject(Project project,
                                                                       java.lang.Class<T> planType)

Description copied from interface: PlanManager

Returns all Plan's filtered by Project and Class, including the plans marked for deletion.

Specified by:

getAllPlansByProject in interface PlanManager

Parameters:

project - - that the plans will belong to

planType - - the type of the plan to retrieve

Returns:

plans contained within the given project and of the given type

getProjectPlanMap

@NotNull
public <T extends Plan> java.util.Map<Project,java.util.Collection<T>> getProjectPlanMap(java.lang.Class<T> planType,
                                                                                                 boolean includeEmptyProjects)

Description copied from interface: PlanManager

Return mapping of Project to Plan of given type

Specified by:

getProjectPlanMap in interface PlanManager

Parameters:

planType - type of plan to be selected from DB

includeEmptyProjects - should empty projects be included in result

Returns:

mapping of Project to Plan of given type

getPlanCount

public int getPlanCount()

Specified by:

getPlanCount in interface PlanManager

Returns:

How many Buildable's exists

getPlanCount

public <T extends Plan> int getPlanCount(java.lang.Class<T> planType)

Description copied from interface: PlanManager

How many plans filtered by Class currently exist

Specified by:

getPlanCount in interface PlanManager

Parameters:

planType - - the type of the plan to retrieve

Returns:

how many plans exist in the datbase

savePlan

public void savePlan(@NotNull
                     Plan plan)

Description copied from interface: PlanManager

Saves the Plan

Specified by:

savePlan in interface PlanManager

Parameters:

plan - to be saved

setPlanSuspendedState

public void setPlanSuspendedState(Plan plan,
                                  boolean newState)

Description copied from interface: PlanManager

Persists enable/disable state of a plan. Note that it will not persist the whole passed plan object, but only the value of isSuspendedFromBuilding field.

Specified by:

setPlanSuspendedState in interface PlanManager

Parameters:

plan - to be suspended/resumed

isPlanCreationAllowed

public boolean isPlanCreationAllowed()

Description copied from interface: PlanManager

Check whether or not a plan can be created or not (based on licensing etc)

Specified by:

isPlanCreationAllowed in interface PlanManager

Returns:

true if a plan can be created otherwise false;

updateNamesAndDescription

public void updateNamesAndDescription(@NotNull
                                      java.lang.String projectName,
                                      @NotNull
                                      java.lang.String buildName,
                                      @Nullable
                                      java.lang.String description,
                                      @NotNull
                                      Plan plan)

Description copied from interface: PlanManager

Updates project and plan names and plan description. All validation should have already occurred

Specified by:

updateNamesAndDescription in interface PlanManager

Parameters:

projectName - new name of the project

buildName - new name of the plan

description - new plan description

plan - to update the details of

createPlan

public void createPlan(Plan plan)

Description copied from interface: PlanManager

Same as savePlan, but create permissions used instead of edit permissions.

Specified by:

createPlan in interface PlanManager

deletePlan

public void deletePlan(Plan plan)

Description copied from interface: PlanManager

Removes the plan object from the database. Does not do any other clean up work at all Please use the PlanDeletionService rather than using this method directly

Specified by:

deletePlan in interface PlanManager

Parameters:

plan - to delete.

movePlanToProject

public java.util.Map<PlanKey,PlanKey> movePlanToProject(Plan plan,
                                                        Project project,
                                                        java.lang.String newPlanKey,
                                                        java.lang.String newBuildName)

Description copied from interface: PlanManager

Moves plan to a selected project. Rewrites plan's and (if applicable) jobs' keys accordingly. Does not migrate ResultsSummaries or files.

Specified by:

movePlanToProject in interface PlanManager

Parameters:

plan - - plan to be moved/renamed

project - - project plan should be moved to

newPlanKey - - new key for the plan (not a full key)

newBuildName - - new name for the plan

Returns:

- mapping between original and updated plan keys

getFavouritePlans

public java.util.Set<ImmutableChain> getFavouritePlans(@NotNull
                                                       com.atlassian.user.User user)

Specified by:

getFavouritePlans in interface PlanManager

filterFavouritedPlans

@NotNull
public java.util.Set<ImmutableChain> filterFavouritedPlans(@NotNull
                                                                   java.util.Collection<? extends ImmutableChain> plans,
                                                                   @NotNull
                                                                   com.atlassian.user.User user)

Description copied from interface: PlanManager

Return a set of Plans that are a subset of the given TopLevelPlans collection that are favourited by the User

Specified by:

filterFavouritedPlans in interface PlanManager

Parameters:

plans - to filter

user - to return the favourites of

Returns:

a set of Chains that are a subset of the given TopLevelPlans collection that are favourited by the User

getAllPlansMarkedForDeletion

@NotNull
public <T extends Plan> java.util.Collection<T> getAllPlansMarkedForDeletion(java.lang.Class<T> planType)

Description copied from interface: PlanManager

Returns a list of Plans that are com.atlassian.bamboo.plan.Plan#markForDeletion() for the given type

Specified by:

getAllPlansMarkedForDeletion in interface PlanManager

Returns:

plansMarkedForDeletion

getPlanIdentifiersForProject

@NotNull
public <T extends Plan> java.util.List<PlanIdentifier> getPlanIdentifiersForProject(ProjectIdentifier project,
                                                                                            java.lang.Class<T> planType,
                                                                                            boolean includeMarkedForDeletion)

Description copied from interface: PlanManager

Retrieve a list of plans for a given project. Only minimal data about the plans is returned.

Specified by:

getPlanIdentifiersForProject in interface PlanManager

Parameters:

project - to get plans for

planType - to filter plans by

includeMarkedForDeletion - set to true if you want to return plans marked for deletion

Returns:

PlanIdentifiers meeting the above criteria.

triggerConfigUpdatedEventsForPlansInProject

public void triggerConfigUpdatedEventsForPlansInProject(@NotNull
                                                        Project project)

Description copied from interface: PlanManager

Triggers updated events for every plan in a project regardless of permissions.

Specified by:

triggerConfigUpdatedEventsForPlansInProject in interface PlanManager

Parameters:

project - to trigger event for.