Package com.atlassian.bamboo.plugins.rest.resource

Class AgentResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.AgentResource

@Path("agent")
@Produces("application/json")
@Consumes("application/json")
@Singleton
public class AgentResource
extends Object

Constructor Summary

Constructors

Constructor	Description
AgentResource(AgentCapabilityService agentCapabilityService, AgentExecutableService agentExecutableService, AgentManager agentManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, RestHelperWrapper restHelperWrapper)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createAgentCapability(long agentId, RestCapability createCapabilityRequest)
javax.ws.rs.core.Response	deleteAgent(long agentId)
javax.ws.rs.core.Response	deleteAgentCapability(long agentId, @NotNull String capabilityKey)
javax.ws.rs.core.Response	deleteAllAgentCapabilities(long agentId)
javax.ws.rs.core.Response	disableAgent(long agentId)
javax.ws.rs.core.Response	enableAgent(long agentId)
List<RestCapability>	getAgentCapabilities(long agentId, boolean includeShared)
RestAgentInformation	getAgentInformation(String expandParam, boolean includeShared, long agentId, javax.ws.rs.core.UriInfo uriInfo)
List<RestBuildAgent>	getAgents(Boolean online)
javax.ws.rs.core.Response	getAgentStatus(long agentId)
List<RestBuildAgent>	getRemoteAgents(Boolean online)
javax.ws.rs.core.Response	updateAgentCapability(long agentId, String capabilityKey, RestRemoteAgentCapability updateCapabilityRequest)

Methods inherited from class java.lang.Object

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

Constructor Details

AgentResource

@Inject
public AgentResource(AgentCapabilityService agentCapabilityService,
 AgentExecutableService agentExecutableService,
 AgentManager agentManager,
 com.atlassian.sal.api.message.I18nResolver i18nResolver,
 RestHelperWrapper restHelperWrapper)

Method Details

getAgents

@GET
public List<RestBuildAgent> getAgents(@QueryParam("online")
 Boolean online)

getAgentInformation

@GET
@Path("{agentId}")
public RestAgentInformation getAgentInformation(@QueryParam("expand")
 String expandParam,
 @QueryParam("includeShared")
 boolean includeShared,
 @PathParam("agentId")
 long agentId,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

getRemoteAgents

@GET
@Path("remote")
public List<RestBuildAgent> getRemoteAgents(@QueryParam("online")
 Boolean online)

getAgentStatus

@GET
@Path("{agentId}/status")
public javax.ws.rs.core.Response getAgentStatus(@PathParam("agentId")
 long agentId)
                                         throws org.acegisecurity.AccessDeniedException

Throws:

org.acegisecurity.AccessDeniedException

enableAgent

@PUT
@Path("{agentId}/enable")
public javax.ws.rs.core.Response enableAgent(@PathParam("agentId")
 long agentId)
                                      throws org.acegisecurity.AccessDeniedException,
NotFoundException

Throws:

org.acegisecurity.AccessDeniedException

NotFoundException

disableAgent

@PUT
@Path("{agentId}/disable")
public javax.ws.rs.core.Response disableAgent(@PathParam("agentId")
 long agentId)
                                       throws org.acegisecurity.AccessDeniedException,
NotFoundException

Throws:

org.acegisecurity.AccessDeniedException

NotFoundException

deleteAgent

@DELETE
@Path("{agentId}")
public javax.ws.rs.core.Response deleteAgent(@PathParam("agentId")
 long agentId)
                                      throws org.acegisecurity.AccessDeniedException,
WebValidationException

Throws:

org.acegisecurity.AccessDeniedException

WebValidationException

getAgentCapabilities

@GET
@Path("{agentId}/capability")
public List<RestCapability> getAgentCapabilities(@PathParam("agentId")
 long agentId,
 @QueryParam("includeShared")
 boolean includeShared)

createAgentCapability

@POST
@Path("{agentId}/capability")
public javax.ws.rs.core.Response createAgentCapability(@PathParam("agentId")
 long agentId,
 RestCapability createCapabilityRequest)
                                                throws WebValidationException

Throws:

WebValidationException

updateAgentCapability

@PUT
@Path("{agentId}/capability/{capabilityKey : (.+)?}")
public javax.ws.rs.core.Response updateAgentCapability(@PathParam("agentId")
 long agentId,
 @PathParam("capabilityKey")
 String capabilityKey,
 RestRemoteAgentCapability updateCapabilityRequest)
                                                throws WebValidationException

Throws:

WebValidationException

deleteAgentCapability

@DELETE
@Path("{agentId}/capability/{capabilityKey : (.+)?}")
public javax.ws.rs.core.Response deleteAgentCapability(@PathParam("agentId")
 long agentId,
 @NotNull @PathParam("capabilityKey")
 @NotNull String capabilityKey)
                                                throws NotFoundException

Throws:

NotFoundException

deleteAllAgentCapabilities

@DELETE
@Path("{agentId}/capability")
public javax.ws.rs.core.Response deleteAllAgentCapabilities(@PathParam("agentId")
 long agentId)
                                                     throws NotFoundException

Throws:

NotFoundException