Google Git
Sign in
apache / archiva-web-content / 7c2ce1786c818e0e567e48c56f17c69702f385b0 / . / ref / 1.4-M4 / apidocs / src-html / org / apache / archiva / consumers / core / repository / AbstractRepositoryPurge.html
blob: ff5315c38bcbd66d5b672a17b2ddcfc2e83204c6 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.apache.archiva.consumers.core.repository;<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.audit.AuditEvent;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.archiva.common.utils.VersionUtil;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.archiva.metadata.model.ArtifactMetadata;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.archiva.metadata.model.maven2.MavenArtifactFacet;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.archiva.metadata.repository.MetadataRepository;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.archiva.metadata.repository.MetadataRepositoryException;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.archiva.metadata.repository.MetadataResolutionException;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.archiva.metadata.repository.RepositorySession;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.archiva.model.ArtifactReference;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.archiva.repository.ContentNotFoundException;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.archiva.repository.ManagedRepositoryContent;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.archiva.repository.events.RepositoryListener;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.commons.lang.StringUtils;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.slf4j.Logger;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.slf4j.LoggerFactory;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> import java.io.File;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.io.FilenameFilter;<a name="line.39"></a>
<FONT color="green">040</FONT> import java.util.Collection;<a name="line.40"></a>
<FONT color="green">041</FONT> import java.util.List;<a name="line.41"></a>
<FONT color="green">042</FONT> import java.util.Set;<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> * Base class for all repository purge tasks.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public abstract class AbstractRepositoryPurge<a name="line.47"></a>
<FONT color="green">048</FONT> implements RepositoryPurge<a name="line.48"></a>
<FONT color="green">049</FONT> {<a name="line.49"></a>
<FONT color="green">050</FONT> protected Logger log = LoggerFactory.getLogger( getClass() );<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> protected final ManagedRepositoryContent repository;<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> protected final RepositorySession repositorySession;<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> protected final List&lt;RepositoryListener&gt; listeners;<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> private Logger logger = LoggerFactory.getLogger( "org.apache.archiva.AuditLog" );<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> private static final char DELIM = ' ';<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> public AbstractRepositoryPurge( ManagedRepositoryContent repository, RepositorySession repositorySession,<a name="line.62"></a>
<FONT color="green">063</FONT> List&lt;RepositoryListener&gt; listeners )<a name="line.63"></a>
<FONT color="green">064</FONT> {<a name="line.64"></a>
<FONT color="green">065</FONT> this.repository = repository;<a name="line.65"></a>
<FONT color="green">066</FONT> this.repositorySession = repositorySession;<a name="line.66"></a>
<FONT color="green">067</FONT> this.listeners = listeners;<a name="line.67"></a>
<FONT color="green">068</FONT> }<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> /**<a name="line.70"></a>
<FONT color="green">071</FONT> * Purge the repo. Update db and index of removed artifacts.<a name="line.71"></a>
<FONT color="green">072</FONT> *<a name="line.72"></a>
<FONT color="green">073</FONT> * @param references<a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> protected void purge( Set&lt;ArtifactReference&gt; references )<a name="line.75"></a>
<FONT color="green">076</FONT> {<a name="line.76"></a>
<FONT color="green">077</FONT> if ( references != null &amp;&amp; !references.isEmpty() )<a name="line.77"></a>
<FONT color="green">078</FONT> {<a name="line.78"></a>
<FONT color="green">079</FONT> MetadataRepository metadataRepository = repositorySession.getRepository();<a name="line.79"></a>
<FONT color="green">080</FONT> for ( ArtifactReference reference : references )<a name="line.80"></a>
<FONT color="green">081</FONT> {<a name="line.81"></a>
<FONT color="green">082</FONT> File artifactFile = repository.toFile( reference );<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> for ( RepositoryListener listener : listeners )<a name="line.84"></a>
<FONT color="green">085</FONT> {<a name="line.85"></a>
<FONT color="green">086</FONT> listener.deleteArtifact( metadataRepository, repository.getId(), reference.getGroupId(),<a name="line.86"></a>
<FONT color="green">087</FONT> reference.getArtifactId(), reference.getVersion(),<a name="line.87"></a>
<FONT color="green">088</FONT> artifactFile.getName() );<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> // TODO: this needs to be logged<a name="line.91"></a>
<FONT color="green">092</FONT> artifactFile.delete();<a name="line.92"></a>
<FONT color="green">093</FONT> try<a name="line.93"></a>
<FONT color="green">094</FONT> {<a name="line.94"></a>
<FONT color="green">095</FONT> repository.deleteArtifact( reference );<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> catch ( ContentNotFoundException e )<a name="line.97"></a>
<FONT color="green">098</FONT> {<a name="line.98"></a>
<FONT color="green">099</FONT> log.warn( "skip error deleting artifact {}: {}", reference, e.getMessage() );<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> try<a name="line.102"></a>
<FONT color="green">103</FONT> {<a name="line.103"></a>
<FONT color="green">104</FONT> metadataRepository.removeProjectVersion( repository.getId(), reference.getGroupId(),<a name="line.104"></a>
<FONT color="green">105</FONT> reference.getArtifactId(), reference.getVersion() );<a name="line.105"></a>
<FONT color="green">106</FONT> }<a name="line.106"></a>
<FONT color="green">107</FONT> catch ( MetadataRepositoryException e )<a name="line.107"></a>
<FONT color="green">108</FONT> {<a name="line.108"></a>
<FONT color="green">109</FONT> log.warn( "skip error removeProjectVersion artifact {}: {}", reference, e.getMessage() );<a name="line.109"></a>
<FONT color="green">110</FONT> }<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> boolean snapshotVersion = VersionUtil.isSnapshot( reference.getVersion() );<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> try<a name="line.114"></a>
<FONT color="green">115</FONT> {<a name="line.115"></a>
<FONT color="green">116</FONT> if ( snapshotVersion )<a name="line.116"></a>
<FONT color="green">117</FONT> {<a name="line.117"></a>
<FONT color="green">118</FONT> String baseVersion = VersionUtil.getBaseVersion( reference.getVersion() );<a name="line.118"></a>
<FONT color="green">119</FONT> Collection&lt;ArtifactMetadata&gt; artifacts =<a name="line.119"></a>
<FONT color="green">120</FONT> metadataRepository.getArtifacts( repository.getId(), reference.getGroupId(),<a name="line.120"></a>
<FONT color="green">121</FONT> reference.getArtifactId(), baseVersion );<a name="line.121"></a>
<FONT color="green">122</FONT> if ( artifacts != null )<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> // cleanup snapshots metadata<a name="line.124"></a>
<FONT color="green">125</FONT> for ( ArtifactMetadata artifactMetadata : artifacts )<a name="line.125"></a>
<FONT color="green">126</FONT> {<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> // TODO: mismatch between artifact (snapshot) version and project (base) version here<a name="line.128"></a>
<FONT color="green">129</FONT> if ( artifactMetadata.getVersion().equals( reference.getVersion() ) )<a name="line.129"></a>
<FONT color="green">130</FONT> {<a name="line.130"></a>
<FONT color="green">131</FONT> if ( StringUtils.isNotBlank( reference.getClassifier() ) )<a name="line.131"></a>
<FONT color="green">132</FONT> {<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> // cleanup facet which contains classifier information<a name="line.134"></a>
<FONT color="green">135</FONT> MavenArtifactFacet mavenArtifactFacet =<a name="line.135"></a>
<FONT color="green">136</FONT> (MavenArtifactFacet) artifactMetadata.getFacet(<a name="line.136"></a>
<FONT color="green">137</FONT> MavenArtifactFacet.FACET_ID );<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> if ( StringUtils.equals( reference.getClassifier(),<a name="line.139"></a>
<FONT color="green">140</FONT> mavenArtifactFacet.getClassifier() ) )<a name="line.140"></a>
<FONT color="green">141</FONT> {<a name="line.141"></a>
<FONT color="green">142</FONT> artifactMetadata.removeFacet( MavenArtifactFacet.FACET_ID );<a name="line.142"></a>
<FONT color="green">143</FONT> String groupId = reference.getGroupId(), artifactId =<a name="line.143"></a>
<FONT color="green">144</FONT> reference.getArtifactId(),<a name="line.144"></a>
<FONT color="green">145</FONT> version = reference.getVersion();<a name="line.145"></a>
<FONT color="green">146</FONT> MavenArtifactFacet mavenArtifactFacetToCompare = new MavenArtifactFacet();<a name="line.146"></a>
<FONT color="green">147</FONT> mavenArtifactFacetToCompare.setClassifier( reference.getClassifier() );<a name="line.147"></a>
<FONT color="green">148</FONT> metadataRepository.removeArtifact( repository.getId(), groupId, artifactId,<a name="line.148"></a>
<FONT color="green">149</FONT> version, mavenArtifactFacetToCompare );<a name="line.149"></a>
<FONT color="green">150</FONT> metadataRepository.save();<a name="line.150"></a>
<FONT color="green">151</FONT> }<a name="line.151"></a>
<FONT color="green">152</FONT> <a name="line.152"></a>
<FONT color="green">153</FONT> }<a name="line.153"></a>
<FONT color="green">154</FONT> else<a name="line.154"></a>
<FONT color="green">155</FONT> {<a name="line.155"></a>
<FONT color="green">156</FONT> metadataRepository.removeArtifact( artifactMetadata, VersionUtil.getBaseVersion(<a name="line.156"></a>
<FONT color="green">157</FONT> reference.getVersion() ) );<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> <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> }<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> catch ( MetadataResolutionException e )<a name="line.165"></a>
<FONT color="green">166</FONT> {<a name="line.166"></a>
<FONT color="green">167</FONT> log.warn( "skip error deleting metadata {}: {}", reference, e.getMessage() );<a name="line.167"></a>
<FONT color="green">168</FONT> }<a name="line.168"></a>
<FONT color="green">169</FONT> catch ( MetadataRepositoryException e )<a name="line.169"></a>
<FONT color="green">170</FONT> {<a name="line.170"></a>
<FONT color="green">171</FONT> log.warn( "skip error deleting metadata {}: {}", reference, e.getMessage() );<a name="line.171"></a>
<FONT color="green">172</FONT> }<a name="line.172"></a>
<FONT color="green">173</FONT> <a name="line.173"></a>
<FONT color="green">174</FONT> repositorySession.save();<a name="line.174"></a>
<FONT color="green">175</FONT> <a name="line.175"></a>
<FONT color="green">176</FONT> triggerAuditEvent( repository.getRepository().getId(), ArtifactReference.toKey( reference ),<a name="line.176"></a>
<FONT color="green">177</FONT> AuditEvent.PURGE_ARTIFACT );<a name="line.177"></a>
<FONT color="green">178</FONT> purgeSupportFiles( artifactFile );<a name="line.178"></a>
<FONT color="green">179</FONT> }<a name="line.179"></a>
<FONT color="green">180</FONT> }<a name="line.180"></a>
<FONT color="green">181</FONT> }<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> * &lt;p&gt;<a name="line.184"></a>
<FONT color="green">185</FONT> * This find support files for the artifactFile and deletes them.<a name="line.185"></a>
<FONT color="green">186</FONT> * &lt;/p&gt;<a name="line.186"></a>
<FONT color="green">187</FONT> * &lt;p&gt;<a name="line.187"></a>
<FONT color="green">188</FONT> * Support Files are things like ".sha1", ".md5", ".asc", etc.<a name="line.188"></a>
<FONT color="green">189</FONT> * &lt;/p&gt;<a name="line.189"></a>
<FONT color="green">190</FONT> *<a name="line.190"></a>
<FONT color="green">191</FONT> * @param artifactFile the file to base off of.<a name="line.191"></a>
<FONT color="green">192</FONT> */<a name="line.192"></a>
<FONT color="green">193</FONT> private void purgeSupportFiles( File artifactFile )<a name="line.193"></a>
<FONT color="green">194</FONT> {<a name="line.194"></a>
<FONT color="green">195</FONT> File parentDir = artifactFile.getParentFile();<a name="line.195"></a>
<FONT color="green">196</FONT> <a name="line.196"></a>
<FONT color="green">197</FONT> if ( !parentDir.exists() )<a name="line.197"></a>
<FONT color="green">198</FONT> {<a name="line.198"></a>
<FONT color="green">199</FONT> return;<a name="line.199"></a>
<FONT color="green">200</FONT> }<a name="line.200"></a>
<FONT color="green">201</FONT> <a name="line.201"></a>
<FONT color="green">202</FONT> FilenameFilter filter = new ArtifactFilenameFilter( artifactFile.getName() );<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> File[] files = parentDir.listFiles( filter );<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> for ( File file : files )<a name="line.206"></a>
<FONT color="green">207</FONT> {<a name="line.207"></a>
<FONT color="green">208</FONT> if ( file.exists() &amp;&amp; file.isFile() )<a name="line.208"></a>
<FONT color="green">209</FONT> {<a name="line.209"></a>
<FONT color="green">210</FONT> String fileName = file.getName();<a name="line.210"></a>
<FONT color="green">211</FONT> file.delete();<a name="line.211"></a>
<FONT color="green">212</FONT> // TODO: log that it was deleted<a name="line.212"></a>
<FONT color="green">213</FONT> triggerAuditEvent( repository.getRepository().getId(), fileName, AuditEvent.PURGE_FILE );<a name="line.213"></a>
<FONT color="green">214</FONT> }<a name="line.214"></a>
<FONT color="green">215</FONT> }<a name="line.215"></a>
<FONT color="green">216</FONT> }<a name="line.216"></a>
<FONT color="green">217</FONT> <a name="line.217"></a>
<FONT color="green">218</FONT> private void triggerAuditEvent( String repoId, String resource, String action )<a name="line.218"></a>
<FONT color="green">219</FONT> {<a name="line.219"></a>
<FONT color="green">220</FONT> String msg =<a name="line.220"></a>
<FONT color="green">221</FONT> repoId + DELIM + "&lt;system-purge&gt;" + DELIM + "&lt;system&gt;" + DELIM + '\"' + resource + '\"' + DELIM + '\"' +<a name="line.221"></a>
<FONT color="green">222</FONT> action + '\"';<a name="line.222"></a>
<FONT color="green">223</FONT> <a name="line.223"></a>
<FONT color="green">224</FONT> logger.info( msg );<a name="line.224"></a>
<FONT color="green">225</FONT> }<a name="line.225"></a>
<FONT color="green">226</FONT> }<a name="line.226"></a>
</PRE>
</BODY>
</HTML>