blob: e813a9ca97366171d22e18a4504c82390f27d4d6 [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.commons.lang.StringUtils;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.springframework.stereotype.Service;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.io.File;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.ArrayList;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Map;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.Properties;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * PropagateErrorsPolicy - a policy applied on error to determine how to treat the error.<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>@Service( "downloadErrorPolicy#propagate-errors" )<a name="line.36"></a>
<span class="sourceLineNo">037</span>public class PropagateErrorsDownloadPolicy<a name="line.37"></a>
<span class="sourceLineNo">038</span> implements DownloadErrorPolicy<a name="line.38"></a>
<span class="sourceLineNo">039</span>{<a name="line.39"></a>
<span class="sourceLineNo">040</span> private Logger log = LoggerFactory.getLogger( PropagateErrorsDownloadPolicy.class );<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Signifies any error should stop searching for other proxies.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> public static final String STOP = "stop";<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Propagate errors at the end after all are gathered, if there was no successful download from other proxies.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> public static final String QUEUE = "queue error";<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
<span class="sourceLineNo">053</span> * Ignore errors and treat as if it were not found.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static final String IGNORE = "ignore";<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> private List&lt;String&gt; options = new ArrayList&lt;&gt;( 3 );<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> public PropagateErrorsDownloadPolicy()<a name="line.59"></a>
<span class="sourceLineNo">060</span> {<a name="line.60"></a>
<span class="sourceLineNo">061</span> options.add( STOP );<a name="line.61"></a>
<span class="sourceLineNo">062</span> options.add( QUEUE );<a name="line.62"></a>
<span class="sourceLineNo">063</span> options.add( IGNORE );<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 boolean applyPolicy( String policySetting, Properties request, File localFile, Exception exception,<a name="line.67"></a>
<span class="sourceLineNo">068</span> Map&lt;String, Exception&gt; previousExceptions )<a name="line.68"></a>
<span class="sourceLineNo">069</span> throws PolicyConfigurationException<a name="line.69"></a>
<span class="sourceLineNo">070</span> {<a name="line.70"></a>
<span class="sourceLineNo">071</span> if ( !options.contains( policySetting ) )<a name="line.71"></a>
<span class="sourceLineNo">072</span> {<a name="line.72"></a>
<span class="sourceLineNo">073</span> // Not a valid code.<a name="line.73"></a>
<span class="sourceLineNo">074</span> throw new PolicyConfigurationException( "Unknown error policy setting [" + policySetting +<a name="line.74"></a>
<span class="sourceLineNo">075</span> "], valid settings are [" + StringUtils.join(<a name="line.75"></a>
<span class="sourceLineNo">076</span> options.iterator(), "," ) + "]" );<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> if ( IGNORE.equals( policySetting ) )<a name="line.79"></a>
<span class="sourceLineNo">080</span> {<a name="line.80"></a>
<span class="sourceLineNo">081</span> // Ignore.<a name="line.81"></a>
<span class="sourceLineNo">082</span> log.debug( "Error policy set to IGNORE." );<a name="line.82"></a>
<span class="sourceLineNo">083</span> return false;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> String repositoryId = request.getProperty( "remoteRepositoryId" );<a name="line.86"></a>
<span class="sourceLineNo">087</span> if ( STOP.equals( policySetting ) )<a name="line.87"></a>
<span class="sourceLineNo">088</span> {<a name="line.88"></a>
<span class="sourceLineNo">089</span> return true;<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> if ( QUEUE.equals( policySetting ) )<a name="line.92"></a>
<span class="sourceLineNo">093</span> {<a name="line.93"></a>
<span class="sourceLineNo">094</span> previousExceptions.put( repositoryId, exception );<a name="line.94"></a>
<span class="sourceLineNo">095</span> return true;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> throw new PolicyConfigurationException(<a name="line.98"></a>
<span class="sourceLineNo">099</span> "Unable to process checksum policy of [" + policySetting + "], please file a bug report." );<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> @Override<a name="line.102"></a>
<span class="sourceLineNo">103</span> public String getDefaultOption()<a name="line.103"></a>
<span class="sourceLineNo">104</span> {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return QUEUE;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> @Override<a name="line.108"></a>
<span class="sourceLineNo">109</span> public String getId()<a name="line.109"></a>
<span class="sourceLineNo">110</span> {<a name="line.110"></a>
<span class="sourceLineNo">111</span> return "propagate-errors";<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> @Override<a name="line.114"></a>
<span class="sourceLineNo">115</span> public String getName()<a name="line.115"></a>
<span class="sourceLineNo">116</span> {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return "On remote error";<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span> public List&lt;String&gt; getOptions()<a name="line.121"></a>
<span class="sourceLineNo">122</span> {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return options;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span>}<a name="line.125"></a>
</pre>
</div>
</body>
</html>