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 org.apache.archiva.admin.model.beans.ProxyConnector;
  22 import org.apache.archiva.rest.api.model.PolicyInformation;
  23 import org.apache.archiva.security.common.ArchivaRoleConstants;
  24 import org.codehaus.plexus.redback.authorization.RedbackAuthorization;
  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.QueryParam;
  32 import javax.ws.rs.core.MediaType;
  33 import java.util.List;
  34
  35 /**
  36  * <b>No update method for changing source and target here as id is : sourceRepoId and targetRepoId, use delete then add.</b>
  37  *
  38  * @author Olivier Lamy
  39  * @since 1.4-M1
  40  */
  41 @Path( "/proxyConnectorService/" )
  42 public interface ProxyConnectorService
  43 {
  44     @Path( "getProxyConnectors" )
  45     @GET
  46     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  47     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  48     List<ProxyConnector> getProxyConnectors()
  49         throws ArchivaRestServiceException;
  50
  51     @Path( "getProxyConnector" )
  52     @GET
  53     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  54     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  55     ProxyConnector getProxyConnector( @QueryParam( "sourceRepoId" ) String sourceRepoId,
  56                                       @QueryParam( "targetRepoId" ) String targetRepoId )
  57         throws ArchivaRestServiceException;
  58
  59     @Path( "addProxyConnector" )
  60     @POST
  61     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  62     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  63     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  64     Boolean addProxyConnector( ProxyConnector proxyConnector )
  65         throws ArchivaRestServiceException;
  66
  67     @Path( "deleteProxyConnector" )
  68     @POST
  69     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  70     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  71     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  72     Boolean deleteProxyConnector( ProxyConnector proxyConnector )
  73         throws ArchivaRestServiceException;
  74
  75     @Path( "removeProxyConnector" )
  76     @GET
  77     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  78     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  79     /**
  80      * @since 1.4-M3
  81      */
  82     Boolean removeProxyConnector( @QueryParam( "sourceRepoId" ) String sourceRepoId,
  83                                   @QueryParam( "targetRepoId" ) String targetRepoId )
  84         throws ArchivaRestServiceException;
  85
  86     /**
  87      * <b>only for enabled/disable or changing bean values except target/source</b>
  88      *
  89      * @param proxyConnector
  90      * @return
  91      */
  92     @Path( "updateProxyConnector" )
  93     @POST
  94     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
  95     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
  96     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
  97     Boolean updateProxyConnector( ProxyConnector proxyConnector )
  98         throws ArchivaRestServiceException;
  99
 100     @Path( "allPolicies" )
 101     @GET
 102     @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 103     @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
 104     @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
 105     List<PolicyInformation> getAllPolicyInformations()
 106         throws ArchivaRestServiceException;
 107
 108
 109 }