org.apache.archiva.rest.api.services

Interface RepositoriesService

All Known Implementing Classes:

DefaultRepositoriesService

@Path(value="/repositoriesService/")
public interface RepositoriesService

Since:

1.4-M1

Author:

Olivier Lamy

Method Summary

Modifier and Type	Method and Description
Boolean	alreadyScanning(String repositoryId)
Boolean	copyArtifact(ArtifactTransferRequest artifactTransferRequest) permissions are checked in impl will copy an artifact from the source repository to the target repository
Boolean	deleteArtifact(Artifact artifact) permissions are checked in impl
Boolean	deleteGroupId(String groupId, String repositoryId) permissions are checked in impl
Boolean	deleteProject(String groupId, String projectId, String repositoryId) permissions are checked in impl
StringList	getRunningRemoteDownloadIds()
Boolean	isAuthorizedToDeleteArtifacts(String repoId)
Boolean	removeProjectVersion(String repositoryId, String namespace, String projectId, String version) permissions are checked in impl
Boolean	removeScanningTaskFromQueue(String repositoryId)
Boolean	scanRepository(String repositoryId, boolean fullScan) index repository
RepositoryScanStatistics	scanRepositoryDirectoriesNow(String repositoryId) scan directories
Boolean	scanRepositoryNow(String repositoryId, boolean fullScan)
Boolean	scheduleDownloadRemoteIndex(String repositoryId, boolean now, boolean fullDownload)

Method Detail

scanRepository

@Path(value="scanRepository")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean scanRepository(@QueryParam(value="repositoryId")
                                                                                                                                 String repositoryId,
                                                                                                                                 @QueryParam(value="fullScan")
                                                                                                                                 boolean fullScan)
                                                                                                                          throws ArchivaRestServiceException

index repository

Throws:

ArchivaRestServiceException

scanRepositoryDirectoriesNow

@Path(value="scanRepositoryDirectoriesNow/{repositoryId}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
RepositoryScanStatistics scanRepositoryDirectoriesNow(@PathParam(value="repositoryId")
                                                                                                                                                                                             String repositoryId)
                                                                                                                                                                                      throws ArchivaRestServiceException

scan directories

Throws:

ArchivaRestServiceException

Since:

1.4-M3

alreadyScanning

@Path(value="alreadyScanning/{repositoryId}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean alreadyScanning(@PathParam(value="repositoryId")
                                                                                                                                                  String repositoryId)
                                                                                                                                           throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

removeScanningTaskFromQueue

@Path(value="removeScanningTaskFromQueue/{repositoryId}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean removeScanningTaskFromQueue(@PathParam(value="repositoryId")
                                                                                                                                                                          String repositoryId)
                                                                                                                                                                   throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

scanRepositoryNow

@Path(value="scanRepositoryNow")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean scanRepositoryNow(@QueryParam(value="repositoryId")
                                                                                                                                       String repositoryId,
                                                                                                                                       @QueryParam(value="fullScan")
                                                                                                                                       boolean fullScan)
                                                                                                                                throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

copyArtifact

@Path(value="copyArtifact")
 @POST
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean copyArtifact(ArtifactTransferRequest artifactTransferRequest)
                                                                                                                                                                                throws ArchivaRestServiceException

permissions are checked in impl will copy an artifact from the source repository to the target repository

Throws:

ArchivaRestServiceException

scheduleDownloadRemoteIndex

@Path(value="scheduleDownloadRemoteIndex")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean scheduleDownloadRemoteIndex(@QueryParam(value="repositoryId")
                                                                                                                                                           String repositoryId,
                                                                                                                                                           @QueryParam(value="now")
                                                                                                                                                           boolean now,
                                                                                                                                                           @QueryParam(value="fullDownload")
                                                                                                                                                           boolean fullDownload)
                                                                                                                                                    throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

deleteArtifact

@Path(value="deleteArtifact")
 @POST
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean deleteArtifact(Artifact artifact)
                                                                                                                                                                                    throws ArchivaRestServiceException

permissions are checked in impl

Throws:

ArchivaRestServiceException

Since:

1.4-M2

removeProjectVersion

@Path(value="projectVersion/{repositoryId}/{namespace}/{projectId}/{version}")
 @DELETE
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean removeProjectVersion(@PathParam(value="repositoryId")
                                                                                                                                                                                           String repositoryId,
                                                                                                                                                                                           @PathParam(value="namespace")
                                                                                                                                                                                           String namespace,
                                                                                                                                                                                           @PathParam(value="projectId")
                                                                                                                                                                                           String projectId,
                                                                                                                                                                                           @PathParam(value="version")
                                                                                                                                                                                           String version)
                                                                                                                                                                                    throws ArchivaRestServiceException

permissions are checked in impl

Throws:

ArchivaRestServiceException

Since:

1.4-M4

isAuthorizedToDeleteArtifacts

@Path(value="isAuthorizedToDeleteArtifacts/{repositoryId}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean isAuthorizedToDeleteArtifacts(@PathParam(value="repositoryId")
                                                                                                                                                                              String repoId)
                                                                                                                                                                       throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

deleteGroupId

@Path(value="deleteGroupId")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean deleteGroupId(@QueryParam(value="groupId")
                                                                                                                               String groupId,
                                                                                                                               @QueryParam(value="repositoryId")
                                                                                                                               String repositoryId)
                                                                                                                        throws ArchivaRestServiceException

permissions are checked in impl

Throws:

ArchivaRestServiceException

Since:

1.4-M3

deleteProject

@Path(value="project/{repositoryId}/{groupId}/{projectId}")
 @DELETE
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean deleteProject(@PathParam(value="groupId")
                                                                                                                                                                 String groupId,
                                                                                                                                                                 @PathParam(value="projectId")
                                                                                                                                                                 String projectId,
                                                                                                                                                                 @PathParam(value="repositoryId")
                                                                                                                                                                 String repositoryId)
                                                                                                                                                          throws ArchivaRestServiceException

permissions are checked in impl

Throws:

ArchivaRestServiceException

Since:

1.4-M4

getRunningRemoteDownloadIds

@Path(value="runningRemoteDownloadIds")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
StringList getRunningRemoteDownloadIds()

Since:

2.0