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

Class RemoteAgentConfigurationResource

java.lang.Object

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

public class RemoteAgentConfigurationResource
extends Object

Rest resource for configuring remote agent support

Since:

5.10

Constructor Summary

Constructors

Constructor and Description
RemoteAgentConfigurationResource(FeatureManager featureManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, RemoteAgentConfigurationConversionFunction function, RemoteAgentManager remoteAgentManager, RestHelperWrapper restHelperWrapper)

Method Summary

Modifier and Type	Method and Description
RestRemoteAgentConfiguration	getRemoteAgentConfiguration(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) The REST endpoint to retrieve the remote agent configuration
RestRemoteAgentConfiguration	updateRemoteAgentConfiguration(RestRemoteAgentConfiguration restRemoteAgentConfiguration, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) The REST endpoint to update the remote agent configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAgentConfigurationResource

public RemoteAgentConfigurationResource(FeatureManager featureManager,
                                        com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                        RemoteAgentConfigurationConversionFunction function,
                                        RemoteAgentManager remoteAgentManager,
                                        RestHelperWrapper restHelperWrapper)

Method Detail

getRemoteAgentConfiguration

public RestRemoteAgentConfiguration getRemoteAgentConfiguration(@NotNull @Context
                                                                Expansion expansion,
                                                                @NotNull @Context
                                                                javax.ws.rs.core.UriInfo uriInfo)
                                                         throws UnauthorisedException

The REST endpoint to retrieve the remote agent configuration

Returns:

RestRemoteAgentConfiguration

Throws:

UnauthorisedException - if user lacks restricted admin permissions

updateRemoteAgentConfiguration

public RestRemoteAgentConfiguration updateRemoteAgentConfiguration(RestRemoteAgentConfiguration restRemoteAgentConfiguration,
                                                                   @NotNull @Context
                                                                   Expansion expansion,
                                                                   @NotNull @Context
                                                                   javax.ws.rs.core.UriInfo uriInfo)
                                                            throws Exception,
                                                                   UnauthorisedException

The REST endpoint to update the remote agent configuration

Parameters:

restRemoteAgentConfiguration - Configuration to be updated

Returns:

the remote agent configuration after the update

Throws:

UnauthorisedException - if user lacks restricted admin permissions

Exception - if there was an error in changing the remote agent support