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 org.apache.archiva.rest.api.model.ArtifactTransferRequest;
  23 import org.apache.archiva.security.common.ArchivaRoleConstants;
  24 import org.codehaus.plexus.redback.authorization.RedbackAuthorization;
  25
  26 import javax.ws.rs.Consumes;
  27 import javax.ws.rs.GET;
  28 import javax.ws.rs.POST;
  29 import javax.ws.rs.Path;
  30 import javax.ws.rs.PathParam;
  31 import javax.ws.rs.Produces;
  32 import javax.ws.rs.QueryParam;
  33 import javax.ws.rs.core.MediaType;
  34
  35 /**
  36  * @author Olivier Lamy
  37  * @since 1.4
  38  */
  39 @Path( "/repositoriesService/" )
  40 public interface RepositoriesService
  41 {
  42
  43     @Path( "scanRepository" )
  44     @GET
  45     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  46     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  47     Boolean scanRepository( @QueryParam( "repositoryId" ) String repositoryId,
  48                             @QueryParam( "fullScan" ) boolean fullScan )
  49         throws ArchivaRestServiceException;
  50
  51
  52     @Path( "alreadyScanning/{repositoryId}" )
  53     @GET
  54     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  55     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  56     Boolean alreadyScanning( @PathParam( "repositoryId" ) String repositoryId )
  57         throws ArchivaRestServiceException;
  58
  59     @Path( "removeScanningTaskFromQueue/{repositoryId}" )
  60     @GET
  61     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  62     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  63     Boolean removeScanningTaskFromQueue( @PathParam( "repositoryId" ) String repositoryId )
  64         throws ArchivaRestServiceException;
  65
  66     @Path( "scanRepositoryNow" )
  67     @GET
  68     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  69     @RedbackAuthorization( permission = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  70     Boolean scanRepositoryNow( @QueryParam( "repositoryId" ) String repositoryId,
  71                                @QueryParam( "fullScan" ) boolean fullScan )
  72         throws ArchivaRestServiceException;
  73
  74     @Path( "copyArtifact" )
  75     @POST
  76     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  77     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  78     @RedbackAuthorization( noPermission = true )
  79     /**
  80      * permission are checked in impl
  81      * will copy an artifact from the source repository to the target repository
  82      */
  83     Boolean copyArtifact( ArtifactTransferRequest artifactTransferRequest )
  84         throws ArchivaRestServiceException;
  85
  86 }