source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.rest.api.services;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *   http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import io.swagger.v3.oas.annotations.tags.Tag;
  23 import org.apache.archiva.maven2.model.Artifact;
  24 import org.apache.archiva.redback.authorization.RedbackAuthorization;
  25 import org.apache.archiva.repository.scanner.RepositoryScanStatistics;
  26 import org.apache.archiva.rest.api.model.ActionStatus;
  27 import org.apache.archiva.rest.api.model.ArtifactTransferRequest;
  28 import org.apache.archiva.rest.api.model.PermissionStatus;
  29 import org.apache.archiva.rest.api.model.ScanStatus;
  30 import org.apache.archiva.rest.api.model.StringList;
  31 import org.apache.archiva.security.common.ArchivaRoleConstants;
  32
  33 import javax.ws.rs.Consumes;
  34 import javax.ws.rs.DELETE;
  35 import javax.ws.rs.GET;
  36 import javax.ws.rs.POST;
  37 import javax.ws.rs.Path;
  38 import javax.ws.rs.PathParam;
  39 import javax.ws.rs.Produces;
  40 import javax.ws.rs.QueryParam;
  41 import javax.ws.rs.core.MediaType;
  42
  43 /**
  44  * @author Olivier Lamy
  45  * @since 1.4-M1
  46  */
  47 @Path ("/repositoriesService/")
  48 @Tag( name="Repositories", description = "Managing repositories")
  49 public interface RepositoriesService
  50 {
  51
  52     /**
  53      * index repository
  54      */
  55     @Path ("scanRepository")
  56     @GET
  57     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  58     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
  59     ActionStatus scanRepository( @QueryParam ("repositoryId") String repositoryId,
  60                                  @QueryParam ("fullScan") boolean fullScan )
  61         throws ArchivaRestServiceException;
  62
  63
  64     /**
  65      * scan directories
  66      * @since 1.4-M3
  67      */
  68     @Path ("scanRepositoryDirectoriesNow/{repositoryId}")
  69     @GET
  70     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  71     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
  72     RepositoryScanStatistics scanRepositoryDirectoriesNow( @PathParam ("repositoryId") String repositoryId )
  73         throws ArchivaRestServiceException;
  74
  75
  76     /**
  77      * Returns the scan status of the given repository
  78      * @param repositoryId the repository identifier
  79      * @return the status
  80      * @throws ArchivaRestServiceException
  81      * @since 3.0
  82      */
  83     @Path ("alreadyScanning/{repositoryId}")
  84     @GET
  85     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  86     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
  87     ScanStatus getScanStatus( @PathParam ("repositoryId") String repositoryId )
  88         throws ArchivaRestServiceException;
  89
  90     @Path ("removeScanningTaskFromQueue/{repositoryId}")
  91     @GET
  92     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  93     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
  94     ActionStatus removeScanningTaskFromQueue( @PathParam ("repositoryId") String repositoryId )
  95         throws ArchivaRestServiceException;
  96
  97     @Path ("scanRepositoryNow")
  98     @GET
  99     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 100     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
 101     ActionStatus scanRepositoryNow( @QueryParam ("repositoryId") String repositoryId,
 102                                @QueryParam ("fullScan") boolean fullScan )
 103         throws ArchivaRestServiceException;
 104
 105     /**
 106      * permissions are checked in impl
 107      * will copy an artifact from the source repository to the target repository
 108      */
 109     @Path ("copyArtifact")
 110     @POST
 111     @Consumes ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
 112     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 113     @RedbackAuthorization (noPermission = true)
 114     ActionStatus copyArtifact( ArtifactTransferRequest artifactTransferRequest )
 115         throws ArchivaRestServiceException;
 116
 117     @Path ("scheduleDownloadRemoteIndex")
 118     @GET
 119     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 120     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
 121     ActionStatus scheduleDownloadRemoteIndex( @QueryParam ("repositoryId") String repositoryId,
 122                                          @QueryParam ("now") boolean now,
 123                                          @QueryParam ("fullDownload") boolean fullDownload )
 124         throws ArchivaRestServiceException;
 125
 126
 127     /**
 128      * <b>permissions are checked in impl</b>
 129      * @since 1.4-M2
 130      */
 131     @Path ("deleteArtifact")
 132     @POST
 133     @Consumes ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
 134     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 135     @RedbackAuthorization (noPermission = true)
 136     ActionStatus deleteArtifact( Artifact artifact )
 137         throws ArchivaRestServiceException;
 138
 139     /**
 140      * <b>permissions are checked in impl</b>
 141      * @since 1.4-M4
 142      */
 143     @Path ("projectVersion/{repositoryId}/{namespace}/{projectId}/{version}")
 144     @DELETE
 145     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 146     @RedbackAuthorization (noPermission = true)
 147     ActionStatus removeProjectVersion( @PathParam ( "repositoryId" ) String repositoryId,
 148                                   @PathParam ( "namespace" ) String namespace, @PathParam ( "projectId" ) String projectId,
 149                                   @PathParam ( "version" ) String version )
 150         throws ArchivaRestServiceException;
 151
 152     /**
 153      * Returns the permission status for the current user and the given repository.
 154      * @param repoId the repository identifier
 155      * @return the status
 156      * @throws ArchivaRestServiceException
 157      * @since 3.0
 158      */
 159     @Path ("isAuthorizedToDeleteArtifacts/{repositoryId}")
 160     @GET
 161     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 162     @RedbackAuthorization (noPermission = true, noRestriction = true)
 163     PermissionStatus getPermissionStatus( @PathParam ("repositoryId") String repoId )
 164         throws ArchivaRestServiceException;
 165
 166     /**
 167      * <b>permissions are checked in impl</b>
 168      * @since 1.4-M3
 169      */
 170     @Path ("deleteGroupId")
 171     @GET
 172     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 173     @RedbackAuthorization (noPermission = true)
 174     ActionStatus deleteGroupId( @QueryParam ("groupId") String groupId, @QueryParam ("repositoryId") String repositoryId )
 175         throws ArchivaRestServiceException;
 176
 177     /**
 178      * <b>permissions are checked in impl</b>
 179      * @since 1.4-M4
 180      */
 181     @Path ("project/{repositoryId}/{groupId}/{projectId}")
 182     @DELETE
 183     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 184     @RedbackAuthorization (noPermission = true)
 185     ActionStatus deleteProject( @PathParam ("groupId") String groupId, @PathParam ("projectId") String projectId,
 186                            @PathParam ("repositoryId") String repositoryId )
 187         throws ArchivaRestServiceException;
 188
 189     /**
 190      * @since 2.0
 191      */
 192     @Path ("runningRemoteDownloadIds")
 193     @GET
 194     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
 195     @RedbackAuthorization (noPermission = true)
 196     StringList getRunningRemoteDownloadIds();
 197
 198 }