Google Git
Sign in
apache / archiva-web-content / 9a87f855e11950826bc2a275e8513794c0129da4 / . / ref / 1.4-M4 / apidocs / src-html / org / apache / archiva / policies / AbstractUpdatePolicy.html
blob: 1a6cbc661aef65e22c4b79d2ea93f92a5ea3fdc4 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.apache.archiva.policies;<a name="line.1"></a>
<FONT color="green">002</FONT> <a name="line.2"></a>
<FONT color="green">003</FONT> /*<a name="line.3"></a>
<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<FONT color="green">013</FONT> *<a name="line.13"></a>
<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.archiva.common.utils.VersionUtil;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.commons.lang.StringUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.slf4j.Logger;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.slf4j.LoggerFactory;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import java.io.File;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.ArrayList;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.util.Calendar;<a name="line.29"></a>
<FONT color="green">030</FONT> import java.util.List;<a name="line.30"></a>
<FONT color="green">031</FONT> import java.util.Properties;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * AbstractUpdatePolicy<a name="line.34"></a>
<FONT color="green">035</FONT> *<a name="line.35"></a>
<FONT color="green">036</FONT> *<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public abstract class AbstractUpdatePolicy<a name="line.38"></a>
<FONT color="green">039</FONT> implements PreDownloadPolicy<a name="line.39"></a>
<FONT color="green">040</FONT> {<a name="line.40"></a>
<FONT color="green">041</FONT> private Logger log = LoggerFactory.getLogger( AbstractUpdatePolicy.class );<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * The ALWAYS policy setting means that the artifact is always uipdated from the remote repo.<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public static final String ALWAYS = "always";<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> /**<a name="line.48"></a>
<FONT color="green">049</FONT> * The NEVER policy setting means that the artifact is never updated from the remote repo.<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> public static final String NEVER = "never";<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /**<a name="line.53"></a>
<FONT color="green">054</FONT> * &lt;p&gt;<a name="line.54"></a>
<FONT color="green">055</FONT> * The DAILY policy means that the artifact retrieval occurs only if one of<a name="line.55"></a>
<FONT color="green">056</FONT> * the following conditions are met...<a name="line.56"></a>
<FONT color="green">057</FONT> * &lt;/p&gt;<a name="line.57"></a>
<FONT color="green">058</FONT> * &lt;ul&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;li&gt;The local artifact is not present.&lt;/li&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * &lt;li&gt;The local artifact has a last modified timestamp older than (now - 1 day).&lt;/li&gt;<a name="line.60"></a>
<FONT color="green">061</FONT> * &lt;/ul&gt;<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> public static final String DAILY = "daily";<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /**<a name="line.65"></a>
<FONT color="green">066</FONT> * &lt;p&gt;<a name="line.66"></a>
<FONT color="green">067</FONT> * The HOURLY policy means that the artifact retrieval occurs only if one of<a name="line.67"></a>
<FONT color="green">068</FONT> * the following conditions are met...<a name="line.68"></a>
<FONT color="green">069</FONT> * &lt;/p&gt;<a name="line.69"></a>
<FONT color="green">070</FONT> * &lt;ul&gt;<a name="line.70"></a>
<FONT color="green">071</FONT> * &lt;li&gt;The local artifact is not present.&lt;/li&gt;<a name="line.71"></a>
<FONT color="green">072</FONT> * &lt;li&gt;The local artifact has a last modified timestamp older than (now - 1 hour).&lt;/li&gt;<a name="line.72"></a>
<FONT color="green">073</FONT> * &lt;/ul&gt;<a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> public static final String HOURLY = "hourly";<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * The ONCE policy means that the artifact retrieval occurs only if the<a name="line.78"></a>
<FONT color="green">079</FONT> * local artifact is not present. This means that the retreival can only<a name="line.79"></a>
<FONT color="green">080</FONT> * occur once.<a name="line.80"></a>
<FONT color="green">081</FONT> */<a name="line.81"></a>
<FONT color="green">082</FONT> public static final String ONCE = "once";<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> private List&lt;String&gt; options = new ArrayList&lt;String&gt;( 5 );<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> public AbstractUpdatePolicy()<a name="line.86"></a>
<FONT color="green">087</FONT> {<a name="line.87"></a>
<FONT color="green">088</FONT> options.add( ALWAYS );<a name="line.88"></a>
<FONT color="green">089</FONT> options.add( HOURLY );<a name="line.89"></a>
<FONT color="green">090</FONT> options.add( DAILY );<a name="line.90"></a>
<FONT color="green">091</FONT> options.add( ONCE );<a name="line.91"></a>
<FONT color="green">092</FONT> options.add( NEVER );<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> <a name="line.94"></a>
<FONT color="green">095</FONT> protected abstract boolean isSnapshotPolicy();<a name="line.95"></a>
<FONT color="green">096</FONT> <a name="line.96"></a>
<FONT color="green">097</FONT> protected abstract String getUpdateMode();<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> public List&lt;String&gt; getOptions()<a name="line.99"></a>
<FONT color="green">100</FONT> {<a name="line.100"></a>
<FONT color="green">101</FONT> return options;<a name="line.101"></a>
<FONT color="green">102</FONT> }<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> public void applyPolicy( String policySetting, Properties request, File localFile )<a name="line.104"></a>
<FONT color="green">105</FONT> throws PolicyViolationException, PolicyConfigurationException<a name="line.105"></a>
<FONT color="green">106</FONT> {<a name="line.106"></a>
<FONT color="green">107</FONT> if ( !StringUtils.equals( request.getProperty( "filetype" ), "artifact" ) )<a name="line.107"></a>
<FONT color="green">108</FONT> {<a name="line.108"></a>
<FONT color="green">109</FONT> // Only process artifact file types.<a name="line.109"></a>
<FONT color="green">110</FONT> return;<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> String version = request.getProperty( "version", "" );<a name="line.113"></a>
<FONT color="green">114</FONT> boolean isSnapshotVersion = false;<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> if ( StringUtils.isNotBlank( version ) )<a name="line.116"></a>
<FONT color="green">117</FONT> {<a name="line.117"></a>
<FONT color="green">118</FONT> isSnapshotVersion = VersionUtil.isSnapshot( version );<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> if ( !options.contains( policySetting ) )<a name="line.121"></a>
<FONT color="green">122</FONT> {<a name="line.122"></a>
<FONT color="green">123</FONT> // Not a valid code. <a name="line.123"></a>
<FONT color="green">124</FONT> throw new PolicyConfigurationException(<a name="line.124"></a>
<FONT color="green">125</FONT> "Unknown " + getUpdateMode() + " policy setting [" + policySetting + "], valid settings are ["<a name="line.125"></a>
<FONT color="green">126</FONT> + StringUtils.join( options.iterator(), "," ) + "]" );<a name="line.126"></a>
<FONT color="green">127</FONT> }<a name="line.127"></a>
<FONT color="green">128</FONT> <a name="line.128"></a>
<FONT color="green">129</FONT> if ( ALWAYS.equals( policySetting ) )<a name="line.129"></a>
<FONT color="green">130</FONT> {<a name="line.130"></a>
<FONT color="green">131</FONT> // Skip means ok to update.<a name="line.131"></a>
<FONT color="green">132</FONT> log.debug( "OK to update, {} policy set to ALWAYS.", getUpdateMode() );<a name="line.132"></a>
<FONT color="green">133</FONT> return;<a name="line.133"></a>
<FONT color="green">134</FONT> }<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> // Test for mismatches.<a name="line.136"></a>
<FONT color="green">137</FONT> if ( !isSnapshotVersion &amp;&amp; isSnapshotPolicy() )<a name="line.137"></a>
<FONT color="green">138</FONT> {<a name="line.138"></a>
<FONT color="green">139</FONT> log.debug( "OK to update, snapshot policy does not apply for non-snapshot versions." );<a name="line.139"></a>
<FONT color="green">140</FONT> return;<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> <a name="line.142"></a>
<FONT color="green">143</FONT> if ( isSnapshotVersion &amp;&amp; !isSnapshotPolicy() )<a name="line.143"></a>
<FONT color="green">144</FONT> {<a name="line.144"></a>
<FONT color="green">145</FONT> log.debug( "OK to update, release policy does not apply for snapshot versions." );<a name="line.145"></a>
<FONT color="green">146</FONT> return;<a name="line.146"></a>
<FONT color="green">147</FONT> }<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> if ( NEVER.equals( policySetting ) )<a name="line.149"></a>
<FONT color="green">150</FONT> {<a name="line.150"></a>
<FONT color="green">151</FONT> // Reject means no.<a name="line.151"></a>
<FONT color="green">152</FONT> throw new PolicyViolationException( "NO to update, " + getUpdateMode() + " policy set to NEVER." );<a name="line.152"></a>
<FONT color="green">153</FONT> }<a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> if ( !localFile.exists() )<a name="line.155"></a>
<FONT color="green">156</FONT> {<a name="line.156"></a>
<FONT color="green">157</FONT> // No file means it's ok.<a name="line.157"></a>
<FONT color="green">158</FONT> log.debug( "OK to update {}, local file does not exist.", getUpdateMode() );<a name="line.158"></a>
<FONT color="green">159</FONT> return;<a name="line.159"></a>
<FONT color="green">160</FONT> }<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> if ( ONCE.equals( policySetting ) )<a name="line.162"></a>
<FONT color="green">163</FONT> {<a name="line.163"></a>
<FONT color="green">164</FONT> // File exists, but policy is once.<a name="line.164"></a>
<FONT color="green">165</FONT> throw new PolicyViolationException(<a name="line.165"></a>
<FONT color="green">166</FONT> "NO to update " + getUpdateMode() + ", policy is ONCE, and local file exist." );<a name="line.166"></a>
<FONT color="green">167</FONT> }<a name="line.167"></a>
<FONT color="green">168</FONT> <a name="line.168"></a>
<FONT color="green">169</FONT> if ( DAILY.equals( policySetting ) )<a name="line.169"></a>
<FONT color="green">170</FONT> {<a name="line.170"></a>
<FONT color="green">171</FONT> Calendar cal = Calendar.getInstance();<a name="line.171"></a>
<FONT color="green">172</FONT> cal.add( Calendar.DAY_OF_MONTH, -1 );<a name="line.172"></a>
<FONT color="green">173</FONT> Calendar fileCal = Calendar.getInstance();<a name="line.173"></a>
<FONT color="green">174</FONT> fileCal.setTimeInMillis( localFile.lastModified() );<a name="line.174"></a>
<FONT color="green">175</FONT> <a name="line.175"></a>
<FONT color="green">176</FONT> if ( cal.after( fileCal ) )<a name="line.176"></a>
<FONT color="green">177</FONT> {<a name="line.177"></a>
<FONT color="green">178</FONT> // Its ok.<a name="line.178"></a>
<FONT color="green">179</FONT> return;<a name="line.179"></a>
<FONT color="green">180</FONT> }<a name="line.180"></a>
<FONT color="green">181</FONT> else<a name="line.181"></a>
<FONT color="green">182</FONT> {<a name="line.182"></a>
<FONT color="green">183</FONT> throw new PolicyViolationException( "NO to update " + getUpdateMode()<a name="line.183"></a>
<FONT color="green">184</FONT> + ", policy is DAILY, local file exist, and has been updated within the last day." );<a name="line.184"></a>
<FONT color="green">185</FONT> }<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> <a name="line.187"></a>
<FONT color="green">188</FONT> if ( HOURLY.equals( policySetting ) )<a name="line.188"></a>
<FONT color="green">189</FONT> {<a name="line.189"></a>
<FONT color="green">190</FONT> Calendar cal = Calendar.getInstance();<a name="line.190"></a>
<FONT color="green">191</FONT> cal.add( Calendar.HOUR, -1 );<a name="line.191"></a>
<FONT color="green">192</FONT> Calendar fileCal = Calendar.getInstance();<a name="line.192"></a>
<FONT color="green">193</FONT> fileCal.setTimeInMillis( localFile.lastModified() );<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> if ( cal.after( fileCal ) )<a name="line.195"></a>
<FONT color="green">196</FONT> {<a name="line.196"></a>
<FONT color="green">197</FONT> // Its ok.<a name="line.197"></a>
<FONT color="green">198</FONT> return;<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> else<a name="line.200"></a>
<FONT color="green">201</FONT> {<a name="line.201"></a>
<FONT color="green">202</FONT> throw new PolicyViolationException( "NO to update " + getUpdateMode()<a name="line.202"></a>
<FONT color="green">203</FONT> + ", policy is HOURLY, local file exist, and has been updated within the last hour." );<a name="line.203"></a>
<FONT color="green">204</FONT> }<a name="line.204"></a>
<FONT color="green">205</FONT> }<a name="line.205"></a>
<FONT color="green">206</FONT> <a name="line.206"></a>
<FONT color="green">207</FONT> throw new PolicyConfigurationException(<a name="line.207"></a>
<FONT color="green">208</FONT> "Unable to process " + getUpdateMode() + " policy of [" + policySetting + "], please file a bug report." );<a name="line.208"></a>
<FONT color="green">209</FONT> }<a name="line.209"></a>
<FONT color="green">210</FONT> }<a name="line.210"></a>
</PRE>
</BODY>
</HTML>