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 io.swagger.v3.oas.annotations.tags.Tags;
  24 import org.apache.archiva.admin.model.beans.RemoteRepository;
  25 import org.apache.archiva.redback.authorization.RedbackAuthorization;
  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.core.MediaType;
  35 import java.util.List;
  36
  37 /**
  38  * @author Olivier Lamy
  39  * @since 1.4-M1
  40  */
  41 @Path("/remoteRepositoriesService/")
  42 @Tags( {
  43     @Tag( name = "RemoteRepositories", description = "Administration of remote repositories" ),
  44     @Tag( name = "Repositories", description = "Administration of remote repositories" )
  45 })
  46 public interface RemoteRepositoriesService
  47 {
  48     @Path("getRemoteRepositories")
  49     @GET
  50     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
  51     @RedbackAuthorization(permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION)
  52     List<RemoteRepository> getRemoteRepositories()
  53         throws ArchivaRestServiceException;
  54
  55     @Path("getRemoteRepository/{repositoryId}")
  56     @GET
  57     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
  58     @RedbackAuthorization(permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION)
  59     RemoteRepository getRemoteRepository( @PathParam("repositoryId") String repositoryId )
  60         throws ArchivaRestServiceException;
  61
  62     @Path("deleteRemoteRepository/{repositoryId}")
  63     @GET
  64     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  65     @RedbackAuthorization(permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION)
  66     Boolean deleteRemoteRepository( @PathParam("repositoryId") String repositoryId )
  67         throws ArchivaRestServiceException;
  68
  69
  70     @Path("addRemoteRepository")
  71     @POST
  72     @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
  73     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  74     @RedbackAuthorization(permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION)
  75     Boolean addRemoteRepository( RemoteRepository remoteRepository )
  76         throws ArchivaRestServiceException;
  77
  78
  79     @Path("updateRemoteRepository")
  80     @POST
  81     @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
  82     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  83     @RedbackAuthorization(permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION)
  84     Boolean updateRemoteRepository( RemoteRepository remoteRepository )
  85         throws ArchivaRestServiceException;
  86
  87     @Path("checkRemoteConnectivity/{repositoryId}")
  88     @GET
  89     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
  90     @RedbackAuthorization(permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION)
  91     Boolean checkRemoteConnectivity( @PathParam( "repositoryId" ) String repositoryId )
  92         throws ArchivaRestServiceException;
  93 }