Source code

001package 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
022import org.apache.archiva.repository.storage.StorageAsset;
023
024import java.util.Map;
025import java.util.Properties;
026
027/**
028 * Policy to apply after the download has completed, but before the
029 * resource is made available to the calling client.
030 *
031 *
032 */
033public interface DownloadErrorPolicy
034    extends Policy
035{
036    /**
037     * Apply the download error policy.
038     *
039     * @param policySetting      the policy setting.
040     * @param request            the list of request properties that the policy might use.
041     * @param localFile
042     * @param exception          the exception that triggered the error
043     * @param previousExceptions any previously triggered exceptions
044     * @return True, if the exception should be processed, False if the exception should be ignored.
045     * @throws PolicyConfigurationException if the policy is improperly configured
046     */
047    boolean applyPolicy( PolicyOption policySetting, Properties request, StorageAsset localFile, Exception exception,
048                         Map<String, Exception> previousExceptions )
049        throws PolicyConfigurationException;
050}