org.apache.archiva.rest.api.services

Interface BrowseService

All Known Implementing Classes:

DefaultBrowseService

@Path(value="/browseService/")
public interface BrowseService

Since:

1.4-M3

Author:

Olivier Lamy

Method Summary

Modifier and Type	Method and Description
Boolean	addMetadata(String groupId, String artifactId, String version, String key, String value, String repositoryId)
Boolean	artifactAvailable(String groupId, String artifactId, String version, String repositoryId) verify if an artifact is available locally if not download from proxies will be try
Boolean	artifactAvailable(String groupId, String artifactId, String version, String classifier, String repositoryId) verify if an artifact is available locally if not download from proxies will be try
BrowseResult	browseGroupId(String groupId, String repositoryId)
Boolean	deleteMetadata(String groupId, String artifactId, String version, String key, String repositoryId)
List<ArtifactContentEntry>	getArtifactContentEntries(String groupId, String artifactId, String version, String classifier, String type, String path, String repositoryId)
ArtifactContent	getArtifactContentText(String groupId, String artifactId, String version, String classifier, String type, String path, String repositoryId) if path is empty content of the file is returned (for pom view)
List<Artifact>	getArtifactDownloadInfos(String groupId, String artifactId, String version, String repositoryId)
List<Artifact>	getArtifacts(String repositoryId) return List of all artifacts from this repository
List<Artifact>	getArtifactsByMetadata(String key, String value, String repositoryId) Return List of artifacts from this repository with artifact metadata key matching value.
List<Artifact>	getArtifactsByProjectVersionMetadata(String key, String value, String repositoryId) Return List of artifacts from this repository with project version level metadata key matching value.
List<Artifact>	getArtifactsByProperty(String key, String value, String repositoryId) Return List of artifacts from this repository with property key matching value.
List<Artifact>	getDependees(String groupId, String artifactId, String version, String repositoryId) List of artifacts using the artifact passed in parameter.
List<Entry>	getMetadatas(String groupId, String artifactId, String version, String repositoryId)
ProjectVersionMetadata	getProjectMetadata(String groupId, String artifactId, String version, String repositoryId)
ProjectVersionMetadata	getProjectVersionMetadata(String groupId, String artifactId, String repositoryId)
BrowseResult	getRootGroups(String repositoryId)
List<TreeEntry>	getTreeEntries(String groupId, String artifactId, String version, String repositoryId) return the dependency Tree for an artifacts the List result has only one entry
List<ManagedRepository>	getUserManagableRepositories()
List<ManagedRepository>	getUserRepositories()
VersionsList	getVersionsList(String groupId, String artifactId, String repositoryId)
Boolean	importMetadata(MetadataAddRequest metadataAddRequest, String repository)
List<Artifact>	searchArtifacts(String text, String repositoryId, Boolean exact) Search artifacts with any property matching text.
List<Artifact>	searchArtifacts(String key, String text, String repositoryId, Boolean exact) Search artifacts with the property specified by key matching text.

Method Detail

getRootGroups

@Path(value="rootGroups")
 @GET
 @Produces(value={"application/json","application/xml"})
BrowseResult getRootGroups(@QueryParam(value="repositoryId")
                                                                                                                    String repositoryId)
                                                                                                             throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

browseGroupId

@Path(value="browseGroupId/{groupId}")
 @GET
 @Produces(value={"application/json","application/xml"})
BrowseResult browseGroupId(@PathParam(value="groupId")
                                                                                                                                 String groupId,
                                                                                                                                 @QueryParam(value="repositoryId")
                                                                                                                                 String repositoryId)
                                                                                                                          throws ArchivaRestServiceException

Parameters:

groupId - groupId to browse

repositoryId - optionnal (repository to browse if null all available user repositories are used)

Throws:

ArchivaRestServiceException

getVersionsList

@Path(value="versionsList/{g}/{a}")
 @GET
 @Produces(value={"application/json","application/xml"})
VersionsList getVersionsList(@PathParam(value="g")
                                                                                                                                String groupId,
                                                                                                                                @PathParam(value="a")
                                                                                                                                String artifactId,
                                                                                                                                @QueryParam(value="repositoryId")
                                                                                                                                String repositoryId)
                                                                                                                         throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getProjectVersionMetadata

