blob: e85b6fd4f02b9f5781d91f9017b7cc1b3c1df0fa [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package org.apache.archiva.policies;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>/*<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a>
<span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * software distributed under the License is distributed on an<a name="line.15"></a>
<span class="sourceLineNo">016</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<span class="sourceLineNo">017</span> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<span class="sourceLineNo">018</span> * specific language governing permissions and limitations<a name="line.18"></a>
<span class="sourceLineNo">019</span> * under the License.<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.archiva.policies.urlcache.UrlFailureCache;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.commons.lang.StringUtils;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.Logger;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.slf4j.LoggerFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.springframework.stereotype.Service;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.inject.Inject;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.io.File;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.ArrayList;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.List;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.Properties;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link PreDownloadPolicy} to check if the requested url has failed before.<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>@Service( "preDownloadPolicy#cache-failures" )<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class CachedFailuresPolicy<a name="line.38"></a>
<span class="sourceLineNo">039</span> implements PreDownloadPolicy<a name="line.39"></a>
<span class="sourceLineNo">040</span>{<a name="line.40"></a>
<span class="sourceLineNo">041</span> private Logger log = LoggerFactory.getLogger( CachedFailuresPolicy.class );<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * The NO policy setting means that the the existence of old failures is &lt;strong&gt;not&lt;/strong&gt; checked.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * All resource requests are allowed thru to the remote repo.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static final String NO = "no";<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * The YES policy setting means that the existence of old failures is checked, and will<a name="line.50"></a>
<span class="sourceLineNo">051</span> * prevent the request from being performed against the remote repo.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static final String YES = "yes";<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> @Inject<a name="line.55"></a>
<span class="sourceLineNo">056</span> private UrlFailureCache urlFailureCache;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private List&lt;String&gt; options = new ArrayList&lt;&gt;( 2 );<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> public CachedFailuresPolicy()<a name="line.60"></a>
<span class="sourceLineNo">061</span> {<a name="line.61"></a>
<span class="sourceLineNo">062</span> options.add( NO );<a name="line.62"></a>
<span class="sourceLineNo">063</span> options.add( YES );<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> @Override<a name="line.66"></a>
<span class="sourceLineNo">067</span> public void applyPolicy( String policySetting, Properties request, File localFile )<a name="line.67"></a>
<span class="sourceLineNo">068</span> throws PolicyViolationException, PolicyConfigurationException<a name="line.68"></a>
<span class="sourceLineNo">069</span> {<a name="line.69"></a>
<span class="sourceLineNo">070</span> if ( !options.contains( policySetting ) )<a name="line.70"></a>
<span class="sourceLineNo">071</span> {<a name="line.71"></a>
<span class="sourceLineNo">072</span> // Not a valid code.<a name="line.72"></a>
<span class="sourceLineNo">073</span> throw new PolicyConfigurationException( "Unknown cache-failues policy setting [" + policySetting +<a name="line.73"></a>
<span class="sourceLineNo">074</span> "], valid settings are [" + StringUtils.join(<a name="line.74"></a>
<span class="sourceLineNo">075</span> options.iterator(), "," ) + "]" );<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> if ( NO.equals( policySetting ) )<a name="line.78"></a>
<span class="sourceLineNo">079</span> {<a name="line.79"></a>
<span class="sourceLineNo">080</span> // Skip.<a name="line.80"></a>
<span class="sourceLineNo">081</span> log.debug( "OK to fetch, check-failures policy set to NO." );<a name="line.81"></a>
<span class="sourceLineNo">082</span> return;<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> String url = request.getProperty( "url" );<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> if ( StringUtils.isNotBlank( url ) )<a name="line.87"></a>
<span class="sourceLineNo">088</span> {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if ( urlFailureCache.hasFailedBefore( url ) )<a name="line.89"></a>
<span class="sourceLineNo">090</span> {<a name="line.90"></a>
<span class="sourceLineNo">091</span> throw new PolicyViolationException(<a name="line.91"></a>
<span class="sourceLineNo">092</span> "NO to fetch, check-failures detected previous failure on url: " + url );<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> log.debug( "OK to fetch, check-failures detected no issues." );<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> @Override<a name="line.99"></a>
<span class="sourceLineNo">100</span> public String getDefaultOption()<a name="line.100"></a>
<span class="sourceLineNo">101</span> {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return NO;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> @Override<a name="line.105"></a>
<span class="sourceLineNo">106</span> public String getId()<a name="line.106"></a>
<span class="sourceLineNo">107</span> {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return "cache-failures";<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public String getName()<a name="line.112"></a>
<span class="sourceLineNo">113</span> {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return "Cache failures";<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> @Override<a name="line.117"></a>
<span class="sourceLineNo">118</span> public List&lt;String&gt; getOptions()<a name="line.118"></a>
<span class="sourceLineNo">119</span> {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return options;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span>}<a name="line.122"></a>
</pre>
</div>
</body>
</html>