001    package org.apache.archiva.rest.api.services;
002    /*
003     * Licensed to the Apache Software Foundation (ASF) under one
004     * or more contributor license agreements.  See the NOTICE file
005     * distributed with this work for additional information
006     * regarding copyright ownership.  The ASF licenses this file
007     * to you under the Apache License, Version 2.0 (the
008     * "License"); you may not use this file except in compliance
009     * with the License.  You may obtain a copy of the License at
010     *
011     *   http://www.apache.org/licenses/LICENSE-2.0
012     *
013     * Unless required by applicable law or agreed to in writing,
014     * software distributed under the License is distributed on an
015     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016     * KIND, either express or implied.  See the License for the
017     * specific language governing permissions and limitations
018     * under the License.
019     */
020    
021    import org.apache.archiva.admin.model.beans.NetworkProxy;
022    import org.apache.archiva.security.common.ArchivaRoleConstants;
023    import org.apache.archiva.redback.authorization.RedbackAuthorization;
024    
025    import javax.ws.rs.Consumes;
026    import javax.ws.rs.GET;
027    import javax.ws.rs.POST;
028    import javax.ws.rs.Path;
029    import javax.ws.rs.PathParam;
030    import javax.ws.rs.Produces;
031    import javax.ws.rs.core.MediaType;
032    import java.util.List;
033    
034    /**
035     * @author Olivier Lamy
036     * @since 1.4-M1
037     */
038    @Path( "/networkProxyService/" )
039    public interface NetworkProxyService
040    {
041        @Path( "getNetworkProxies" )
042        @GET
043        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
044        @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
045        List<NetworkProxy> getNetworkProxies()
046            throws ArchivaRestServiceException;
047    
048        @Path( "getNetworkProxy/{networkProxyId}" )
049        @GET
050        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
051        @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
052        NetworkProxy getNetworkProxy( @PathParam( "networkProxyId" ) String networkProxyId )
053            throws ArchivaRestServiceException;
054    
055        @Path( "addNetworkProxy" )
056        @POST
057        @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
058        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
059        @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
060        void addNetworkProxy( NetworkProxy networkProxy )
061            throws ArchivaRestServiceException;
062    
063        @Path( "updateNetworkProxy" )
064        @POST
065        @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
066        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
067        @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
068        void updateNetworkProxy( NetworkProxy networkProxy )
069            throws ArchivaRestServiceException;
070    
071        @Path( "deleteNetworkProxy/{networkProxyId}" )
072        @GET
073        @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
074        @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
075        Boolean deleteNetworkProxy( @PathParam( "networkProxyId" ) String networkProxyId )
076            throws ArchivaRestServiceException;
077    }