123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346 |
- package org.apache.archiva.rest.api.services;
- /*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
- import io.swagger.v3.oas.annotations.tags.Tag;
- import org.apache.archiva.admin.model.beans.ManagedRepository;
- import org.apache.archiva.maven2.model.Artifact;
- import org.apache.archiva.maven2.model.TreeEntry;
- import org.apache.archiva.metadata.model.ProjectVersionMetadata;
- import org.apache.archiva.redback.authorization.RedbackAuthorization;
- import org.apache.archiva.rest.api.model.ActionStatus;
- import org.apache.archiva.rest.api.model.ArtifactContent;
- import org.apache.archiva.rest.api.model.ArtifactContentEntry;
- import org.apache.archiva.rest.api.model.AvailabilityStatus;
- import org.apache.archiva.rest.api.model.BrowseResult;
- import org.apache.archiva.rest.api.model.Entry;
- import org.apache.archiva.rest.api.model.MetadataAddRequest;
- import org.apache.archiva.rest.api.model.VersionsList;
-
- import javax.ws.rs.DELETE;
- import javax.ws.rs.GET;
- import javax.ws.rs.POST;
- import javax.ws.rs.PUT;
- import javax.ws.rs.Path;
- import javax.ws.rs.PathParam;
- import javax.ws.rs.Produces;
- import javax.ws.rs.QueryParam;
- import javax.ws.rs.core.MediaType;
- import java.util.List;
-
- /**
- * @author Olivier Lamy
- * @since 1.4-M3
- */
- @Path("/browseService/")
- @Tag( name = "Browse", description = "Repository Browse Service")
- public interface BrowseService
- {
- @Path("rootGroups")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- BrowseResult getRootGroups( @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * @param groupId groupId to browse
- * @param repositoryId optionnal (repository to browse if <code>null</code> all available user repositories are used)
- */
- @Path("browseGroupId/{groupId}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- BrowseResult browseGroupId( @PathParam("groupId") String groupId, @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("versionsList/{g}/{a}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- VersionsList getVersionsList( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("projectVersionMetadata/{g}/{a}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- ProjectVersionMetadata getProjectVersionMetadata( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("projectVersionMetadata/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- ProjectVersionMetadata getProjectMetadata( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * @return List of managed repositories current user can read
- */
- @Path("userRepositories")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<ManagedRepository> getUserRepositories()
- throws ArchivaRestServiceException;
-
- /**
- * @return List of repositories current user can manage
- */
- @Path("userManagableRepositories")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<ManagedRepository> getUserManagableRepositories()
- throws ArchivaRestServiceException;
-
- /**
- * return the dependency Tree for an artifacts
- * <b>the List result has only one entry</b>
- */
- @Path("treeEntries/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<TreeEntry> getTreeEntries( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * List of artifacts using the artifact passed in parameter.
- */
- @Path("dependees/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<Artifact> getDependees( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("metadatas/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<Entry> getMetadatas( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("metadata/{g}/{a}/{v}/{key}/{value}")
- @PUT
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization( permissions = "archiva-add-metadata", resource = "{repositoryId}")
- ActionStatus addMetadata( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @PathParam("key") String key, @PathParam("value") String value,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("metadata/{g}/{a}/{v}/{key}")
- @DELETE
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization( permissions = "archiva-add-metadata", resource = "{repositoryId}")
- ActionStatus deleteMetadata( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @PathParam("key") String key,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("importMetadata")
- @POST
- @RedbackAuthorization( permissions = "archiva-add-metadata", resource = "{repository}")
- ActionStatus importMetadata( MetadataAddRequest metadataAddRequest, @QueryParam("repository") String repository )
- throws ArchivaRestServiceException;
-
- @Path("artifactContentEntries/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<ArtifactContentEntry> getArtifactContentEntries( @PathParam("g") String groupId,
- @PathParam("a") String artifactId,
- @PathParam("v") String version,
- @QueryParam("c") String classifier,
- @QueryParam("t") String type, @QueryParam("p") String path,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- @Path("artifactDownloadInfos/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<Artifact> getArtifactDownloadInfos( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * if path is empty content of the file is returned (for pom view)
- */
- @Path("artifactContentText/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- ArtifactContent getArtifactContentText( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @QueryParam("c") String classifier,
- @QueryParam("t") String type, @QueryParam("p") String path,
- @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * verify if an artifact is available locally if not download from proxies will be try
- *
- * @since 1.4-M3
- */
- @Path("artifactAvailable/{g}/{a}/{v}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- AvailabilityStatus artifactAvailable( @PathParam("g") String groupId, @PathParam("a") String artifactId,
- @PathParam("v") String version, @QueryParam("repositoryId") String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * verify if an artifact is available locally if not download from proxies will be try
- *
- * @since 1.4-M4
- */
- @Path( "artifactAvailable/{g}/{a}/{v}/{c}" )
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
- AvailabilityStatus artifactAvailable( @PathParam( "g" ) String groupId, @PathParam( "a" ) String artifactId,
- @PathParam( "v" ) String version, @PathParam( "c" ) String classifier,
- @QueryParam( "repositoryId" ) String repositoryId )
- throws ArchivaRestServiceException;
-
- /**
- * return List of all artifacts from this repository
- *
- * @param repositoryId
- * @return
- * @throws ArchivaRestServiceException
- * @since 1.4-M3
- */
- @Path("artifacts/{r}")
- @GET
- @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization(noPermission = true, noRestriction = true)
- List<Artifact> getArtifacts( @PathParam("r") 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.
- *
- * @param key
- * @param value
- * @param repositoryId
- * @return
- * @throws ArchivaRestServiceException
- * @since 2.2
- */
- @Path( "artifactsByProjectVersionMetadata/{key}/{value}" )
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
- List<Artifact> getArtifactsByProjectVersionMetadata( @PathParam( "key" ) String key, @PathParam( "value" ) String value,
- @QueryParam("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.
- *
- * @param key
- * @param value
- * @param repositoryId
- * @return
- * @throws ArchivaRestServiceException
- * @since 2.2
- */
- @Path( "artifactsByMetadata/{key}/{value}" )
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
- List<Artifact> getArtifactsByMetadata( @PathParam( "key" ) String key, @PathParam( "value" ) String value,
- @QueryParam("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.
- *
- * @param key
- * @param value
- * @param repositoryId
- * @return
- * @throws ArchivaRestServiceException
- * @since 2.2
- */
- @Path( "artifactsByProperty/{key}/{value}" )
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
- List<Artifact> getArtifactsByProperty( @PathParam( "key" ) String key, @PathParam( "value" ) String value,
- @QueryParam("repositoryId") String repositoryId )
- 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.
- *
- * @param text
- * @param repositoryId
- * @param exact
- * @return
- * @throws ArchivaRestServiceException
- * @since 2.2
- */
- @Path( "searchArtifacts/{text}" )
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
- List<Artifact> searchArtifacts( @PathParam( "text" ) String text,
- @QueryParam( "repositoryId" ) String repositoryId,
- @QueryParam( "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.
- *
- * @param key
- * @param text
- * @param repositoryId
- * @param exact
- * @return
- * @throws ArchivaRestServiceException
- * @since 2.2
- */
- @Path( "searchArtifacts/{key}/{text}" )
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
- List<Artifact> searchArtifacts( @PathParam( "key" ) String key, @PathParam( "text" ) String text,
- @QueryParam( "repositoryId" ) String repositoryId,
- @QueryParam( "exact" ) Boolean exact )
- throws ArchivaRestServiceException;
- }
|