com.atlassian.bamboo.deployments.environments.service

Class EnvironmentServiceImpl

java.lang.Object

com.atlassian.bamboo.deployments.environments.service.EnvironmentServiceImpl

All Implemented Interfaces:

EnvironmentService

public class EnvironmentServiceImpl
extends Object
implements EnvironmentService

Field Summary

Fields inherited from interface com.atlassian.bamboo.deployments.environments.service.EnvironmentService

DEFAULT_ARTIFACT_TASK_NAME

Constructor Summary

Constructors

Constructor and Description

EnvironmentServiceImpl(BambooAclUpdateHelper aclUpdateHelper, HibernateMutableAclService aclService, AuditLogService auditLogService, BambooAuthenticationContext authenticationContext, DeploymentProjectDao deploymentProjectDao, EnvironmentDao environmentDao, EnvironmentRepositoryLinkDao environmentRepositoryLinkDao, PlanScheduler planScheduler, RepositoryDefinitionDao repositoryDefinitionDao, ScopedExclusionService scopedExclusionService, com.opensymphony.xwork2.TextProvider textProvider, ValidationService validationService, com.atlassian.event.api.EventPublisher eventPublisher, DeploymentVersionLinkedJiraIssueDao deploymentVersionLinkedJiraIssueDao, NotificationManager notificationManager, VariableConfigurationService variableConfigurationService, VariableDefinitionManager variableDefinitionManager, TriggerTypeManager triggerTypeManager, RepositoryDefinitionManager repositoryDefinitionManager)

Method Summary

