org.apache.maven.archiva.policies.DownloadPolicy Maven / Gradle / Ivy

Go to download
package org.apache.maven.archiva.policies;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.File;
import java.util.List;
import java.util.Properties;

/**
 * DownloadPolicy 
 *
 * @author Joakim Erdfelt
 * @version $Id: DownloadPolicy.java 562485 2007-08-03 14:44:15Z joakime $
 */
public interface DownloadPolicy
{
    /**
     * The IGNORED policy means that the policy is ignored.
     */
    public static final String IGNORED = "ignored";
    
    public static final boolean PASS = true;
    public static final boolean FAIL = false;
    
    /**
     * Get the list of options for this policy.
     * 
     * @return the list of options for this policy.
     */
    public List getOptions();

    /**
     * Get the default option for this policy.
     * 
     * @return the default policy for this policy.
     */
    public String getDefaultOption();

    /**
     * Get the id for this policy.
     * 
     * @return the id for this policy.
     */
    public String getId();

    /**
     * Apply the download policy.
     * 
     * @param policySetting the policy setting.
     * @param request the list of request properties that the policy might use.
     * @param localFile
     * 
     * @return true if the policy passes.
     */
    public boolean applyPolicy( String policySetting, Properties request, File localFile );
}