source.dussan.org Git - archiva.git/blob

   1 package org.apache.maven.archiva.policies;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *  http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import java.io.File;
  23 import java.util.Properties;
  24
  25 /**
  26  * DownloadPolicy
  27  *
  28  * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
  29  * @version $Id$
  30  */
  31 public interface DownloadPolicy
  32 {
  33     /**
  34      * The IGNORED policy means that the policy is ignored.
  35      */
  36     public static final String IGNORED = "ignored";
  37
  38     /**
  39      * Get the default policy setting.
  40      *
  41      * @return the default policy setting.
  42      */
  43     public String getDefaultPolicySetting();
  44
  45     /**
  46      * Apply the download policy.
  47      *
  48      * @param policySetting the policy setting.
  49      * @param request the list of request properties that the policy might use.
  50      * @param localFile
  51      *
  52      * @return true if the policy passes.
  53      */
  54     public boolean applyPolicy( String policySetting, Properties request, File localFile );
  55 }