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

Class EnvironmentRequirementResource

java.lang.Object

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

@ExperimentalApi
public class EnvironmentRequirementResource
extends Object

Provides RESTful operations on deployment environment requirements.

Since:

5.13

Field Summary

Fields

Modifier and Type	Field and Description
static RestAgentSummary	AGENT_SUMMARY
static RestRequirement	REQUIREMENT Used for REST documentation generation.
static List<RestRequirement>	REQUIREMENTS

Constructor Summary

Constructors

Constructor and Description
EnvironmentRequirementResource(EnvironmentRequirementService environmentRequirementService, BambooPermissionManager bambooPermissionManager, FeatureManager featureManager, LinkService linkService)

Method Summary

Modifier and Type	Method and Description
RestRequirement	addRequirementForEnvironment(long environmentId, RestRequirement requirement, javax.ws.rs.core.UriInfo uriInfo) Adds a requirement for a given environment.
RestAgentSummary	getAgentMatchesForEnvironment(long environmentId, javax.ws.rs.core.UriInfo uriInfo) Gets a summary of the agents that are capable of running an environment, based of its requirements.
RestAgentSummary	getDetailedAgentMatchesForEnvironment(long environmentId, javax.ws.rs.core.UriInfo uriInfo) Gets a detailed summary of the agents that are capable of running an environment, based of its requirements.
RestRequirement	getRequirementForEnvironment(long environmentId, long requirementId, javax.ws.rs.core.UriInfo uriInfo) Gets the details of a requirement for a given environment.
List<RestRequirement>	getRequirementsForEnvironment(long environmentId) Gets all the requirements of an environment.
javax.ws.rs.core.Response	removeRequirementFromEnvironment(long environmentId, long requirementId) Removes a requirement for an environment.
RestRequirement	updateRequirementForEnvironment(long environmentId, long requirementId, RestRequirement requirement, javax.ws.rs.core.UriInfo uriInfo) Updates a requirement for a given environment.

Methods inherited from class java.lang.Object

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

Field Detail

REQUIREMENT

public static final RestRequirement REQUIREMENT

Used for REST documentation generation.

REQUIREMENTS

public static final List<RestRequirement> REQUIREMENTS

AGENT_SUMMARY

public static final RestAgentSummary AGENT_SUMMARY

Constructor Detail

EnvironmentRequirementResource

public EnvironmentRequirementResource(EnvironmentRequirementService environmentRequirementService,
                                      BambooPermissionManager bambooPermissionManager,
                                      FeatureManager featureManager,
                                      LinkService linkService)

Method Detail

getAgentMatchesForEnvironment

public RestAgentSummary getAgentMatchesForEnvironment(long environmentId,
                                                      @Context
                                                      javax.ws.rs.core.UriInfo uriInfo)
                                               throws WebValidationException

Gets a summary of the agents that are capable of running an environment, based of its requirements.

Parameters:

environmentId - environment id

Returns:

RestAgentSummary

Throws:

WebValidationException

getDetailedAgentMatchesForEnvironment

public RestAgentSummary getDetailedAgentMatchesForEnvironment(long environmentId,
                                                              @Context
                                                              javax.ws.rs.core.UriInfo uriInfo)
                                                       throws WebValidationException

Gets a detailed summary of the agents that are capable of running an environment, based of its requirements.

Parameters:

environmentId - environment id

Returns:

RestAgentSummary

Throws:

WebValidationException

getRequirementsForEnvironment

public List<RestRequirement> getRequirementsForEnvironment(long environmentId)
                                                    throws WebValidationException

Gets all the requirements of an environment.

Parameters:

environmentId - environment id

Returns:

a list of RestRequirement

Throws:

WebValidationException

getRequirementForEnvironment

public RestRequirement getRequirementForEnvironment(long environmentId,
                                                    long requirementId,
                                                    @Context
                                                    javax.ws.rs.core.UriInfo uriInfo)
                                             throws WebValidationException

Gets the details of a requirement for a given environment.

Parameters:

environmentId - environment id

requirementId - unique identifier of the requirement to get details of

Returns:

RestRequirement

Throws:

WebValidationException

addRequirementForEnvironment

public RestRequirement addRequirementForEnvironment(long environmentId,
                                                    RestRequirement requirement,
                                                    @Context
                                                    javax.ws.rs.core.UriInfo uriInfo)
                                             throws WebValidationException

Adds a requirement for a given environment.

Parameters:

environmentId - environment id

requirement - a representation of the requirement

Returns:

RestRequirement

Throws:

WebValidationException

updateRequirementForEnvironment

public RestRequirement updateRequirementForEnvironment(long environmentId,
                                                       long requirementId,
                                                       RestRequirement requirement,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo)
                                                throws WebValidationException

Updates a requirement for a given environment.

Parameters:

environmentId - environment id

requirementId - requirement id of the requirement to update

requirement - an updated representation of the requirement

Returns:

RestRequirement

Throws:

WebValidationException

removeRequirementFromEnvironment

public javax.ws.rs.core.Response removeRequirementFromEnvironment(long environmentId,
                                                                  long requirementId)
                                                           throws WebValidationException

Removes a requirement for an environment.

Parameters:

environmentId - environment id

requirementId - requirement id of the requirement to delete

Returns:

Response an empty response

Throws:

WebValidationException