Modifier and Type	Method and Description
Environment	addEnvironment(long deploymentProjectId, String name, String description) Creates a new environment in the specified deployment project.
void	addNotification(long environmentId, NotificationRule newRule) Adds a new notification to the environment notifications
Environment	cloneEnvironment(long deploymentProjectId, long environmentId, String name, String description) Create new environment as a clone of existing one
Environment	createImmutableEnvironment(MutableEnvironment mutableEnvironment) Converts mutable environment to immutable.
protected Environment	createOperationsAwareImmutableEnvironment(Environment environment)
Environment	createOperationsAwareImmutableEnvironment(MutableEnvironment environment) Create operation aware immutable environment
void	deleteNotification(long environmentId, long notificationId) Removes notification from the environment's notification set.
Environment	editEnvironment(long environmentId, String name, String description) Edit the details of an existing environment
Environment	findEnvironmentByName(long deploymentProjectId, String name) Find environment with specified name in a deployment project
Set<RequirementDeploymentMapping>	findEnvironmentsByRequirementKey(String requirementKey) Find environments which rely on requirementKey
Iterable<Environment>	getAllEnvironments() Retrieve all Environment defined in the system.
Collection<Environment>	getAllEnvironmentsForDashboard() Retrieve all Environment defined in the system.
Iterable<Environment>	getAllEnvironmentsNoUserContext() Retrieve all Environment defined in the system without filling in operations permitted for the user.
Environment	getEnvironment(long environmentId) Get specific environment by ID.
int	getEnvironmentCount()
int	getEnvironmentCountForProject(DeploymentProject deploymentProject)
Function<Environment,DecoratedEnvironment>	getEnvironmentDecorator() Create environment decorator function object.
List<EnvironmentRepositoryLink>	getEnvironmentRepositoryLinksForRepository(long repositoryId)
RequirementSet	getEnvironmentRequirementSet(long environmentId) Retrieve Agent Requirement set for environment, if environment with id exists.
List<Environment>	getEnvironmentsForDeploymentProject(long deploymentProjectId) Get all environments for a particular deployment project.
List<EnvironmentStub>	getEnvironmentStubsForDeploymentProject(long deploymentProjectId) Get all environment stubs for a particular deployment project.
List<EnvironmentRepositoryLink>	getEnvironmentsUsingRepository(long repositoryId)
List<Environment>	getEnvironmentsUsingRepositoryDataEntity(long repositoryId) TODO 6.0 rename to getEnvironmentsUsingRepository
Environment	getEnvironmentUnrestricted(long environmentId) Get specific environment by ID.
NotificationSet	getNotificationSet(long environmentId) Retrieve notification set for environment, if environment with id exists.
PaginatedEnvironmentsForDashboard	getPaginatedEnvironmentsForDeploymentProject(long deploymentProjectId, int start, int limit, String filter) Get paginated environments for a particular deployment project ordered by position.
List<PlanRepositoryDefinition>	getPlanRepositoryDefinitionsForEnvironment(Environment environment) Retrieves all repositories used in environment source checkout tasks
List<PlanRepositoryDefinition>	getPlanRepositoryDefinitionsForEnvironment(InternalEnvironment environment) Retrieves all repositories used in environment source checkout tasks
List<RepositoryDefinition>	getRepositoryDefinitionsForEnvironment(Environment environment) Retrieves all repositories used in environment source checkout tasks
ErrorCollection	moveEnvironment(MoveEnvironmentStrategy moveEnvironmentStrategy, long deploymentProjectId, long environmentId, int currentPosition, Optional<Long> relatedEnvId) Move Environment in given deploymentProject with given strategy.
ErrorCollection	moveEnvironmentDown(long deploymentProjectId, long environmentId, int currentPosition) Moves an environment down the list
ErrorCollection	moveEnvironmentUp(long deploymentProjectId, long environmentId, int currentPosition) Moves an environment up the list
void	removeRepositoryFromEnvironment(EnvironmentRepositoryLink environmentRepository) Remove EnvironmentRepositoryLink from environment
void	replaceNotification(long environmentId, long oldNotificationId, NotificationRule newRule) Replaces notification in the environment's notification set.
void	resetTriggersForDeployment(long deploymentProjectId) Delete and recreate triggers for all environments for this deployment
void	restartAllTriggeringForDeploymentProject(long deploymentProjectId) Restart all automatic triggering on every Environment related to a DeploymentProject.
void	startAllTriggers(Environment environment) Start all automatic triggering on InternalEnvironment
void	startAllTriggersForDeploymentProject(long deploymentProjectId) Start all automatic triggering on every Environment related to a DeploymentProject
void	stopAllTriggers(Environment environment) Stop all automatic triggering on InternalEnvironment
void	stopAllTriggersForDeploymentProject(long deploymentProjectId) Stop all automatic triggering on every Environment related to a DeploymentProject
void	updateEnvironmentConfigurationState(long environmentId, ConfigurationState configurationState) Update the configurationState of this environment
void	updatePlanKey(long deploymentProjectId, PlanKey originalPlanKey, PlanKey newPlanKey) Update planKey in Environment related configuration when plan key has changed (ie after moving plan).
RepositoryDefinition	updateRepositoryLinkInEnvironment(EnvironmentRepositoryLink environmentRepositoryLink, RepositoryDataEntity newRepositoryEntity) Update EnvironmentRepositoryLink data
ErrorCollection	validateAddEnvironment(long deploymentProjectId, String name, String description) Validates values to be used for creating a new environment.
ErrorCollection	validateEditEnvironment(long environmentId, String name, String description) Validates values to be used when editing existing environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentServiceImpl

public EnvironmentServiceImpl(BambooAclUpdateHelper aclUpdateHelper,
                              HibernateMutableAclService aclService,
                              AuditLogService auditLogService,
                              BambooAuthenticationContext authenticationContext,
                              DeploymentProjectDao deploymentProjectDao,
                              EnvironmentDao environmentDao,
                              EnvironmentRepositoryLinkDao environmentRepositoryLinkDao,
                              PlanScheduler planScheduler,
                              RepositoryDefinitionDao repositoryDefinitionDao,
                              ScopedExclusionService scopedExclusionService,
                              com.opensymphony.xwork2.TextProvider textProvider,
                              ValidationService validationService,
                              com.atlassian.event.api.EventPublisher eventPublisher,
                              DeploymentVersionLinkedJiraIssueDao deploymentVersionLinkedJiraIssueDao,
                              NotificationManager notificationManager,
                              VariableConfigurationService variableConfigurationService,
                              VariableDefinitionManager variableDefinitionManager,
                              TriggerTypeManager triggerTypeManager,
                              RepositoryDefinitionManager repositoryDefinitionManager)

Method Detail

getEnvironmentsForDeploymentProject

@NotNull
public List<Environment> getEnvironmentsForDeploymentProject(long deploymentProjectId)

