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.admin.model.beans.NetworkProxy;
  23 import org.apache.archiva.redback.authorization.RedbackAuthorization;
  24 import org.apache.archiva.security.common.ArchivaRoleConstants;
  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.core.MediaType;
  33 import java.util.List;
  34
  35 /**
  36  * @author Olivier Lamy
  37  * @since 1.4-M1
  38  */
  39 @Path( "/networkProxyService/" )
  40 @Tag(name="Proxy", description = "Managing Network Proxies")
  41 public interface NetworkProxyService
  42 {
  43     @Path( "getNetworkProxies" )
  44     @GET
  45     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  46     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  47     List<NetworkProxy> getNetworkProxies()
  48         throws ArchivaRestServiceException;
  49
  50     @Path( "getNetworkProxy/{networkProxyId}" )
  51     @GET
  52     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  53     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  54     NetworkProxy getNetworkProxy( @PathParam( "networkProxyId" ) String networkProxyId )
  55         throws ArchivaRestServiceException;
  56
  57     @Path( "addNetworkProxy" )
  58     @POST
  59     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  60     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  61     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  62     void addNetworkProxy( NetworkProxy networkProxy )
  63         throws ArchivaRestServiceException;
  64
  65     @Path( "updateNetworkProxy" )
  66     @POST
  67     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  68     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  69     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  70     void updateNetworkProxy( NetworkProxy networkProxy )
  71         throws ArchivaRestServiceException;
  72
  73     @Path( "deleteNetworkProxy/{networkProxyId}" )
  74     @GET
  75     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  76     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  77     Boolean deleteNetworkProxy( @PathParam( "networkProxyId" ) String networkProxyId )
  78         throws ArchivaRestServiceException;
  79 }