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, DeploymentResultService deploymentResultService, com.atlassian.sal.api.message.I18nResolver i18nResolver, com.atlassian.event.api.EventPublisher eventPublisher, ElasticImageConfigurationManager elasticImageConfigurationManager)

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
javax.ws.rs.core.Response	removeAgentAssignmentFromEnvironment(long environmentId, String executorKey) Remove agent/image from list of dedicated executors 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,
                                     DeploymentResultService deploymentResultService,
                                     com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                     com.atlassian.event.api.EventPublisher eventPublisher,
                                     ElasticImageConfigurationManager elasticImageConfigurationManager)

Method Detail

getDeploymentResultList

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

Provide list of versions deployed to environment

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