Description copied from interface: EnvironmentService

Get all environments for a particular deployment project. Does not validate deployment project actually exists.

Specified by:

getEnvironmentsForDeploymentProject in interface EnvironmentService

Parameters:

deploymentProjectId - of the deployment project to get environments for

Returns:

List of environments for a single deployment project. Sorted by position, name.

getPaginatedEnvironmentsForDeploymentProject

@NotNull
public PaginatedEnvironmentsForDashboard getPaginatedEnvironmentsForDeploymentProject(long deploymentProjectId,
                                                                                               int start,
                                                                                               int limit,
                                                                                               @Nullable
                                                                                               String filter)

Description copied from interface: EnvironmentService

Get paginated environments for a particular deployment project ordered by position. Does not validate deployment project actually exists. Filtering requires at least one character. If filter is null or empty then no filtering.

Specified by:

getPaginatedEnvironmentsForDeploymentProject in interface EnvironmentService

Parameters:

deploymentProjectId - of the deployment project to get environments for

start - start by index

limit - return no more entries than limit

filter - filter

Returns:

List of environments for a single deployment project. Sorted by position.

See Also:

InternalEnvironment.getPosition()

getEnvironmentStubsForDeploymentProject

@NotNull
public List<EnvironmentStub> getEnvironmentStubsForDeploymentProject(long deploymentProjectId)

Description copied from interface: EnvironmentService

Get all environment stubs for a particular deployment project. Does not validate deployment project actually exists. Returns minimum data set required for rendering on deployment project pages.

Specified by:

getEnvironmentStubsForDeploymentProject in interface EnvironmentService

Parameters:

deploymentProjectId - of the deployment project to get environments for

Returns:

List of environments for a single deployment project. Sorted by position, name.

getEnvironmentUnrestricted

@Nullable
public Environment getEnvironmentUnrestricted(long environmentId)

Description copied from interface: EnvironmentService

Get specific environment by ID. Does not check permissions.

Specified by:

getEnvironmentUnrestricted in interface EnvironmentService

Parameters:

environmentId - ID to search for

Returns:

environment with given ID or null if one could not be found.

getEnvironment

@Nullable
public Environment getEnvironment(long environmentId)
                                     throws org.acegisecurity.AccessDeniedException

Description copied from interface: EnvironmentService

Get specific environment by ID.

Specified by:

getEnvironment in interface EnvironmentService

Parameters:

environmentId - ID to search for

Returns:

environment with given ID or null if one could not be found.

Throws:

org.acegisecurity.AccessDeniedException - when user doesn't have permissions to view environment

findEnvironmentByName

@Nullable
public Environment findEnvironmentByName(long deploymentProjectId,
                                                   String name)

Description copied from interface: EnvironmentService

Find environment with specified name in a deployment project

Specified by:

findEnvironmentByName in interface EnvironmentService

getAllEnvironments

@NotNull
public Iterable<Environment> getAllEnvironments()

Description copied from interface: EnvironmentService

Retrieve all Environment defined in the system. The result is filtered by environment permissions and sorted by deployment project id and environment position. Environments belonging to inaccessible projects are not currently filtered out, but their operations show them to be inaccessible.

Specified by:

getAllEnvironments in interface EnvironmentService

getAllEnvironmentsForDashboard

@NotNull
public Collection<Environment> getAllEnvironmentsForDashboard()

Description copied from interface: EnvironmentService

Retrieve all Environment defined in the system. The result is filtered by environment permissions and sorted by deployment project id and environment position. Environments belonging to inaccessible projects are not currently filtered out, but their operations show them to be inaccessible. Some data inside the object may be unavailable.

Specified by:

getAllEnvironmentsForDashboard in interface EnvironmentService

getAllEnvironmentsNoUserContext

@NotNull
public Iterable<Environment> getAllEnvironmentsNoUserContext()

Description copied from interface: EnvironmentService

Retrieve all Environment defined in the system without filling in operations permitted for the user.

Specified by:

getAllEnvironmentsNoUserContext in interface EnvironmentService

createImmutableEnvironment

@NotNull
public Environment createImmutableEnvironment(@NotNull
                                                       MutableEnvironment mutableEnvironment)