@Path(value="projectVersionMetadata/{g}/{a}")
 @GET
 @Produces(value={"application/json","application/xml"})
ProjectVersionMetadata getProjectVersionMetadata(@PathParam(value="g")
                                                                                                                                                              String groupId,
                                                                                                                                                              @PathParam(value="a")
                                                                                                                                                              String artifactId,
                                                                                                                                                              @QueryParam(value="repositoryId")
                                                                                                                                                              String repositoryId)
                                                                                                                                                       throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getProjectMetadata

@Path(value="projectVersionMetadata/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
ProjectVersionMetadata getProjectMetadata(@PathParam(value="g")
                                                                                                                                                           String groupId,
                                                                                                                                                           @PathParam(value="a")
                                                                                                                                                           String artifactId,
                                                                                                                                                           @PathParam(value="v")
                                                                                                                                                           String version,
                                                                                                                                                           @QueryParam(value="repositoryId")
                                                                                                                                                           String repositoryId)
                                                                                                                                                    throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getUserRepositories

@Path(value="userRepositories")
 @GET
 @Produces(value={"application/json","application/xml"})
List<ManagedRepository> getUserRepositories()
                                                                                                                                    throws ArchivaRestServiceException

Returns:

List of managed repositories current user can read

Throws:

ArchivaRestServiceException

getUserManagableRepositories

@Path(value="userManagableRepositories")
 @GET
 @Produces(value={"application/json","application/xml"})
List<ManagedRepository> getUserManagableRepositories()
                                                                                                                                                      throws ArchivaRestServiceException

Returns:

List of repositories current user can manage

Throws:

ArchivaRestServiceException

getTreeEntries

@Path(value="treeEntries/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<TreeEntry> getTreeEntries(@PathParam(value="g")
                                                                                                                                     String groupId,
                                                                                                                                     @PathParam(value="a")
                                                                                                                                     String artifactId,
                                                                                                                                     @PathParam(value="v")
                                                                                                                                     String version,
                                                                                                                                     @QueryParam(value="repositoryId")
                                                                                                                                     String repositoryId)
                                                                                                                              throws ArchivaRestServiceException

return the dependency Tree for an artifacts the List result has only one entry

Throws:

ArchivaRestServiceException

getDependees

@Path(value="dependees/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getDependees(@PathParam(value="g")
                                                                                                                                String groupId,
                                                                                                                                @PathParam(value="a")
                                                                                                                                String artifactId,
                                                                                                                                @PathParam(value="v")
                                                                                                                                String version,
                                                                                                                                @QueryParam(value="repositoryId")
                                                                                                                                String repositoryId)
                                                                                                                         throws ArchivaRestServiceException

List of artifacts using the artifact passed in parameter.

Throws:

ArchivaRestServiceException

getMetadatas

@Path(value="metadatas/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Entry> getMetadatas(@PathParam(value="g")
                                                                                                                             String groupId,
                                                                                                                             @PathParam(value="a")
                                                                                                                             String artifactId,
                                                                                                                             @PathParam(value="v")
                                                                                                                             String version,
                                                                                                                             @QueryParam(value="repositoryId")
                                                                                                                             String repositoryId)
                                                                                                                      throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

addMetadata

@Path(value="metadata/{g}/{a}/{v}/{key}/{value}")
 @PUT
 @Produces(value={"application/json","application/xml"})
Boolean addMetadata(@PathParam(value="g")
                                                                                                                                     String groupId,
                                                                                                                                     @PathParam(value="a")
                                                                                                                                     String artifactId,
                                                                                                                                     @PathParam(value="v")
                                                                                                                                     String version,
                                                                                                                                     @PathParam(value="key")
                                                                                                                                     String key,
                                                                                                                                     @PathParam(value="value")
                                                                                                                                     String value,
                                                                                                                                     @QueryParam(value="repositoryId")
                                                                                                                                     String repositoryId)
                                                                                                                              throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

deleteMetadata

@Path(value="metadata/{g}/{a}/{v}/{key}")
 @DELETE
 @Produces(value={"application/json","application/xml"})
Boolean deleteMetadata(@PathParam(value="g")
                                                                                                                                   String groupId,
                                                                                                                                   @PathParam(value="a")
                                                                                                                                   String artifactId,
                                                                                                                                   @PathParam(value="v")
                                                                                                                                   String version,
                                                                                                                                   @PathParam(value="key")
                                                                                                                                   String key,
                                                                                                                                   @QueryParam(value="repositoryId")
                                                                                                                                   String repositoryId)
                                                                                                                            throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

importMetadata

@Path(value="importMetadata")
 @POST
Boolean importMetadata(MetadataAddRequest metadataAddRequest,
                                                            @QueryParam(value="repository")
                                                            String repository)
                                                     throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getArtifactContentEntries

@Path(value="artifactContentEntries/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<ArtifactContentEntry> getArtifactContentEntries(@PathParam(value="g")
                                                                                                                                                                      String groupId,
                                                                                                                                                                      @PathParam(value="a")
                                                                                                                                                                      String artifactId,
                                                                                                                                                                      @PathParam(value="v")
                                                                                                                                                                      String version,
                                                                                                                                                                      @QueryParam(value="c")
                                                                                                                                                                      String classifier,
                                                                                                                                                                      @QueryParam(value="t")
                                                                                                                                                                      String type,
                                                                                                                                                                      @QueryParam(value="p")
                                                                                                                                                                      String path,
                                                                                                                                                                      @QueryParam(value="repositoryId")
                                                                                                                                                                      String repositoryId)
                                                                                                                                                               throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getArtifactDownloadInfos

@Path(value="artifactDownloadInfos/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifactDownloadInfos(@PathParam(value="g")
                                                                                                                                                        String groupId,
                                                                                                                                                        @PathParam(value="a")
                                                                                                                                                        String artifactId,
                                                                                                                                                        @PathParam(value="v")
                                                                                                                                                        String version,
                                                                                                                                                        @QueryParam(value="repositoryId")
                                                                                                                                                        String repositoryId)
                                                                                                                                                 throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getArtifactContentText

@Path(value="artifactContentText/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
ArtifactContent getArtifactContentText(@PathParam(value="g")
                                                                                                                                                     String groupId,
                                                                                                                                                     @PathParam(value="a")
                                                                                                                                                     String artifactId,
                                                                                                                                                     @PathParam(value="v")
                                                                                                                                                     String version,
                                                                                                                                                     @QueryParam(value="c")
                                                                                                                                                     String classifier,
                                                                                                                                                     @QueryParam(value="t")
                                                                                                                                                     String type,
                                                                                                                                                     @QueryParam(value="p")
                                                                                                                                                     String path,
                                                                                                                                                     @QueryParam(value="repositoryId")
                                                                                                                                                     String repositoryId)
                                                                                                                                              throws ArchivaRestServiceException

if path is empty content of the file is returned (for pom view)

Throws:

ArchivaRestServiceException

artifactAvailable

@Path(value="artifactAvailable/{g}/{a}/{v}")
 @GET
 @Produces(value={"application/json","application/xml"})
Boolean artifactAvailable(@PathParam(value="g")
                                                                                                                                      String groupId,
                                                                                                                                      @PathParam(value="a")
                                                                                                                                      String artifactId,
                                                                                                                                      @PathParam(value="v")
                                                                                                                                      String version,
                                                                                                                                      @QueryParam(value="repositoryId")
                                                                                                                                      String repositoryId)
                                                                                                                               throws ArchivaRestServiceException

verify if an artifact is available locally if not download from proxies will be try

Throws:

ArchivaRestServiceException

Since:

1.4-M3

artifactAvailable

@Path(value="artifactAvailable/{g}/{a}/{v}/{c}")
 @GET
 @Produces(value={"application/json","application/xml"})
Boolean artifactAvailable(@PathParam(value="g")
                                                                                                                                          String groupId,
                                                                                                                                          @PathParam(value="a")
                                                                                                                                          String artifactId,
                                                                                                                                          @PathParam(value="v")
                                                                                                                                          String version,
                                                                                                                                          @PathParam(value="c")
                                                                                                                                          String classifier,
                                                                                                                                          @QueryParam(value="repositoryId")
                                                                                                                                          String repositoryId)
                                                                                                                                   throws ArchivaRestServiceException

verify if an artifact is available locally if not download from proxies will be try

Throws:

ArchivaRestServiceException

Since:

1.4-M4

getArtifacts

@Path(value="artifacts/{r}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifacts(@PathParam(value="r")
                                                                                                                        String repositoryId)
                                                                                                                 throws ArchivaRestServiceException

return List of all artifacts from this repository

Parameters:

repositoryId -

Returns:

Throws:

ArchivaRestServiceException

Since:

1.4-M3

getArtifactsByProjectVersionMetadata

@Path(value="artifactsByProjectVersionMetadata/{key}/{value}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifactsByProjectVersionMetadata(@PathParam(value="key")
                                                                                                                                                                                  String key,
                                                                                                                                                                                  @PathParam(value="value")
                                                                                                                                                                                  String value,
                                                                                                                                                                                  @QueryParam(value="repositoryId")
                                                                                                                                                                                  String repositoryId)
                                                                                                                                                                           throws ArchivaRestServiceException

Return List of artifacts from this repository with project version level metadata key matching value. If repository is not provided the search runs in all repositories.

Parameters:

key -

value -

repositoryId -

Returns:

Throws:

ArchivaRestServiceException

Since:

2.2

getArtifactsByMetadata

@Path(value="artifactsByMetadata/{key}/{value}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifactsByMetadata(@PathParam(value="key")
                                                                                                                                                      String key,
                                                                                                                                                      @PathParam(value="value")
                                                                                                                                                      String value,
                                                                                                                                                      @QueryParam(value="repositoryId")
                                                                                                                                                      String repositoryId)
                                                                                                                                               throws ArchivaRestServiceException

Return List of artifacts from this repository with artifact metadata key matching value. If repository is not provided the search runs in all repositories.

Parameters:

key -

value -

repositoryId -

Returns:

Throws:

ArchivaRestServiceException

Since:

2.2

getArtifactsByProperty

@Path(value="artifactsByProperty/{key}/{value}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifactsByProperty(@PathParam(value="key")
                                                                                                                                                      String key,
                                                                                                                                                      @PathParam(value="value")
                                                                                                                                                      String value,
                                                                                                                                                      @QueryParam(value="repositoryId")
                                                                                                                                                      String repositoryId)
                                                                                                                                               throws ArchivaRestServiceException

Return List of artifacts from this repository with property key matching value. If repository is not provided the search runs in all repositories.

Parameters:

key -

value -

repositoryId -

Returns:

Throws:

ArchivaRestServiceException

Since:

2.2

searchArtifacts

@Path(value="searchArtifacts/{text}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> searchArtifacts(@PathParam(value="text")
                                                                                                                                    String text,
                                                                                                                                    @QueryParam(value="repositoryId")
                                                                                                                                    String repositoryId,
                                                                                                                                    @QueryParam(value="exact")
                                                                                                                                    Boolean exact)
                                                                                                                             throws ArchivaRestServiceException

Search artifacts with any property matching text. If repository is not provided the search runs in all repositories. If exact is true only the artifacts whose property match exactly are returned.

Parameters:

text -

repositoryId -

exact -

Returns:

Throws:

ArchivaRestServiceException

Since:

2.2

searchArtifacts

@Path(value="searchArtifacts/{key}/{text}")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> searchArtifacts(@PathParam(value="key")
                                                                                                                                          String key,
                                                                                                                                          @PathParam(value="text")
                                                                                                                                          String text,
                                                                                                                                          @QueryParam(value="repositoryId")
                                                                                                                                          String repositoryId,
                                                                                                                                          @QueryParam(value="exact")
                                                                                                                                          Boolean exact)
                                                                                                                                   throws ArchivaRestServiceException

Search artifacts with the property specified by key matching text. If repository is not provided the search runs in all repositories. If exact is true only the artifacts whose property match exactly are returned.

Parameters:

key -

text -

repositoryId -

exact -

Returns:

Throws:

ArchivaRestServiceException

Since:

2.2