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

   1 package org.apache.archiva.rest.api.services;
   2 /*
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  *   http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing,
  14  * software distributed under the License is distributed on an
  15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  * KIND, either express or implied.  See the License for the
  17  * specific language governing permissions and limitations
  18  * under the License.
  19  */
  20
  21 import io.swagger.v3.oas.annotations.tags.Tag;
  22 import org.apache.archiva.maven2.model.Artifact;
  23 import org.apache.archiva.redback.authorization.RedbackAuthorization;
  24 import org.apache.archiva.security.common.ArchivaRoleConstants;
  25
  26 import javax.ws.rs.GET;
  27 import javax.ws.rs.Path;
  28 import javax.ws.rs.PathParam;
  29 import javax.ws.rs.Produces;
  30 import javax.ws.rs.core.MediaType;
  31 import java.util.List;
  32
  33 /**
  34  * provide REST services on the top of stage merge repository plugin
  35  *
  36  * @author Olivier Lamy
  37  * @since 1.4-M3
  38  */
  39 @Path ("/mergeRepositoriesService/")
  40 @Tag(name="RepositoryMerge", description = "Merging repositories")
  41 public interface MergeRepositoriesService
  42 {
  43
  44     /**
  45      * <b>permissions are checked in impl</b>
  46      * @since 1.4-M3
  47      */
  48     @Path ("mergeConflictedArtifacts/{sourceRepositoryId}/{targetRepositoryId}")
  49     @GET
  50     @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
  51     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_MERGE_REPOSITORY, resource = "{sourceRepositoryId}")
  52     List<Artifact> getMergeConflictedArtifacts( @PathParam ("sourceRepositoryId") String sourceRepositoryId,
  53                                                 @PathParam ("targetRepositoryId") String targetRepositoryId )
  54         throws ArchivaRestServiceException;
  55
  56     /**
  57      * <b>permissions are checked in impl</b>
  58      * @since 1.4-M3
  59      */
  60     @Path ("mergeRepositories/{sourceRepositoryId}/{targetRepositoryId}/{skipConflicts}")
  61     @GET
  62     @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_MERGE_REPOSITORY, resource = "{sourceRepositoryId}")
  63     void mergeRepositories( @PathParam ("sourceRepositoryId") String sourceRepositoryId,
  64                             @PathParam ("targetRepositoryId") String targetRepositoryId,
  65                             @PathParam ("skipConflicts") boolean skipConflicts )
  66         throws ArchivaRestServiceException;
  67 }