Description copied from interface: EnvironmentService

Converts mutable environment to immutable.

Specified by:

createImmutableEnvironment in interface EnvironmentService

createOperationsAwareImmutableEnvironment

@NotNull
protected Environment createOperationsAwareImmutableEnvironment(Environment environment)

createOperationsAwareImmutableEnvironment

@NotNull
public Environment createOperationsAwareImmutableEnvironment(@NotNull
                                                                      MutableEnvironment environment)

Description copied from interface: EnvironmentService

Create operation aware immutable environment

Specified by:

createOperationsAwareImmutableEnvironment in interface EnvironmentService

See Also:

Operations

validateAddEnvironment

@NotNull
public ErrorCollection validateAddEnvironment(long deploymentProjectId,
                                                       @Nullable
                                                       String name,
                                                       @Nullable
                                                       String description)

Description copied from interface: EnvironmentService

Validates values to be used for creating a new environment.

Specified by:

validateAddEnvironment in interface EnvironmentService

Returns:

errorCollection containing any errors found. If no errors, an empty errorCollection will be returned.

addEnvironment

@NotNull
public Environment addEnvironment(long deploymentProjectId,
                                           @Nullable
                                           String name,
                                           @Nullable
                                           String description)
                                    throws WebValidationException

Description copied from interface: EnvironmentService

Creates a new environment in the specified deployment project.

Specified by:

addEnvironment in interface EnvironmentService

Parameters:

deploymentProjectId - to create environment in

name - of the environment.

description - of the environment.

Throws:

WebValidationException

cloneEnvironment

@NotNull
public Environment cloneEnvironment(long deploymentProjectId,
                                             long environmentId,
                                             @Nullable
                                             String name,
                                             @Nullable
                                             String description)
                                      throws WebValidationException

Description copied from interface: EnvironmentService

Create new environment as a clone of existing one

Specified by:

cloneEnvironment in interface EnvironmentService

Returns:

Throws:

WebValidationException - when user has no permission to clone environment with dedicated agents or deployment/environment not found

validateEditEnvironment

@NotNull
public ErrorCollection validateEditEnvironment(long environmentId,
                                                        @Nullable
                                                        String name,
                                                        @Nullable
                                                        String description)

Description copied from interface: EnvironmentService

Validates values to be used when editing existing environment.

Specified by:

validateEditEnvironment in interface EnvironmentService

Parameters:

environmentId - environment to edit

name - of the environment

description - of the environment

Returns:

errorCollection containing any errors found. If no errors, an empty errorCollection will be returned.

editEnvironment

@NotNull
public Environment editEnvironment(long environmentId,
                                            String name,
                                            String description)
                                     throws WebValidationException

Description copied from interface: EnvironmentService

Edit the details of an existing environment

Specified by:

editEnvironment in interface EnvironmentService

Parameters:

environmentId - environment to edit

name - of the environment

description - of the environment

Returns:

the updated environment

Throws:

WebValidationException

updateEnvironmentConfigurationState

public void updateEnvironmentConfigurationState(long environmentId,
                                                @NotNull
                                                ConfigurationState configurationState)

Description copied from interface: EnvironmentService

Update the configurationState of this environment

Specified by:

updateEnvironmentConfigurationState in interface EnvironmentService

Parameters:

environmentId - of environment to update

configurationState - new configuration state

getEnvironmentRequirementSet

@Nullable
public RequirementSet getEnvironmentRequirementSet(long environmentId)

Description copied from interface: EnvironmentService

Retrieve Agent Requirement set for environment, if environment with id exists.

Specified by:

getEnvironmentRequirementSet in interface EnvironmentService

Parameters:

environmentId - of environment

Returns:

all requirements this environment has.

getRepositoryDefinitionsForEnvironment

@NotNull
public List<RepositoryDefinition> getRepositoryDefinitionsForEnvironment(@NotNull
                                                                                  Environment environment)

Description copied from interface: EnvironmentService

Retrieves all repositories used in environment source checkout tasks

Specified by:

getRepositoryDefinitionsForEnvironment in interface EnvironmentService

Returns:

getPlanRepositoryDefinitionsForEnvironment

@NotNull
public List<PlanRepositoryDefinition> getPlanRepositoryDefinitionsForEnvironment(@NotNull
                                                                                          Environment environment)

