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.redback.authorization.RedbackAuthorization;
  23 import org.apache.archiva.repository.scanner.RepositoryScanStatistics;
  24 import org.apache.archiva.rest.api.model.Artifact;
  25 import org.apache.archiva.rest.api.model.ArtifactTransferRequest;
  26 import org.apache.archiva.security.common.ArchivaRoleConstants;
  27
  28 import javax.ws.rs.Consumes;
  29 import javax.ws.rs.GET;
  30 import javax.ws.rs.POST;
  31 import javax.ws.rs.Path;
  32 import javax.ws.rs.PathParam;
  33 import javax.ws.rs.Produces;
  34 import javax.ws.rs.QueryParam;
  35 import javax.ws.rs.core.MediaType;
  36
  37 /**
  38  * @author Olivier Lamy
  39  * @since 1.4-M1
  40  */
  41 @Path( "/repositoriesService/" )
  42 public interface RepositoriesService
  43 {
  44
  45     @Path( "scanRepository" )
  46     @GET
  47     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  48     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  49     /**
  50      * index repository
  51      */
  52     Boolean scanRepository( @QueryParam( "repositoryId" ) String repositoryId,
  53                             @QueryParam( "fullScan" ) boolean fullScan )
  54         throws ArchivaRestServiceException;
  55
  56
  57     @Path( "scanRepositoryDirectoriesNow/{repositoryId}" )
  58     @GET
  59     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  60     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  61     /**
  62      * scan directories
  63      * @since 1.4-M3
  64      */
  65     RepositoryScanStatistics scanRepositoryDirectoriesNow( @PathParam( "repositoryId" ) String repositoryId )
  66         throws ArchivaRestServiceException;
  67
  68
  69     @Path( "alreadyScanning/{repositoryId}" )
  70     @GET
  71     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  72     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  73     Boolean alreadyScanning( @PathParam( "repositoryId" ) String repositoryId )
  74         throws ArchivaRestServiceException;
  75
  76     @Path( "removeScanningTaskFromQueue/{repositoryId}" )
  77     @GET
  78     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  79     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  80     Boolean removeScanningTaskFromQueue( @PathParam( "repositoryId" ) String repositoryId )
  81         throws ArchivaRestServiceException;
  82
  83     @Path( "scanRepositoryNow" )
  84     @GET
  85     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  86     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
  87     Boolean scanRepositoryNow( @QueryParam( "repositoryId" ) String repositoryId,
  88                                @QueryParam( "fullScan" ) boolean fullScan )
  89         throws ArchivaRestServiceException;
  90
  91     @Path( "copyArtifact" )
  92     @POST
  93     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  94     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  95     @RedbackAuthorization( noPermission = true )
  96     /**
  97      * permissions are checked in impl
  98      * will copy an artifact from the source repository to the target repository
  99      */
 100     Boolean copyArtifact( ArtifactTransferRequest artifactTransferRequest )
 101         throws ArchivaRestServiceException;
 102
 103     @Path( "scheduleDownloadRemoteIndex" )
 104     @GET
 105     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 106     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER )
 107     Boolean scheduleDownloadRemoteIndex( @QueryParam( "repositoryId" ) String repositoryId,
 108                                          @QueryParam( "now" ) boolean now,
 109                                          @QueryParam( "fullDownload" ) boolean fullDownload )
 110         throws ArchivaRestServiceException;
 111
 112
 113     @Path( "deleteArtifact" )
 114     @POST
 115     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 116     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 117     @RedbackAuthorization( noPermission = true )
 118     /**
 119      * <b>permissions are checked in impl</b>
 120      * @since 1.4-M2
 121      */
 122     Boolean deleteArtifact( Artifact artifact )
 123         throws ArchivaRestServiceException;
 124
 125     @Path( "isAuthorizedToDeleteArtifacts/{repositoryId}" )
 126     @GET
 127     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 128     @RedbackAuthorization( noPermission = true, noRestriction = true )
 129     Boolean isAuthorizedToDeleteArtifacts( @PathParam( "repositoryId" ) String repoId )
 130         throws ArchivaRestServiceException;
 131
 132     @Path( "deleteGroupId" )
 133     @GET
 134     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
 135     @RedbackAuthorization( noPermission = true )
 136     /**
 137      * <b>permissions are checked in impl</b>
 138      * @since 1.4-M3
 139      */
 140     Boolean deleteGroupId( @QueryParam( "groupId" ) String groupId, @QueryParam( "repositoryId" ) String repositoryId )
 141         throws ArchivaRestServiceException;
 142
 143 }