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.ProxyConnectorRule;
  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.Produces;
  31 import javax.ws.rs.core.MediaType;
  32 import java.util.List;
  33
  34 /**
  35  * <b>No update method for changing pattern as id is pattern, use delete then add.</b>
  36  *
  37  * @author Olivier Lamy
  38  * @since 1.4-M3
  39  */
  40 @Path ( "/proxyConnectorRuleService/" )
  41 @Tag(name="Proxy-Repository", description="Handling of proxy repositories that delegate to remote repositories")
  42 public interface ProxyConnectorRuleService
  43 {
  44     @Path ( "proxyConnectorRules" )
  45     @GET
  46     @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  47     @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  48     List<ProxyConnectorRule> getProxyConnectorRules()
  49         throws ArchivaRestServiceException;
  50
  51     @Path ( "proxyConnectorRule" )
  52     @POST
  53     @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  54     @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  55     @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  56     Boolean addProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
  57         throws ArchivaRestServiceException;
  58
  59     @Path ( "deleteProxyConnectorRule" )
  60     @POST
  61     @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  62     @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  63     @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  64     Boolean deleteProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
  65         throws ArchivaRestServiceException;
  66
  67     /**
  68      * <b>only to update attached proxy connectors to update pattern use delete then add</b>
  69      */
  70     @Path ( "updateProxyConnectorRule" )
  71     @POST
  72     @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  73     @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  74     @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  75     Boolean updateProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
  76         throws ArchivaRestServiceException;
  77 }