Description copied from interface: EnvironmentService

Retrieves all repositories used in environment source checkout tasks

Specified by:

getPlanRepositoryDefinitionsForEnvironment in interface EnvironmentService

Returns:

getPlanRepositoryDefinitionsForEnvironment

@NotNull
public List<PlanRepositoryDefinition> getPlanRepositoryDefinitionsForEnvironment(@NotNull
                                                                                          InternalEnvironment environment)

Description copied from interface: EnvironmentService

Retrieves all repositories used in environment source checkout tasks

Specified by:

getPlanRepositoryDefinitionsForEnvironment in interface EnvironmentService

Returns:

getEnvironmentsUsingRepository

public List<EnvironmentRepositoryLink> getEnvironmentsUsingRepository(long repositoryId)

Specified by:

getEnvironmentsUsingRepository in interface EnvironmentService

getEnvironmentRepositoryLinksForRepository

public List<EnvironmentRepositoryLink> getEnvironmentRepositoryLinksForRepository(long repositoryId)

Specified by:

getEnvironmentRepositoryLinksForRepository in interface EnvironmentService

Parameters:

repositoryId - repository id

Returns:

list of Source Repository relationships defined for the given repository

getEnvironmentsUsingRepositoryDataEntity

public List<Environment> getEnvironmentsUsingRepositoryDataEntity(long repositoryId)

Description copied from interface: EnvironmentService

TODO 6.0 rename to getEnvironmentsUsingRepository

Specified by:

getEnvironmentsUsingRepositoryDataEntity in interface EnvironmentService

Parameters:

repositoryId - repository id

Returns:

list of immutable Environments that use given repository

removeRepositoryFromEnvironment

public void removeRepositoryFromEnvironment(@NotNull
                                            EnvironmentRepositoryLink environmentRepository)

Description copied from interface: EnvironmentService

Remove EnvironmentRepositoryLink from environment

Specified by:

removeRepositoryFromEnvironment in interface EnvironmentService

updateRepositoryLinkInEnvironment

public RepositoryDefinition updateRepositoryLinkInEnvironment(EnvironmentRepositoryLink environmentRepositoryLink,
                                                              RepositoryDataEntity newRepositoryEntity)

Description copied from interface: EnvironmentService

Update EnvironmentRepositoryLink data

Specified by:

updateRepositoryLinkInEnvironment in interface EnvironmentService

Returns:

addNotification

public void addNotification(long environmentId,
                            @NotNull
                            NotificationRule newRule)
                     throws WebValidationException

Description copied from interface: EnvironmentService

Adds a new notification to the environment notifications

Specified by:

addNotification in interface EnvironmentService

Throws:

WebValidationException

getNotificationSet

public NotificationSet getNotificationSet(long environmentId)

Description copied from interface: EnvironmentService

Retrieve notification set for environment, if environment with id exists.

Specified by:

getNotificationSet in interface EnvironmentService

Parameters:

environmentId - of environment

deleteNotification

public void deleteNotification(long environmentId,
                               long notificationId)
                        throws WebValidationException

Description copied from interface: EnvironmentService

Removes notification from the environment's notification set.

Specified by:

deleteNotification in interface EnvironmentService

Throws:

WebValidationException

replaceNotification

public void replaceNotification(long environmentId,
                                long oldNotificationId,
                                @NotNull
                                NotificationRule newRule)
                         throws WebValidationException

Description copied from interface: EnvironmentService

Replaces notification in the environment's notification set.

Specified by:

replaceNotification in interface EnvironmentService

Throws:

WebValidationException

stopAllTriggers

public void stopAllTriggers(@NotNull
                            Environment environment)

Description copied from interface: EnvironmentService

Stop all automatic triggering on InternalEnvironment

Specified by:

stopAllTriggers in interface EnvironmentService

startAllTriggers

public void startAllTriggers(@NotNull
                             Environment environment)

Description copied from interface: EnvironmentService

Start all automatic triggering on InternalEnvironment

Specified by:

startAllTriggers in interface EnvironmentService

stopAllTriggersForDeploymentProject

public void stopAllTriggersForDeploymentProject(long deploymentProjectId)

Description copied from interface: EnvironmentService

