This project has retired. For details please refer to its Attic page.
ProxyConnectorRuleService xref
View Javadoc
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.ProxyConnectorRule;
22  import org.apache.archiva.redback.authorization.RedbackAuthorization;
23  import org.apache.archiva.security.common.ArchivaRoleConstants;
24  
25  import javax.ws.rs.Consumes;
26  import javax.ws.rs.GET;
27  import javax.ws.rs.POST;
28  import javax.ws.rs.Path;
29  import javax.ws.rs.Produces;
30  import javax.ws.rs.core.MediaType;
31  import java.util.List;
32  
33  /**
34   * <b>No update method for changing pattern as id is pattern, use delete then add.</b>
35   *
36   * @author Olivier Lamy
37   * @since 1.4-M3
38   */
39  @Path ( "/proxyConnectorRuleService/" )
40  public interface ProxyConnectorRuleService
41  {
42      @Path ( "proxyConnectorRules" )
43      @GET
44      @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
45      @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
46      List<ProxyConnectorRule> getProxyConnectorRules()
47          throws ArchivaRestServiceException;
48  
49      @Path ( "proxyConnectorRule" )
50      @POST
51      @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
52      @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
53      @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
54      Boolean addProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
55          throws ArchivaRestServiceException;
56  
57      @Path ( "deleteProxyConnectorRule" )
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      Boolean deleteProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
63          throws ArchivaRestServiceException;
64  
65      /**
66       * <b>only to update attached proxy connectors to update pattern use delete then add</b>
67       */
68      @Path ( "updateProxyConnectorRule" )
69      @POST
70      @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
71      @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
72      @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
73      Boolean updateProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
74          throws ArchivaRestServiceException;
75  }