com.atlassian.bamboo.plugins.rest.admin.artifacthandler

Class ArtifactHandlerResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.artifacthandler.ArtifactHandlerResource

public class ArtifactHandlerResource
extends Object

REST resource to manage artifact handlers in bamboo. It includes a REST endpoint for each type artifact handlers respectively. GET and PUT methods are supported. Supported artifact handler types:

• Server-Local Artifact Handler
• Bamboo Remote Handler
• Amazon S3
• Agent-Local Artifact Handler

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static RestArtifactHandler	AGENT_LOCAL_ARTIFACT_HANDLER
static RestArtifactHandler	BAMBOO_REMOTE_ARTIFACT_HANDLER
static RestArtifactHandler	S3_ARTIFACT_HANDLER
static RestArtifactHandler	SERVER_LOCAL_ARTIFACT_HANDLER

Constructor Summary

Constructors

Constructor and Description
ArtifactHandlerResource(RestArtifactHandlerConversionFunction function, ArtifactHandlersService artifactHandlersService, FeatureManager featureManager, com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Summary

Modifier and Type	Method and Description
RestArtifactHandler	getAgentLocalArtifactHandler(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve configuration of Agent-Local Artifact Handler.
RestArtifactHandler	getBambooRemoteArtifactHandler(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve configuration of Bamboo Remote Artifact Handler.
RestArtifactHandler	getBambooServerLocalArtifactHandler(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve configuration of Server-Local Artifact Handler.
RestArtifactHandler	getS3ArtifactHandler(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve configuration of S3 Artifact Handler.
RestArtifactHandler	updateAgentLocalHandler(RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo) Update Agent-Local Artifact Handler configuration.
RestArtifactHandler	updateBambooRemoteHandler(RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo) Update Bamboo Remote Artifact Handler configuration.
RestArtifactHandler	updateS3Handler(RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo) Update S3 Artifact Handler configuration.
RestArtifactHandler	updateServerLocalArtifactHandler(RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo) Update Server-Local Artifact handler configuration.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_LOCAL_ARTIFACT_HANDLER

public static final RestArtifactHandler SERVER_LOCAL_ARTIFACT_HANDLER

BAMBOO_REMOTE_ARTIFACT_HANDLER

public static final RestArtifactHandler BAMBOO_REMOTE_ARTIFACT_HANDLER

AGENT_LOCAL_ARTIFACT_HANDLER

public static final RestArtifactHandler AGENT_LOCAL_ARTIFACT_HANDLER

S3_ARTIFACT_HANDLER

public static final RestArtifactHandler S3_ARTIFACT_HANDLER

Constructor Detail

ArtifactHandlerResource

public ArtifactHandlerResource(RestArtifactHandlerConversionFunction function,
                               ArtifactHandlersService artifactHandlersService,
                               FeatureManager featureManager,
                               com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Detail

getBambooServerLocalArtifactHandler

public RestArtifactHandler getBambooServerLocalArtifactHandler(@Context
                                                               Expansion expansion,
                                                               @Context
                                                               javax.ws.rs.core.UriInfo uriInfo)
                                                        throws WebValidationException

Retrieve configuration of Server-Local Artifact Handler. Only 2 attributes are included, sharedArtifactsEnabled and nonSharedArtifactsEnabled

Parameters:

expansion -

uriInfo -

Returns:

Bamboo Server Local Artifact Handler configuration

Throws:

WebValidationException

updateServerLocalArtifactHandler

public RestArtifactHandler updateServerLocalArtifactHandler(@NotNull
                                                            RestArtifactHandler restArtifactHandler,
                                                            @Context
                                                            javax.ws.rs.core.UriInfo uriInfo)
                                                     throws WebValidationException

Update Server-Local Artifact handler configuration. Enable or disable the handler for shared or non shared artifacts

Parameters:

restArtifactHandler - New configuration of the artifact handler

uriInfo -

Returns:

Updated configuration

Throws:

WebValidationException

getBambooRemoteArtifactHandler

public RestArtifactHandler getBambooRemoteArtifactHandler(@Context
                                                          Expansion expansion,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                   throws WebValidationException

Retrieve configuration of Bamboo Remote Artifact Handler. Only 2 attributes are included, sharedArtifactsEnabled and nonSharedArtifactsEnabled

Parameters:

expansion -

uriInfo -

Returns:

Bamboo Remote Handler configuration

Throws:

WebValidationException

updateBambooRemoteHandler

public RestArtifactHandler updateBambooRemoteHandler(@NotNull
                                                     RestArtifactHandler restArtifactHandler,
                                                     @Context
                                                     javax.ws.rs.core.UriInfo uriInfo)
                                              throws WebValidationException

Update Bamboo Remote Artifact Handler configuration. Enable or disable the handler for shared or non shared artifacts

Parameters:

restArtifactHandler - New configuration of the artifact handler

uriInfo -

Returns:

Updated configuration

Throws:

WebValidationException

getAgentLocalArtifactHandler

public RestArtifactHandler getAgentLocalArtifactHandler(@Context
                                                        Expansion expansion,
                                                        @Context
                                                        javax.ws.rs.core.UriInfo uriInfo)
                                                 throws WebValidationException

Retrieve configuration of Agent-Local Artifact Handler.

Parameters:

expansion -

uriInfo -

Returns:

Agent-Local Handler configuration

Throws:

WebValidationException

updateAgentLocalHandler

public RestArtifactHandler updateAgentLocalHandler(@NotNull
                                                   RestArtifactHandler restArtifactHandler,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo)
                                            throws WebValidationException

Update Agent-Local Artifact Handler configuration.

Parameters:

restArtifactHandler - New configuration of the artifact handler

uriInfo -

Returns:

Updated configuration

Throws:

WebValidationException

getS3ArtifactHandler

public RestArtifactHandler getS3ArtifactHandler(@Context
                                                Expansion expansion,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)
                                         throws WebValidationException

Retrieve configuration of S3 Artifact Handler.

Parameters:

expansion -

uriInfo -

uriInfo -

Returns:

S3 Handler configuration

Throws:

WebValidationException

updateS3Handler

public RestArtifactHandler updateS3Handler(@NotNull
                                           RestArtifactHandler restArtifactHandler,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)
                                    throws WebValidationException

Update S3 Artifact Handler configuration.

Parameters:

restArtifactHandler - New configuration of the artifact handler

uriInfo -

Returns:

Updated configuration

Throws:

WebValidationException