com.atlassian.bamboo.plugins.rest.deployments.environments

Class DeploymentEnvironmentResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.deployments.environments.DeploymentEnvironmentResource

@Singleton
public class DeploymentEnvironmentResource
extends Object

Constructor Summary

Constructors

Constructor and Description

DeploymentEnvironmentResource(AgentAssignmentService agentAssignmentService, AgentManager agentManager, EnvironmentService environmentService, EnvironmentCustomConfigService environmentCustomConfigService, DeploymentResultService deploymentResultService, DeploymentProjectService deploymentProjectService, com.atlassian.sal.api.message.I18nResolver i18nResolver, com.atlassian.event.api.EventPublisher eventPublisher, ElasticImageConfigurationManager elasticImageConfigurationManager, EnvironmentRequirementService environmentRequirementService, VariableDefinitionManager variableDefinitionManager, AdministrationConfigurationAccessor administrationConfigurationAccessor, BambooPermissionManager bambooPermissionManager)

Method Summary

Modifier and Type	Method and Description
RestAgentAssignmentExecutorDetails	addAgentAssignmentForEnvironment(long environmentId, Map<String,String> agentAssignmentKey) Add agent assignment for environment.
List<RestAgentAssignmentExecutorDetails>	findAssignedAgentsByEnvironment(long environmentId) Provide list of agents/images assigned to given environment.
javax.ws.rs.core.Response	findPossibleAgentsForEnvironment(long environmentId, String searchTerm, javax.ws.rs.core.UriInfo uriInfo) Provide list of agents/images which can be dedicated for given environment.
RestDeploymentResultList	getDeploymentResultList(long environmentId, String expandParam, javax.ws.rs.core.UriInfo uriInfo) Provide list of versions deployed to environment.
RestDockerPipelineConfiguration	getDockerPipelinesConfiguration(long environmentId) Retrieves Docker configuration for given environment.
RestEnvironmentWithConfigCounts	getEnvironment(long environmentId) Provide summary of a single environment.
javax.ws.rs.core.Response	moveEnvironment(Long environmentId, String positionString, Long relativeEnvironmentId) Change environment position within deployment project.
javax.ws.rs.core.Response	removeAgentAssignmentFromEnvironment(long environmentId, String executorKey) Remove agent/image from list of dedicated executors for given environment.
javax.ws.rs.core.Response	saveDockerPipelinesConfiguration(long environmentId, RestDockerPipelineConfiguration restDockerPipelineConfiguration) Saves Docker configuration for given environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentEnvironmentResource

public DeploymentEnvironmentResource(AgentAssignmentService agentAssignmentService,
                                     AgentManager agentManager,
                                     EnvironmentService environmentService,
                                     EnvironmentCustomConfigService environmentCustomConfigService,
                                     DeploymentResultService deploymentResultService,
                                     DeploymentProjectService deploymentProjectService,
                                     com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                     com.atlassian.event.api.EventPublisher eventPublisher,
                                     ElasticImageConfigurationManager elasticImageConfigurationManager,
                                     EnvironmentRequirementService environmentRequirementService,
                                     VariableDefinitionManager variableDefinitionManager,
                                     AdministrationConfigurationAccessor administrationConfigurationAccessor,
                                     BambooPermissionManager bambooPermissionManager)

Method Detail

getEnvironment

public RestEnvironmentWithConfigCounts getEnvironment(long environmentId)

Provide summary of a single environment.

Parameters:

environmentId - environment id

Returns:

restEnvironmentWithConfigCount

getDeploymentResultList

public RestDeploymentResultList getDeploymentResultList(long environmentId,
                                                        String expandParam,
                                                        @Context
                                                        javax.ws.rs.core.UriInfo uriInfo)

Provide list of versions deployed to environment. Sorted by started date, newest first.

Parameters:

environmentId - deployment environment id

expandParam - expands deployment versions. Possible values are: results

uriInfo - uri info

Returns:

restDeploymentResultList

findAssignedAgentsByEnvironment

public List<RestAgentAssignmentExecutorDetails> findAssignedAgentsByEnvironment(long environmentId)

Provide list of agents/images assigned to given environment.

Parameters:

environmentId - environment id

Returns:

assigned agents

findPossibleAgentsForEnvironment

public javax.ws.rs.core.Response findPossibleAgentsForEnvironment(long environmentId,
                                                                  @Nullable
                                                                  String searchTerm,
                                                                  @Context
                                                                  javax.ws.rs.core.UriInfo uriInfo)

Provide list of agents/images which can be dedicated for given environment.

Parameters:

environmentId - environment id

searchTerm - part of the agent or image name to filter response. Use empty value to receive all agents/images.

uriInfo - uri info

Returns:

search result

addAgentAssignmentForEnvironment

public RestAgentAssignmentExecutorDetails addAgentAssignmentForEnvironment(long environmentId,
                                                                           Map<String,String> agentAssignmentKey)
                                                                    throws WebValidationException

Add agent assignment for environment. agentAssignmentKey is a map with one key-value: name - agentAssignmentKey. agentAssignmentKey is parsed by ExecutorKey.

Parameters:

environmentId - environment id

agentAssignmentKey - map with 'name' key which reference agent assignment key as value

Returns:

new agent assignment

Throws:

WebValidationException - if validation fails

removeAgentAssignmentFromEnvironment

public javax.ws.rs.core.Response removeAgentAssignmentFromEnvironment(long environmentId,
                                                                      String executorKey)
                                                               throws WebValidationException

Remove agent/image from list of dedicated executors for given environment.

Parameters:

environmentId - environment id

executorKey - key is parsed by ExecutorKey

Returns:

204 HTTP status when assignment was removed successfully.

Throws:

WebValidationException - if validation fails

getDockerPipelinesConfiguration

public RestDockerPipelineConfiguration getDockerPipelinesConfiguration(long environmentId)

Retrieves Docker configuration for given environment.

Parameters:

environmentId - environment id

saveDockerPipelinesConfiguration

public javax.ws.rs.core.Response saveDockerPipelinesConfiguration(long environmentId,
                                                                  RestDockerPipelineConfiguration restDockerPipelineConfiguration)

Saves Docker configuration for given environment.

Parameters:

environmentId - environment id

moveEnvironment

public javax.ws.rs.core.Response moveEnvironment(Long environmentId,
                                                 @Nullable
                                                 String positionString,
                                                 Long relativeEnvironmentId)
                                          throws WebValidationException,
                                                 NotFoundException

Change environment position within deployment project.

Parameters:

environmentId - environment id

positionString - position. Possible values: AFTER or BEFORE.

relativeEnvironmentId - environment id which referenced environment should be placed before or after.

Throws:

WebValidationException

NotFoundException