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

Class ArtifactHandlerResource

java.lang.Object

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

@Path("artifactHandlers")
@Produces("application/json")
@Consumes("application/json")
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

Constructor Summary

Constructors

Constructor	Description
ArtifactHandlerResource(RestArtifactHandlerConversionFunction function, ArtifactHandlersService artifactHandlersService)

Method Summary

Modifier and Type	Method	Description
RestArtifactHandler	getAgentLocalArtifactHandler(ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	getBambooRemoteArtifactHandler(ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	getS3ArtifactHandler(ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	getSftpArtifactHandler(ExpansionParam expansion, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	updateAgentLocalHandler(@NotNull RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	updateBambooRemoteHandler(@NotNull RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	updateS3Handler(@NotNull RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo)
RestArtifactHandler	updateSftpHandler(@NotNull RestArtifactHandler restArtifactHandler, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

ArtifactHandlerResource

@Inject
public ArtifactHandlerResource(RestArtifactHandlerConversionFunction function,
 ArtifactHandlersService artifactHandlersService)

Method Details

getBambooRemoteArtifactHandler

@GET
@Path("bambooRemote")
public RestArtifactHandler getBambooRemoteArtifactHandler(@BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                                   throws WebValidationException

Throws:

WebValidationException

updateBambooRemoteHandler

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

Throws:

WebValidationException

getSftpArtifactHandler

@GET
@Path("sftp")
public RestArtifactHandler getSftpArtifactHandler(@BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                           throws WebValidationException

Throws:

WebValidationException

updateSftpHandler

@PUT
@Path("sftp")
public RestArtifactHandler updateSftpHandler(@NotNull
 @NotNull RestArtifactHandler restArtifactHandler,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                      throws WebValidationException

Throws:

WebValidationException

getAgentLocalArtifactHandler

@GET
@Path("agentLocal")
public RestArtifactHandler getAgentLocalArtifactHandler(@BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                                 throws WebValidationException

Throws:

WebValidationException

updateAgentLocalHandler

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

Throws:

WebValidationException

getS3ArtifactHandler

@GET
@Path("s3")
public RestArtifactHandler getS3ArtifactHandler(@BeanParam
 ExpansionParam expansion,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                         throws WebValidationException

Throws:

WebValidationException

updateS3Handler

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

Throws:

WebValidationException