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

Class AgentResource

java.lang.Object

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

@Path("config/agents")
@Produces("application/json")
@Consumes("application/json")
public class AgentResource
extends Object

Manage the REST endpoint for agent management

Since:

5.10

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REST_PATH

Constructor Summary

Constructors

Constructor	Description
AgentResource(RestAgentService restAgentService, RestPermissionCheck restPermissionCheck, AdministrationConfigurationService administrationConfigurationService, com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Summary

Modifier and Type	Method	Description
RestOfflineAgentRemovalConfig	getAgentAutomaticManagementConfiguration()
RestAgent	getAgentById(javax.ws.rs.core.UriInfo uriInfo, long agentId)
RestPageModel<RestAgent>	getAgents(javax.ws.rs.core.UriInfo uriInfo)
RestOfflineAgentRemovalConfig	setAgentAutomaticManagementConfiguration(@Nullable RestOfflineAgentRemovalConfig config)
RestAgent	updateRestAgent(javax.ws.rs.core.UriInfo uriInfo, long agentId, RestAgent restAgent)

Methods inherited from class java.lang.Object

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

Field Details

REST_PATH

public static final String REST_PATH

See Also:

• Constant Field Values

Constructor Details

AgentResource

@Inject
public AgentResource(RestAgentService restAgentService,
 RestPermissionCheck restPermissionCheck,
 AdministrationConfigurationService administrationConfigurationService,
 com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Details

getAgents

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

getAgentById

@GET
@Path("{agentId}")
public RestAgent getAgentById(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("agentId")
 long agentId)

updateRestAgent

@PUT
@Path("{agentId}")
public RestAgent updateRestAgent(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("agentId")
 long agentId,
 RestAgent restAgent)
                          throws WebValidationException

Throws:

WebValidationException

getAgentAutomaticManagementConfiguration

@GET
@Path("offlineAgentRemoval")
public RestOfflineAgentRemovalConfig getAgentAutomaticManagementConfiguration()
                                                                       throws UnauthorisedException

Throws:

UnauthorisedException

setAgentAutomaticManagementConfiguration

@PUT
@Path("offlineAgentRemoval")
public RestOfflineAgentRemovalConfig setAgentAutomaticManagementConfiguration(@Nullable
 @Nullable RestOfflineAgentRemovalConfig config)
                                                                       throws Exception

Throws:

Exception