This project has retired. For details please refer to its Attic page.
NetworkProxyService 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.NetworkProxy;
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.PathParam;
30  import javax.ws.rs.Produces;
31  import javax.ws.rs.core.MediaType;
32  import java.util.List;
33  
34  /**
35   * @author Olivier Lamy
36   * @since 1.4-M1
37   */
38  @Path( "/networkProxyService/" )
39  public interface NetworkProxyService
40  {
41      @Path( "getNetworkProxies" )
42      @GET
43      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
44      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
45      List<NetworkProxy> getNetworkProxies()
46          throws ArchivaRestServiceException;
47  
48      @Path( "getNetworkProxy/{networkProxyId}" )
49      @GET
50      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
51      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
52      NetworkProxy getNetworkProxy( @PathParam( "networkProxyId" ) String networkProxyId )
53          throws ArchivaRestServiceException;
54  
55      @Path( "addNetworkProxy" )
56      @POST
57      @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
58      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
59      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
60      void addNetworkProxy( NetworkProxy networkProxy )
61          throws ArchivaRestServiceException;
62  
63      @Path( "updateNetworkProxy" )
64      @POST
65      @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
66      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
67      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
68      void updateNetworkProxy( NetworkProxy networkProxy )
69          throws ArchivaRestServiceException;
70  
71      @Path( "deleteNetworkProxy/{networkProxyId}" )
72      @GET
73      @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
74      @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
75      Boolean deleteNetworkProxy( @PathParam( "networkProxyId" ) String networkProxyId )
76          throws ArchivaRestServiceException;
77  }