Stop all automatic triggering on every Environment related to a DeploymentProject

Specified by:

stopAllTriggersForDeploymentProject in interface EnvironmentService

startAllTriggersForDeploymentProject

public void startAllTriggersForDeploymentProject(long deploymentProjectId)

Description copied from interface: EnvironmentService

Start all automatic triggering on every Environment related to a DeploymentProject

Specified by:

startAllTriggersForDeploymentProject in interface EnvironmentService

restartAllTriggeringForDeploymentProject

public void restartAllTriggeringForDeploymentProject(long deploymentProjectId)

Description copied from interface: EnvironmentService

Restart all automatic triggering on every Environment related to a DeploymentProject. When using this method please keep in mind that triggers should be stopped before modifying their configuration and restarted afterwards. Thus EnvironmentService.stopAllTriggersForDeploymentProject(long) and EnvironmentService.startAllTriggersForDeploymentProject(long) might be more useful.

Specified by:

restartAllTriggeringForDeploymentProject in interface EnvironmentService

moveEnvironmentUp

@NotNull
public ErrorCollection moveEnvironmentUp(long deploymentProjectId,
                                                  long environmentId,
                                                  int currentPosition)

Description copied from interface: EnvironmentService

Moves an environment up the list

Specified by:

moveEnvironmentUp in interface EnvironmentService

moveEnvironmentDown

@NotNull
public ErrorCollection moveEnvironmentDown(long deploymentProjectId,
                                                    long environmentId,
                                                    int currentPosition)

Description copied from interface: EnvironmentService

Moves an environment down the list

Specified by:

moveEnvironmentDown in interface EnvironmentService

moveEnvironment

public ErrorCollection moveEnvironment(MoveEnvironmentStrategy moveEnvironmentStrategy,
                                       long deploymentProjectId,
                                       long environmentId,
                                       int currentPosition,
                                       Optional<Long> relatedEnvId)

Description copied from interface: EnvironmentService

Move Environment in given deploymentProject with given strategy. relatedEnvId is optional for most cases. It is only required for strategy MoveEnvironmentStrategy.AFTER or MoveEnvironmentStrategy.BEFORE

Specified by:

moveEnvironment in interface EnvironmentService

Returns:

error collection

getEnvironmentCount

public int getEnvironmentCount()

Specified by:

getEnvironmentCount in interface EnvironmentService

Returns:

number of all environments

getEnvironmentCountForProject

public int getEnvironmentCountForProject(DeploymentProject deploymentProject)

Specified by:

getEnvironmentCountForProject in interface EnvironmentService

Returns:

number of environments defined for project

updatePlanKey

public void updatePlanKey(long deploymentProjectId,
                          @NotNull
                          PlanKey originalPlanKey,
                          @NotNull
                          PlanKey newPlanKey)

Description copied from interface: EnvironmentService

Update planKey in Environment related configuration when plan key has changed (ie after moving plan). This method is called by DeploymentProjectService.updatePlanKey(PlanKey, PlanKey) after DeploymentProject has been updated.

Specified by:

updatePlanKey in interface EnvironmentService

Parameters:

deploymentProjectId - id of deployment project which environments have to be checked

originalPlanKey - original PlanKey

newPlanKey - new PlanKey

resetTriggersForDeployment

public void resetTriggersForDeployment(long deploymentProjectId)

Description copied from interface: EnvironmentService

Delete and recreate triggers for all environments for this deployment

Specified by:

resetTriggersForDeployment in interface EnvironmentService

getEnvironmentDecorator

public Function<Environment,DecoratedEnvironment> getEnvironmentDecorator()

Description copied from interface: EnvironmentService

Create environment decorator function object. Instances should be used for a single stream operation and should not live long.

Specified by:

getEnvironmentDecorator in interface EnvironmentService

findEnvironmentsByRequirementKey

@NotNull
public Set<RequirementDeploymentMapping> findEnvironmentsByRequirementKey(@NotNull
                                                                                   String requirementKey)

Description copied from interface: EnvironmentService

Find environments which rely on requirementKey

Specified by:

findEnvironmentsByRequirementKey in interface EnvironmentService

Parameters:

requirementKey - on which environments rely

Returns:

environments or empty set