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.ArrayList;
  24 import java.util.List;
  25 import java.util.Properties;
  26
  27 import org.apache.commons.lang.StringUtils;
  28 import org.apache.maven.archiva.policies.urlcache.UrlFailureCache;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  * {@link PreDownloadPolicy} to check if the requested url has failed before.
  34  *
  35  * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
  36  * @version $Id$
  37  * @plexus.component role="org.apache.maven.archiva.policies.PreDownloadPolicy"
  38  * role-hint="cache-failures"
  39  */
  40 public class CachedFailuresPolicy
  41     implements PreDownloadPolicy
  42 {
  43     private Logger log = LoggerFactory.getLogger( CachedFailuresPolicy.class );
  44
  45     /**
  46      * The NO policy setting means that the the existence of old failures is <strong>not</strong> checked.
  47      * All resource requests are allowed thru to the remote repo.
  48      */
  49     public static final String NO = "no";
  50
  51     /**
  52      * The YES policy setting means that the existence of old failures is checked, and will
  53      * prevent the request from being performed against the remote repo.
  54      */
  55     public static final String YES = "yes";
  56
  57     /**
  58      * @plexus.requirement
  59      */
  60     private UrlFailureCache urlFailureCache;
  61
  62     private List<String> options = new ArrayList<String>();
  63
  64     public CachedFailuresPolicy()
  65     {
  66         options.add( NO );
  67         options.add( YES );
  68     }
  69
  70     public void applyPolicy( String policySetting, Properties request, File localFile )
  71         throws PolicyViolationException, PolicyConfigurationException
  72     {
  73         if ( !options.contains( policySetting ) )
  74         {
  75             // Not a valid code.
  76             throw new PolicyConfigurationException( "Unknown cache-failues policy setting [" + policySetting +
  77                 "], valid settings are [" + StringUtils.join( options.iterator(), "," ) + "]" );
  78         }
  79
  80         if ( NO.equals( policySetting ) )
  81         {
  82             // Skip.
  83             log.debug( "OK to fetch, check-failures policy set to NO." );
  84             return;
  85         }
  86
  87         String url = request.getProperty( "url" );
  88
  89         if ( StringUtils.isNotBlank( url ) )
  90         {
  91             if ( urlFailureCache.hasFailedBefore( url ) )
  92             {
  93                 throw new PolicyViolationException(
  94                     "NO to fetch, check-failures detected previous failure on url: " + url );
  95             }
  96         }
  97
  98         log.debug( "OK to fetch, check-failures detected no issues." );
  99     }
 100
 101     public String getDefaultOption()
 102     {
 103         return NO;
 104     }
 105
 106     public String getId()
 107     {
 108         return "cache-failures";
 109     }
 110
 111     public List<String> getOptions()
 112     {
 113         return options;
 114     }
 115 }