com.atlassian.bamboo.deployments.environments.requirement

Class EnvironmentRequirementServiceImpl

java.lang.Object

com.atlassian.bamboo.deployments.environments.requirement.EnvironmentRequirementServiceImpl

All Implemented Interfaces:

EnvironmentRequirementService

public class EnvironmentRequirementServiceImpl
extends Object
implements EnvironmentRequirementService

Constructor Summary

Constructors

Constructor and Description

EnvironmentRequirementServiceImpl(com.atlassian.struts.TextProvider textProvider, AuditLogService auditLogService, com.atlassian.event.api.EventPublisher eventPublisher, CapabilityHelper capabilityHelper, TaskManager taskManager, ElasticFunctionalityFacade elasticFunctionalityFacade, ExecutableAgentsHelper executableAgentsHelper, EnvironmentService environmentService, EnvironmentDao environmentDao, PlanScheduler planScheduler)

Method Summary

Modifier and Type	Method and Description
ImmutableRequirement	addRequirement(long environmentId, String key, ImmutableRequirement.MatchType matchType, String matchValue) Add new requirement to an environment.
ExecutableAgentsMatrix	getExecutableAgentMatrixForEnvironment(long environmentId) retrieve all executable agents for a particular environment.
ImmutableRequirement	getRequirementForEnvironment(long environmentId, long requirementId) Get a single requirement for a environment.
List<? extends ImmutableRequirement>	getRequirementsForEnvironment(long environmentId) Get all requirements for environment.
void	removeRequirement(long environmentId, long requirementId) Remove a specific requirement
void	renameRequirement(CapabilityType capabilityType, String oldCapabilityKey, String newCapabilityLabel, boolean override) Updates capability key across all environments.
ImmutableRequirement	updateRequirement(long environmentId, long requirementId, String key, ImmutableRequirement.MatchType matchType, String matchValue) Update an existing requirement.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentRequirementServiceImpl

public EnvironmentRequirementServiceImpl(com.atlassian.struts.TextProvider textProvider,
                                         AuditLogService auditLogService,
                                         com.atlassian.event.api.EventPublisher eventPublisher,
                                         CapabilityHelper capabilityHelper,
                                         TaskManager taskManager,
                                         ElasticFunctionalityFacade elasticFunctionalityFacade,
                                         ExecutableAgentsHelper executableAgentsHelper,
                                         EnvironmentService environmentService,
                                         EnvironmentDao environmentDao,
                                         PlanScheduler planScheduler)

Method Detail

getRequirementsForEnvironment

@NotNull
public List<? extends ImmutableRequirement> getRequirementsForEnvironment(long environmentId)
                                                                            throws WebValidationException

Description copied from interface: EnvironmentRequirementService

Get all requirements for environment.

Specified by:

getRequirementsForEnvironment in interface EnvironmentRequirementService

Parameters:

environmentId - of environment

Returns:

RequirementSet for environment

Throws:

WebValidationException - if environmentId invalid

getExecutableAgentMatrixForEnvironment

@NotNull
public ExecutableAgentsMatrix getExecutableAgentMatrixForEnvironment(long environmentId)
                                                                       throws WebValidationException

Description copied from interface: EnvironmentRequirementService

retrieve all executable agents for a particular environment. Includes all disabled and offline agents/images.

Specified by:

getExecutableAgentMatrixForEnvironment in interface EnvironmentRequirementService

Parameters:

environmentId - of environment

Returns:

executableAgentMatrix (requirements to matching agents and images)

Throws:

WebValidationException

getRequirementForEnvironment

@NotNull
public ImmutableRequirement getRequirementForEnvironment(long environmentId,
                                                                  long requirementId)

Description copied from interface: EnvironmentRequirementService

Get a single requirement for a environment.

Specified by:

getRequirementForEnvironment in interface EnvironmentRequirementService

Parameters:

environmentId - of environment

requirementId - of requirement

Returns:

requirement

addRequirement

@NotNull
public ImmutableRequirement addRequirement(long environmentId,
                                                    @NotNull
                                                    String key,
                                                    @NotNull
                                                    ImmutableRequirement.MatchType matchType,
                                                    @Nullable
                                                    String matchValue)
                                             throws WebValidationException

Description copied from interface: EnvironmentRequirementService

Add new requirement to an environment.

Specified by:

addRequirement in interface EnvironmentRequirementService

Parameters:

environmentId - of environment

key - of requirement to match with the capability

matchType - e.g. exists, regex match, equals

matchValue - for regex and equals the value the requirement should match

Returns:

created requirement

Throws:

WebValidationException - for any data related error.

updateRequirement

@NotNull
public ImmutableRequirement updateRequirement(long environmentId,
                                                       long requirementId,
                                                       @NotNull
                                                       String key,
                                                       @NotNull
                                                       ImmutableRequirement.MatchType matchType,
                                                       @Nullable
                                                       String matchValue)
                                                throws WebValidationException

Description copied from interface: EnvironmentRequirementService

Update an existing requirement.

Specified by:

updateRequirement in interface EnvironmentRequirementService

Parameters:

environmentId - of environment

requirementId - if of the requirement being updated

key - of requirement to match with the capability

matchType - e.g. exists, regex match, equals

matchValue - for regex and equals the value the requirement should match

Returns:

updated requirement

Throws:

WebValidationException - for any data related error.

removeRequirement

public void removeRequirement(long environmentId,
                              long requirementId)
                       throws WebValidationException

Description copied from interface: EnvironmentRequirementService

Remove a specific requirement

Specified by:

removeRequirement in interface EnvironmentRequirementService

Parameters:

environmentId - of environment

requirementId - of requirement to remove

Throws:

WebValidationException - if requirement is not allowed to be removed

renameRequirement

public void renameRequirement(CapabilityType capabilityType,
                              String oldCapabilityKey,
                              String newCapabilityLabel,
                              boolean override)

Description copied from interface: EnvironmentRequirementService

Updates capability key across all environments.

Specified by:

renameRequirement in interface EnvironmentRequirementService

Parameters:

capabilityType - capability type

oldCapabilityKey - previous capability key, for example system.builder.mvn.Maven 3

newCapabilityLabel - new capability label, for example Maven 3 updated

override - existing values in case of conflict. If there is a conflict when entity already has capability with new label this flag indicates if it should be overridden or not.