com.atlassian.bamboo.plugins.rest.admin.agent

Class AgentResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.agent.AgentResource

public class AgentResource
extends Object

Manage the REST endpoint for agent management

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static RestAgent	REST_AGENT
static String	REST_PATH

Constructor Summary

Constructors

Constructor and Description
AgentResource(RestAgentService restAgentService)

Method Summary

Modifier and Type	Method and Description
RestAgent	getAgentById(javax.ws.rs.core.UriInfo uriInfo, long agentId) Retrieve a build agent definition by id.
PageResponse<RestAgent>	getAgents(javax.ws.rs.core.UriInfo uriInfo) Return collection of all agents of all types.
RestAgent	updateRestAgent(javax.ws.rs.core.UriInfo uriInfo, long agentId, RestAgent restAgent) Update value of an agent

Methods inherited from class java.lang.Object

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

Field Detail

REST_PATH

public static final String REST_PATH

See Also:

Constant Field Values

REST_AGENT

public static final RestAgent REST_AGENT

Constructor Detail

AgentResource

public AgentResource(RestAgentService restAgentService)

Method Detail

getAgents

public PageResponse<RestAgent> getAgents(@Context
                                         javax.ws.rs.core.UriInfo uriInfo)

Return collection of all agents of all types.

Parameters:

uriInfo - Provides access to request URI information

Returns:

Collection of all agents

getAgentById

public RestAgent getAgentById(@Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              long agentId)

Retrieve a build agent definition by id.

Parameters:

uriInfo - Provides access to request URI information

agentId - Id of the agent

Returns:

Agent definition which contains, name, type, description and enabled

updateRestAgent

public RestAgent updateRestAgent(@Context
                                 javax.ws.rs.core.UriInfo uriInfo,
                                 long agentId,
                                 RestAgent restAgent)
                          throws WebValidationException

Update value of an agent

Parameters:

uriInfo - Provides access to request URI information

agentId - Id of the agent

restAgent - RestAgent that contains the update values.

Returns:

The update variable and a link to it

Throws:

WebValidationException - If an invalid agent defintion is given