blob: dacf45c00332919036fb707805ea5befee6d7a3c [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.apache.archiva.consumers.core;<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.admin.model.beans.ManagedRepository;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.archiva.common.plexusbridge.DigesterUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.archiva.common.plexusbridge.PlexusSisuBridge;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.archiva.common.plexusbridge.PlexusSisuBridgeException;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.archiva.consumers.AbstractMonitoredConsumer;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.archiva.consumers.ConsumerException;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.archiva.consumers.KnownRepositoryContentConsumer;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.codehaus.plexus.digest.ChecksumFile;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.codehaus.plexus.digest.Digester;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.codehaus.plexus.digest.DigesterException;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.springframework.context.annotation.Scope;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.springframework.stereotype.Service;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> import javax.annotation.PostConstruct;<a name="line.35"></a>
<FONT color="green">036</FONT> import javax.inject.Inject;<a name="line.36"></a>
<FONT color="green">037</FONT> import java.io.File;<a name="line.37"></a>
<FONT color="green">038</FONT> import java.io.FileNotFoundException;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.io.IOException;<a name="line.39"></a>
<FONT color="green">040</FONT> import java.util.ArrayList;<a name="line.40"></a>
<FONT color="green">041</FONT> import java.util.Date;<a name="line.41"></a>
<FONT color="green">042</FONT> import java.util.List;<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * ValidateChecksumConsumer - validate the provided checksum against the file it represents.<a name="line.45"></a>
<FONT color="green">046</FONT> *<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> @Service( "knownRepositoryContentConsumer#validate-checksums" )<a name="line.49"></a>
<FONT color="green">050</FONT> @Scope( "prototype" )<a name="line.50"></a>
<FONT color="green">051</FONT> public class ValidateChecksumConsumer<a name="line.51"></a>
<FONT color="green">052</FONT> extends AbstractMonitoredConsumer<a name="line.52"></a>
<FONT color="green">053</FONT> implements KnownRepositoryContentConsumer<a name="line.53"></a>
<FONT color="green">054</FONT> {<a name="line.54"></a>
<FONT color="green">055</FONT> private static final String NOT_VALID_CHECKSUM = "checksum-not-valid";<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> private static final String CHECKSUM_NOT_FOUND = "checksum-not-found";<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> private static final String CHECKSUM_DIGESTER_FAILURE = "checksum-digester-failure";<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> private static final String CHECKSUM_IO_ERROR = "checksum-io-error";<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> /**<a name="line.63"></a>
<FONT color="green">064</FONT> * default-value="validate-checksums"<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> private String id = "validate-checksums";<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> /**<a name="line.68"></a>
<FONT color="green">069</FONT> * default-value="Validate checksums against file."<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> private String description = "Validate checksums against file.";<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> /**<a name="line.73"></a>
<FONT color="green">074</FONT> *<a name="line.74"></a>
<FONT color="green">075</FONT> */<a name="line.75"></a>
<FONT color="green">076</FONT> private ChecksumFile checksum;<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> /**<a name="line.78"></a>
<FONT color="green">079</FONT> *<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> private List&lt;Digester&gt; allDigesters;<a name="line.81"></a>
<FONT color="green">082</FONT> <a name="line.82"></a>
<FONT color="green">083</FONT> @Inject<a name="line.83"></a>
<FONT color="green">084</FONT> private PlexusSisuBridge plexusSisuBridge;<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> @Inject<a name="line.86"></a>
<FONT color="green">087</FONT> private DigesterUtils digesterUtils;<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> private File repositoryDir;<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> private List&lt;String&gt; includes;<a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> public String getId()<a name="line.93"></a>
<FONT color="green">094</FONT> {<a name="line.94"></a>
<FONT color="green">095</FONT> return this.id;<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> public String getDescription()<a name="line.98"></a>
<FONT color="green">099</FONT> {<a name="line.99"></a>
<FONT color="green">100</FONT> return this.description;<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> public boolean isPermanent()<a name="line.103"></a>
<FONT color="green">104</FONT> {<a name="line.104"></a>
<FONT color="green">105</FONT> return false;<a name="line.105"></a>
<FONT color="green">106</FONT> }<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> public void beginScan( ManagedRepository repository, Date whenGathered )<a name="line.108"></a>
<FONT color="green">109</FONT> throws ConsumerException<a name="line.109"></a>
<FONT color="green">110</FONT> {<a name="line.110"></a>
<FONT color="green">111</FONT> this.repositoryDir = new File( repository.getLocation() );<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> public void beginScan( ManagedRepository repository, Date whenGathered, boolean executeOnEntireRepo )<a name="line.114"></a>
<FONT color="green">115</FONT> throws ConsumerException<a name="line.115"></a>
<FONT color="green">116</FONT> {<a name="line.116"></a>
<FONT color="green">117</FONT> beginScan( repository, whenGathered );<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> <a name="line.119"></a>
<FONT color="green">120</FONT> public void completeScan()<a name="line.120"></a>
<FONT color="green">121</FONT> {<a name="line.121"></a>
<FONT color="green">122</FONT> /* nothing to do */<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> public void completeScan( boolean executeOnEntireRepo )<a name="line.125"></a>
<FONT color="green">126</FONT> {<a name="line.126"></a>
<FONT color="green">127</FONT> completeScan();<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> public List&lt;String&gt; getExcludes()<a name="line.130"></a>
<FONT color="green">131</FONT> {<a name="line.131"></a>
<FONT color="green">132</FONT> return null;<a name="line.132"></a>
<FONT color="green">133</FONT> }<a name="line.133"></a>
<FONT color="green">134</FONT> <a name="line.134"></a>
<FONT color="green">135</FONT> public List&lt;String&gt; getIncludes()<a name="line.135"></a>
<FONT color="green">136</FONT> {<a name="line.136"></a>
<FONT color="green">137</FONT> return this.includes;<a name="line.137"></a>
<FONT color="green">138</FONT> }<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> public void processFile( String path )<a name="line.140"></a>
<FONT color="green">141</FONT> throws ConsumerException<a name="line.141"></a>
<FONT color="green">142</FONT> {<a name="line.142"></a>
<FONT color="green">143</FONT> File checksumFile = new File( this.repositoryDir, path );<a name="line.143"></a>
<FONT color="green">144</FONT> try<a name="line.144"></a>
<FONT color="green">145</FONT> {<a name="line.145"></a>
<FONT color="green">146</FONT> if ( !checksum.isValidChecksum( checksumFile ) )<a name="line.146"></a>
<FONT color="green">147</FONT> {<a name="line.147"></a>
<FONT color="green">148</FONT> triggerConsumerWarning( NOT_VALID_CHECKSUM, "The checksum for " + checksumFile + " is invalid." );<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> }<a name="line.150"></a>
<FONT color="green">151</FONT> catch ( FileNotFoundException e )<a name="line.151"></a>
<FONT color="green">152</FONT> {<a name="line.152"></a>
<FONT color="green">153</FONT> triggerConsumerError( CHECKSUM_NOT_FOUND, "File not found during checksum validation: " + e.getMessage() );<a name="line.153"></a>
<FONT color="green">154</FONT> }<a name="line.154"></a>
<FONT color="green">155</FONT> catch ( DigesterException e )<a name="line.155"></a>
<FONT color="green">156</FONT> {<a name="line.156"></a>
<FONT color="green">157</FONT> triggerConsumerError( CHECKSUM_DIGESTER_FAILURE,<a name="line.157"></a>
<FONT color="green">158</FONT> "Digester failure during checksum validation on " + checksumFile );<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> catch ( IOException e )<a name="line.160"></a>
<FONT color="green">161</FONT> {<a name="line.161"></a>
<FONT color="green">162</FONT> triggerConsumerError( CHECKSUM_IO_ERROR, "Checksum I/O error during validation on " + checksumFile );<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> public void processFile( String path, boolean executeOnEntireReDpo )<a name="line.166"></a>
<FONT color="green">167</FONT> throws Exception<a name="line.167"></a>
<FONT color="green">168</FONT> {<a name="line.168"></a>
<FONT color="green">169</FONT> processFile( path );<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
<FONT color="green">171</FONT> <a name="line.171"></a>
<FONT color="green">172</FONT> @PostConstruct<a name="line.172"></a>
<FONT color="green">173</FONT> public void initialize()<a name="line.173"></a>
<FONT color="green">174</FONT> throws PlexusSisuBridgeException<a name="line.174"></a>
<FONT color="green">175</FONT> {<a name="line.175"></a>
<FONT color="green">176</FONT> checksum = plexusSisuBridge.lookup( ChecksumFile.class );<a name="line.176"></a>
<FONT color="green">177</FONT> List&lt;Digester&gt; allDigesters = new ArrayList&lt;Digester&gt;( digesterUtils.getAllDigesters() );<a name="line.177"></a>
<FONT color="green">178</FONT> includes = new ArrayList&lt;String&gt;( allDigesters.size() );<a name="line.178"></a>
<FONT color="green">179</FONT> for ( Digester digester : allDigesters )<a name="line.179"></a>
<FONT color="green">180</FONT> {<a name="line.180"></a>
<FONT color="green">181</FONT> includes.add( "**/*" + digester.getFilenameExtension() );<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> }<a name="line.183"></a>
<FONT color="green">184</FONT> }<a name="line.184"></a>
</PRE>
</BODY>
</HTML>