Google Git
Sign in
apache / archiva-web-content / 7c2ce1786c818e0e567e48c56f17c69702f385b0 / . / ref / 1.4-M4 / apidocs / src-html / org / apache / archiva / consumers / metadata / ArchivaMetadataCreationConsumer.html
blob: 558f15f746dc6ff85e1e52cc52caa19e133c376a [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.apache.archiva.consumers.metadata;<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.utils.VersionUtil;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.archiva.configuration.ArchivaConfiguration;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.archiva.configuration.ConfigurationNames;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.archiva.configuration.FileTypes;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.archiva.consumers.AbstractMonitoredConsumer;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.archiva.consumers.ConsumerException;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.archiva.consumers.KnownRepositoryContentConsumer;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.archiva.metadata.model.ArtifactMetadata;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.archiva.metadata.model.ProjectMetadata;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.archiva.metadata.model.ProjectVersionMetadata;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.archiva.metadata.repository.MetadataRepository;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.archiva.metadata.repository.MetadataRepositoryException;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.archiva.metadata.repository.RepositorySession;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.apache.archiva.metadata.repository.RepositorySessionFactory;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.apache.archiva.metadata.repository.storage.ReadMetadataRequest;<a name="line.37"></a>
<FONT color="green">038</FONT> import org.apache.archiva.metadata.repository.storage.RepositoryStorage;<a name="line.38"></a>
<FONT color="green">039</FONT> import org.apache.archiva.metadata.repository.storage.RepositoryStorageMetadataInvalidException;<a name="line.39"></a>
<FONT color="green">040</FONT> import org.apache.archiva.metadata.repository.storage.RepositoryStorageMetadataNotFoundException;<a name="line.40"></a>
<FONT color="green">041</FONT> import org.apache.archiva.metadata.repository.storage.RepositoryStorageRuntimeException;<a name="line.41"></a>
<FONT color="green">042</FONT> import org.apache.archiva.redback.components.registry.Registry;<a name="line.42"></a>
<FONT color="green">043</FONT> import org.apache.archiva.redback.components.registry.RegistryListener;<a name="line.43"></a>
<FONT color="green">044</FONT> import org.slf4j.Logger;<a name="line.44"></a>
<FONT color="green">045</FONT> import org.slf4j.LoggerFactory;<a name="line.45"></a>
<FONT color="green">046</FONT> import org.springframework.context.annotation.Scope;<a name="line.46"></a>
<FONT color="green">047</FONT> import org.springframework.stereotype.Service;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> import javax.annotation.PostConstruct;<a name="line.49"></a>
<FONT color="green">050</FONT> import javax.inject.Inject;<a name="line.50"></a>
<FONT color="green">051</FONT> import javax.inject.Named;<a name="line.51"></a>
<FONT color="green">052</FONT> import java.util.ArrayList;<a name="line.52"></a>
<FONT color="green">053</FONT> import java.util.Date;<a name="line.53"></a>
<FONT color="green">054</FONT> import java.util.List;<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * Take an artifact off of disk and put it into the metadata repository.<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> @Service ("knownRepositoryContentConsumer#create-archiva-metadata")<a name="line.59"></a>
<FONT color="green">060</FONT> @Scope ("prototype")<a name="line.60"></a>
<FONT color="green">061</FONT> public class ArchivaMetadataCreationConsumer<a name="line.61"></a>
<FONT color="green">062</FONT> extends AbstractMonitoredConsumer<a name="line.62"></a>
<FONT color="green">063</FONT> implements KnownRepositoryContentConsumer, RegistryListener<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> * default-value="create-archiva-metadata"<a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> private String id = "create-archiva-metadata";<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> * default-value="Create basic metadata for Archiva to be able to reference the artifact"<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> private String description = "Create basic metadata for Archiva to be able to reference the artifact";<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> */<a name="line.76"></a>
<FONT color="green">077</FONT> @Inject<a name="line.77"></a>
<FONT color="green">078</FONT> private ArchivaConfiguration configuration;<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> */<a name="line.81"></a>
<FONT color="green">082</FONT> @Inject<a name="line.82"></a>
<FONT color="green">083</FONT> private FileTypes filetypes;<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> private Date whenGathered;<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> private List&lt;String&gt; includes = new ArrayList&lt;String&gt;( 0 );<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> /**<a name="line.89"></a>
<FONT color="green">090</FONT> * FIXME: this could be multiple implementations and needs to be configured.<a name="line.90"></a>
<FONT color="green">091</FONT> */<a name="line.91"></a>
<FONT color="green">092</FONT> @Inject<a name="line.92"></a>
<FONT color="green">093</FONT> private RepositorySessionFactory repositorySessionFactory;<a name="line.93"></a>
<FONT color="green">094</FONT> <a name="line.94"></a>
<FONT color="green">095</FONT> /**<a name="line.95"></a>
<FONT color="green">096</FONT> * FIXME: this needs to be configurable based on storage type - and could also be instantiated per repo. Change to a<a name="line.96"></a>
<FONT color="green">097</FONT> * factory.<a name="line.97"></a>
<FONT color="green">098</FONT> */<a name="line.98"></a>
<FONT color="green">099</FONT> @Inject<a name="line.99"></a>
<FONT color="green">100</FONT> @Named (value = "repositoryStorage#maven2")<a name="line.100"></a>
<FONT color="green">101</FONT> private RepositoryStorage repositoryStorage;<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> private static final Logger log = LoggerFactory.getLogger( ArchivaMetadataCreationConsumer.class );<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> private String repoId;<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> public String getId()<a name="line.107"></a>
<FONT color="green">108</FONT> {<a name="line.108"></a>
<FONT color="green">109</FONT> return this.id;<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> public String getDescription()<a name="line.112"></a>
<FONT color="green">113</FONT> {<a name="line.113"></a>
<FONT color="green">114</FONT> return this.description;<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> public boolean isPermanent()<a name="line.117"></a>
<FONT color="green">118</FONT> {<a name="line.118"></a>
<FONT color="green">119</FONT> return true;<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
<FONT color="green">121</FONT> <a name="line.121"></a>
<FONT color="green">122</FONT> public List&lt;String&gt; getExcludes()<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> return getDefaultArtifactExclusions();<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> public List&lt;String&gt; getIncludes()<a name="line.127"></a>
<FONT color="green">128</FONT> {<a name="line.128"></a>
<FONT color="green">129</FONT> return this.includes;<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> public void beginScan( ManagedRepository repo, Date whenGathered )<a name="line.132"></a>
<FONT color="green">133</FONT> throws ConsumerException<a name="line.133"></a>
<FONT color="green">134</FONT> {<a name="line.134"></a>
<FONT color="green">135</FONT> repoId = repo.getId();<a name="line.135"></a>
<FONT color="green">136</FONT> this.whenGathered = whenGathered;<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> public void beginScan( ManagedRepository repository, Date whenGathered, boolean executeOnEntireRepo )<a name="line.139"></a>
<FONT color="green">140</FONT> throws ConsumerException<a name="line.140"></a>
<FONT color="green">141</FONT> {<a name="line.141"></a>
<FONT color="green">142</FONT> beginScan( repository, whenGathered );<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> <a name="line.144"></a>
<FONT color="green">145</FONT> public void processFile( String path )<a name="line.145"></a>
<FONT color="green">146</FONT> throws ConsumerException<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> RepositorySession repositorySession = repositorySessionFactory.createSession();<a name="line.149"></a>
<FONT color="green">150</FONT> try<a name="line.150"></a>
<FONT color="green">151</FONT> {<a name="line.151"></a>
<FONT color="green">152</FONT> // note that we do minimal processing including checksums and POM information for performance of<a name="line.152"></a>
<FONT color="green">153</FONT> // the initial scan. Any request for this information will be intercepted and populated on-demand<a name="line.153"></a>
<FONT color="green">154</FONT> // or picked up by subsequent scans<a name="line.154"></a>
<FONT color="green">155</FONT> <a name="line.155"></a>
<FONT color="green">156</FONT> ArtifactMetadata artifact = repositoryStorage.readArtifactMetadataFromPath( repoId, path );<a name="line.156"></a>
<FONT color="green">157</FONT> <a name="line.157"></a>
<FONT color="green">158</FONT> ProjectMetadata project = new ProjectMetadata();<a name="line.158"></a>
<FONT color="green">159</FONT> project.setNamespace( artifact.getNamespace() );<a name="line.159"></a>
<FONT color="green">160</FONT> project.setId( artifact.getProject() );<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> String projectVersion = VersionUtil.getBaseVersion( artifact.getVersion() );<a name="line.162"></a>
<FONT color="green">163</FONT> <a name="line.163"></a>
<FONT color="green">164</FONT> MetadataRepository metadataRepository = repositorySession.getRepository();<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> boolean createVersionMetadata = false;<a name="line.166"></a>
<FONT color="green">167</FONT> <a name="line.167"></a>
<FONT color="green">168</FONT> // FIXME: maybe not too efficient since it may have already been read and stored for this artifact<a name="line.168"></a>
<FONT color="green">169</FONT> ProjectVersionMetadata versionMetadata = null;<a name="line.169"></a>
<FONT color="green">170</FONT> try<a name="line.170"></a>
<FONT color="green">171</FONT> {<a name="line.171"></a>
<FONT color="green">172</FONT> ReadMetadataRequest readMetadataRequest =<a name="line.172"></a>
<FONT color="green">173</FONT> new ReadMetadataRequest().repositoryId( repoId ).namespace( artifact.getNamespace() ).projectId(<a name="line.173"></a>
<FONT color="green">174</FONT> artifact.getProject() ).projectVersion( projectVersion );<a name="line.174"></a>
<FONT color="green">175</FONT> versionMetadata = repositoryStorage.readProjectVersionMetadata( readMetadataRequest );<a name="line.175"></a>
<FONT color="green">176</FONT> createVersionMetadata = true;<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> catch ( RepositoryStorageMetadataNotFoundException e )<a name="line.178"></a>
<FONT color="green">179</FONT> {<a name="line.179"></a>
<FONT color="green">180</FONT> log.warn( "Missing or invalid POM for artifact:{} (repository:{}); creating empty metadata", path,<a name="line.180"></a>
<FONT color="green">181</FONT> repoId );<a name="line.181"></a>
<FONT color="green">182</FONT> <a name="line.182"></a>
<FONT color="green">183</FONT> versionMetadata = new ProjectVersionMetadata();<a name="line.183"></a>
<FONT color="green">184</FONT> versionMetadata.setId( projectVersion );<a name="line.184"></a>
<FONT color="green">185</FONT> versionMetadata.setIncomplete( true );<a name="line.185"></a>
<FONT color="green">186</FONT> createVersionMetadata = true;<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> catch ( RepositoryStorageMetadataInvalidException e )<a name="line.188"></a>
<FONT color="green">189</FONT> {<a name="line.189"></a>
<FONT color="green">190</FONT> log.warn( "Error occurred resolving POM for artifact:{} (repository:{}); message: {}",<a name="line.190"></a>
<FONT color="green">191</FONT> new Object[]{ path, repoId, e.getMessage() } );<a name="line.191"></a>
<FONT color="green">192</FONT> }<a name="line.192"></a>
<FONT color="green">193</FONT> <a name="line.193"></a>
<FONT color="green">194</FONT> // read the metadata and update it if it is newer or doesn't exist<a name="line.194"></a>
<FONT color="green">195</FONT> artifact.setWhenGathered( whenGathered );<a name="line.195"></a>
<FONT color="green">196</FONT> metadataRepository.updateArtifact( repoId, project.getNamespace(), project.getId(), projectVersion,<a name="line.196"></a>
<FONT color="green">197</FONT> artifact );<a name="line.197"></a>
<FONT color="green">198</FONT> if ( createVersionMetadata )<a name="line.198"></a>
<FONT color="green">199</FONT> {<a name="line.199"></a>
<FONT color="green">200</FONT> metadataRepository.updateProjectVersion( repoId, project.getNamespace(), project.getId(),<a name="line.200"></a>
<FONT color="green">201</FONT> versionMetadata );<a name="line.201"></a>
<FONT color="green">202</FONT> }<a name="line.202"></a>
<FONT color="green">203</FONT> metadataRepository.updateProject( repoId, project );<a name="line.203"></a>
<FONT color="green">204</FONT> repositorySession.save();<a name="line.204"></a>
<FONT color="green">205</FONT> }<a name="line.205"></a>
<FONT color="green">206</FONT> catch ( MetadataRepositoryException e )<a name="line.206"></a>
<FONT color="green">207</FONT> {<a name="line.207"></a>
<FONT color="green">208</FONT> log.warn(<a name="line.208"></a>
<FONT color="green">209</FONT> "Error occurred persisting metadata for artifact:{} (repository:{}); message: {}" + e.getMessage(),<a name="line.209"></a>
<FONT color="green">210</FONT> new Object[]{ path, repoId, e.getMessage() }, e );<a name="line.210"></a>
<FONT color="green">211</FONT> repositorySession.revert();<a name="line.211"></a>
<FONT color="green">212</FONT> }<a name="line.212"></a>
<FONT color="green">213</FONT> catch ( RepositoryStorageRuntimeException e )<a name="line.213"></a>
<FONT color="green">214</FONT> {<a name="line.214"></a>
<FONT color="green">215</FONT> log.warn(<a name="line.215"></a>
<FONT color="green">216</FONT> "Error occurred persisting metadata for artifact:{} (repository:{}); message: {}" + e.getMessage(),<a name="line.216"></a>
<FONT color="green">217</FONT> new Object[]{ path, repoId, e.getMessage() }, e );<a name="line.217"></a>
<FONT color="green">218</FONT> repositorySession.revert();<a name="line.218"></a>
<FONT color="green">219</FONT> }<a name="line.219"></a>
<FONT color="green">220</FONT> finally<a name="line.220"></a>
<FONT color="green">221</FONT> {<a name="line.221"></a>
<FONT color="green">222</FONT> repositorySession.close();<a name="line.222"></a>
<FONT color="green">223</FONT> }<a name="line.223"></a>
<FONT color="green">224</FONT> }<a name="line.224"></a>
<FONT color="green">225</FONT> <a name="line.225"></a>
<FONT color="green">226</FONT> public void processFile( String path, boolean executeOnEntireRepo )<a name="line.226"></a>
<FONT color="green">227</FONT> throws ConsumerException<a name="line.227"></a>
<FONT color="green">228</FONT> {<a name="line.228"></a>
<FONT color="green">229</FONT> processFile( path );<a name="line.229"></a>
<FONT color="green">230</FONT> }<a name="line.230"></a>
<FONT color="green">231</FONT> <a name="line.231"></a>
<FONT color="green">232</FONT> public void completeScan()<a name="line.232"></a>
<FONT color="green">233</FONT> {<a name="line.233"></a>
<FONT color="green">234</FONT> /* do nothing */<a name="line.234"></a>
<FONT color="green">235</FONT> }<a name="line.235"></a>
<FONT color="green">236</FONT> <a name="line.236"></a>
<FONT color="green">237</FONT> public void completeScan( boolean executeOnEntireRepo )<a name="line.237"></a>
<FONT color="green">238</FONT> {<a name="line.238"></a>
<FONT color="green">239</FONT> completeScan();<a name="line.239"></a>
<FONT color="green">240</FONT> }<a name="line.240"></a>
<FONT color="green">241</FONT> <a name="line.241"></a>
<FONT color="green">242</FONT> public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )<a name="line.242"></a>
<FONT color="green">243</FONT> {<a name="line.243"></a>
<FONT color="green">244</FONT> if ( ConfigurationNames.isRepositoryScanning( propertyName ) )<a name="line.244"></a>
<FONT color="green">245</FONT> {<a name="line.245"></a>
<FONT color="green">246</FONT> initIncludes();<a name="line.246"></a>
<FONT color="green">247</FONT> }<a name="line.247"></a>
<FONT color="green">248</FONT> }<a name="line.248"></a>
<FONT color="green">249</FONT> <a name="line.249"></a>
<FONT color="green">250</FONT> public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )<a name="line.250"></a>
<FONT color="green">251</FONT> {<a name="line.251"></a>
<FONT color="green">252</FONT> /* do nothing */<a name="line.252"></a>
<FONT color="green">253</FONT> }<a name="line.253"></a>
<FONT color="green">254</FONT> <a name="line.254"></a>
<FONT color="green">255</FONT> private void initIncludes()<a name="line.255"></a>
<FONT color="green">256</FONT> {<a name="line.256"></a>
<FONT color="green">257</FONT> includes = new ArrayList&lt;String&gt;( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );<a name="line.257"></a>
<FONT color="green">258</FONT> }<a name="line.258"></a>
<FONT color="green">259</FONT> <a name="line.259"></a>
<FONT color="green">260</FONT> @PostConstruct<a name="line.260"></a>
<FONT color="green">261</FONT> public void initialize()<a name="line.261"></a>
<FONT color="green">262</FONT> {<a name="line.262"></a>
<FONT color="green">263</FONT> configuration.addChangeListener( this );<a name="line.263"></a>
<FONT color="green">264</FONT> <a name="line.264"></a>
<FONT color="green">265</FONT> initIncludes();<a name="line.265"></a>
<FONT color="green">266</FONT> }<a name="line.266"></a>
<FONT color="green">267</FONT> }<a name="line.267"></a>
</PRE>
</BODY>
</HTML>