com.atlassian.bamboo.plugins.rest.resource

Class AgentResource

java.lang.Object

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

@Singleton
public class AgentResource
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createAgentCapability(long agentId, RestCapability createCapabilityRequest) Create new agent capability.
javax.ws.rs.core.Response	deleteAgent(long agentId) Remove build agent.
javax.ws.rs.core.Response	deleteAgentCapability(long agentId, String capabilityKey) Remove build agent capability.
javax.ws.rs.core.Response	deleteAllAgentCapabilities(long agentId) Remove all capabilities of build agent.
javax.ws.rs.core.Response	disableAgent(long agentId) Disables an agent.
javax.ws.rs.core.Response	enableAgent(long agentId) Enables an agent.
List<RestCapability>	getAgentCapabilities(long agentId, boolean includeShared) List agent's capabilities.
RestAgentInformation	getAgentInformation(String expandParam, boolean includeShared, long agentId, javax.ws.rs.core.UriInfo uriInfo) Provides details of an agent with given id.
List<RestBuildAgent>	getAgents(Boolean online) Provides a list of all agents.
javax.ws.rs.core.Response	getAgentStatus(long agentId) Provides information about status of agent, if it's online or offline.
List<RestBuildAgent>	getRemoteAgents(Boolean online) Provides a list of all agent authentication statuses.
javax.ws.rs.core.Response	updateAgentCapability(long agentId, String capabilityKey, RestRemoteAgentCapability updateCapabilityRequest) Update existing agent capability.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentResource

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

Method Detail

getAgents

public List<RestBuildAgent> getAgents(Boolean online)

Provides a list of all agents. Use query parameter "online = true/false" to filter only online agents.

getAgentInformation

public RestAgentInformation getAgentInformation(String expandParam,
                                                boolean includeShared,
                                                long agentId,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)

Provides details of an agent with given id.

Parameters:

agentId - agent id

includeShared - if response should include shared agent capabilities.

getRemoteAgents

public List<RestBuildAgent> getRemoteAgents(Boolean online)

Provides a list of all agent authentication statuses. Use query parameter "online = true/false" to filter only remote or only approved agents.

getAgentStatus

public javax.ws.rs.core.Response getAgentStatus(long agentId)
                                         throws org.acegisecurity.AccessDeniedException

Provides information about status of agent, if it's online or offline.

Parameters:

agentId - agent id

Throws:

org.acegisecurity.AccessDeniedException

enableAgent

public javax.ws.rs.core.Response enableAgent(long agentId)
                                      throws org.acegisecurity.AccessDeniedException,
                                             NotFoundException

Enables an agent.

Parameters:

agentId - agent id

Throws:

org.acegisecurity.AccessDeniedException

NotFoundException

disableAgent

public javax.ws.rs.core.Response disableAgent(long agentId)
                                       throws org.acegisecurity.AccessDeniedException,
                                              NotFoundException

Disables an agent.

Parameters:

agentId - agent id

Throws:

org.acegisecurity.AccessDeniedException

NotFoundException

deleteAgent

public javax.ws.rs.core.Response deleteAgent(long agentId)
                                      throws org.acegisecurity.AccessDeniedException,
                                             WebValidationException

Remove build agent.

Parameters:

agentId - agent id

Throws:

org.acegisecurity.AccessDeniedException

WebValidationException

getAgentCapabilities

public List<RestCapability> getAgentCapabilities(long agentId,
                                                 boolean includeShared)

List agent's capabilities. User should be logged in.

Parameters:

agentId - agent id

includeShared - if response should include shared agent capabilities.

createAgentCapability

public javax.ws.rs.core.Response createAgentCapability(long agentId,
                                                       RestCapability createCapabilityRequest)
                                                throws WebValidationException

Create new agent capability. Only restricted admin or system admin can use it.

Parameters:

agentId - agent id

createCapabilityRequest - new capability.

Throws:

WebValidationException

updateAgentCapability

public javax.ws.rs.core.Response updateAgentCapability(long agentId,
                                                       String capabilityKey,
                                                       RestRemoteAgentCapability updateCapabilityRequest)
                                                throws WebValidationException

Update existing agent capability. Only restricted admin or system admin can use it. It's allowed to skip capability key at request payload.

Parameters:

agentId - agent id

capabilityKey - capability key.

updateCapabilityRequest - new capability.

Throws:

WebValidationException

deleteAgentCapability

public javax.ws.rs.core.Response deleteAgentCapability(long agentId,
                                                       @NotNull
                                                       String capabilityKey)
                                                throws NotFoundException

Remove build agent capability. Only restricted admin or system admin can use it.

Parameters:

agentId - agent id

capabilityKey - capability key

Throws:

NotFoundException

deleteAllAgentCapabilities

public javax.ws.rs.core.Response deleteAllAgentCapabilities(long agentId)
                                                     throws NotFoundException

Remove all capabilities of build agent. Only restricted admin or system admin can use it.

Parameters:

agentId - agent id

Throws:

NotFoundException