001    package org.apache.archiva.policies;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *  http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.io.File;
023    import java.util.Map;
024    import java.util.Properties;
025    
026    /**
027     * Policy to apply after the download has completed, but before the
028     * resource is made available to the calling client.
029     *
030     *
031     */
032    public interface DownloadErrorPolicy
033        extends Policy
034    {
035        /**
036         * Apply the download error policy.
037         *
038         * @param policySetting      the policy setting.
039         * @param request            the list of request properties that the policy might use.
040         * @param localFile
041         * @param exception          the exception that triggered the error
042         * @param previousExceptions any previously triggered exceptions
043         * @return whether to process the exception or not
044         * @throws PolicyConfigurationException if the policy is improperly configured
045         */
046        boolean applyPolicy( String policySetting, Properties request, File localFile, Exception exception,
047                                    Map<String, Exception> previousExceptions )
048            throws PolicyConfigurationException;
049    }