Source code

001package 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
021import org.apache.archiva.admin.model.beans.ProxyConnectorRule;
022import org.apache.archiva.redback.authorization.RedbackAuthorization;
023import org.apache.archiva.security.common.ArchivaRoleConstants;
024
025import javax.ws.rs.Consumes;
026import javax.ws.rs.GET;
027import javax.ws.rs.POST;
028import javax.ws.rs.Path;
029import javax.ws.rs.Produces;
030import javax.ws.rs.core.MediaType;
031import java.util.List;
032
033/**
034 * <b>No update method for changing pattern as id is pattern, use delete then add.</b>
035 *
036 * @author Olivier Lamy
037 * @since 1.4-M3
038 */
039@Path ( "/proxyConnectorRuleService/" )
040public interface ProxyConnectorRuleService
041{
042    @Path ( "proxyConnectorRules" )
043    @GET
044    @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
045    @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
046    List<ProxyConnectorRule> getProxyConnectorRules()
047        throws ArchivaRestServiceException;
048
049    @Path ( "proxyConnectorRule" )
050    @POST
051    @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
052    @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
053    @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
054    Boolean addProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
055        throws ArchivaRestServiceException;
056
057    @Path ( "deleteProxyConnectorRule" )
058    @POST
059    @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
060    @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
061    @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
062    Boolean deleteProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
063        throws ArchivaRestServiceException;
064
065    /**
066     * <b>only to update attached proxy connectors to update pattern use delete then add</b>
067     */
068    @Path ( "updateProxyConnectorRule" )
069    @POST
070    @Consumes ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
071    @Produces ( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
072    @RedbackAuthorization ( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
073    Boolean updateProxyConnectorRule( ProxyConnectorRule proxyConnectorRule )
074        throws ArchivaRestServiceException;
075}