org.apache.archiva.rest.api.services

Interface SearchService

All Known Implementing Classes:

DefaultSearchService

@Path(value="/searchService/")
public interface SearchService

Method Summary

Modifier and Type	Method and Description
GroupIdList	getAllGroupIds(List<String> selectedRepos) this method applies on Maven Indexer lucene index, so datas not yet indexed won't be available
List<Artifact>	getArtifactByChecksum(ChecksumSearch checksumSearch) If searchRequest contains repositories, the search will be done only on those repositories.
List<Artifact>	getArtifactVersions(String groupId, String artifactId, String packaging) search will be apply on all repositories the current user has karma
StringList	getObservablesRepoIds()
List<Artifact>	quickSearch(String queryString)
List<Artifact>	quickSearchWithRepositories(SearchRequest searchRequest) if not repositories in SearchRequest: search will be apply on all repositories the current user has karma
javax.ws.rs.core.Response	redirectToArtifactFile(String repositoryId, String groupId, String artifactId, String version, String packaging, String classifier, Boolean literalVersion) Returns a redirect to a artifact file, that matches given search parameter
List<Artifact>	searchArtifacts(SearchRequest searchRequest) If searchRequest contains repositories, the search will be done only on those repositories.

Method Detail

quickSearch

@Path(value="quickSearch")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> quickSearch(@QueryParam(value="queryString")
                                                                                                                     String queryString)
                                                                                                              throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

quickSearchWithRepositories

@Path(value="quickSearchWithRepositories")
 @POST
 @Produces(value={"application/json","application/xml"})
List<Artifact> quickSearchWithRepositories(SearchRequest searchRequest)
                                                                                                                                               throws ArchivaRestServiceException

if not repositories in SearchRequest: search will be apply on all repositories the current user has karma

Throws:

ArchivaRestServiceException

searchArtifacts

@Path(value="searchArtifacts")
 @POST
 @Produces(value={"application/json","application/xml"})
List<Artifact> searchArtifacts(SearchRequest searchRequest)
                                                                                                                       throws ArchivaRestServiceException

If searchRequest contains repositories, the search will be done only on those repositories. if no repositories, the search will be apply on all repositories the current user has karma

Throws:

ArchivaRestServiceException

getArtifactVersions

@Path(value="getArtifactVersions")
 @GET
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifactVersions(@QueryParam(value="groupId")
                                                                                                                                     String groupId,
                                                                                                                                     @QueryParam(value="artifactId")
                                                                                                                                     String artifactId,
                                                                                                                                     @QueryParam(value="packaging")
                                                                                                                                     String packaging)
                                                                                                                              throws ArchivaRestServiceException

search will be apply on all repositories the current user has karma

Throws:

ArchivaRestServiceException

getAllGroupIds

@Path(value="getAllGroupIds")
 @GET
 @Produces(value={"application/json","application/xml"})
GroupIdList getAllGroupIds(@QueryParam(value="selectedRepos")
                                                                                                                        List<String> selectedRepos)
                                                                                                                 throws ArchivaRestServiceException

this method applies on Maven Indexer lucene index, so datas not yet indexed won't be available

Throws:

ArchivaRestServiceException

getObservablesRepoIds

@Path(value="observableRepoIds")
 @GET
 @Produces(value={"application/json","application/xml"})
StringList getObservablesRepoIds()
                                                                                                                          throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

Since:

1.4-M3

redirectToArtifactFile

@GET
 @Path(value="/artifact")
 @Produces(value="text/html")
javax.ws.rs.core.Response redirectToArtifactFile(@QueryParam(value="r")
                                                                                                              String repositoryId,
                                                                                                              @QueryParam(value="g")
                                                                                                              String groupId,
                                                                                                              @QueryParam(value="a")
                                                                                                              String artifactId,
                                                                                                              @QueryParam(value="v")
                                                                                                              String version,
                                                                                                              @QueryParam(value="p")
                                                                                                              String packaging,
                                                                                                              @QueryParam(value="c")
                                                                                                              String classifier,
                                                                                                              @DefaultValue(value="false") @QueryParam(value="literalVersion")
                                                                                                              Boolean literalVersion)
                                                                                                       throws ArchivaRestServiceException

Returns a redirect to a artifact file, that matches given search parameter

Parameters:

repositoryId - The repository id (optional)

groupId - The search pattern for the group id of the artifact (required)

artifactId - The search pattern for the artifact id of the artifact (required)

version - The search pattern for the version of the artifact (required) LATEST returns the latest version of the artifact.

packaging - the packaging

classifier - the artifact classifier

literalVersion - true, if the version string should be treated literally, which means LATEST search for versions with LATEST in the version string. false, is default and treats v=LATEST special

Returns:

the redirect response, if a artifact was found

Throws:

ArchivaRestServiceException

getArtifactByChecksum

@Path(value="artifactsByChecksum")
 @POST
 @Produces(value={"application/json","application/xml"})
List<Artifact> getArtifactByChecksum(ChecksumSearch checksumSearch)
                                                                                                                                 throws ArchivaRestServiceException

If searchRequest contains repositories, the search will be done only on those repositories. if no repositories, the search will be apply on all repositories the current user has karma

Throws:

ArchivaRestServiceException