blob: a5ad7baeeab5d2a3a4724b9d8a4767f05a8d7b3d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="de">
<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.repository.metadata.base;<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.archiva.model.ArchivaRepositoryMetadata;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.archiva.model.Plugin;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.archiva.repository.metadata.RepositoryMetadataException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.archiva.repository.storage.StorageAsset;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.archiva.xml.XMLException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.archiva.xml.XMLWriter;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.archiva.xml.XmlUtil;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.commons.collections4.CollectionUtils;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.commons.lang3.StringUtils;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.slf4j.Logger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.slf4j.LoggerFactory;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.w3c.dom.Document;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.w3c.dom.Element;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>import javax.xml.parsers.ParserConfigurationException;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import java.io.IOException;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.io.OutputStreamWriter;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import java.io.Writer;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import java.util.Collections;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import java.util.Comparator;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import java.util.Iterator;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import java.util.List;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>/**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * RepositoryMetadataWriter<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>public class RepositoryMetadataWriter<a name="line.48"></a>
<span class="sourceLineNo">049</span>{<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final Logger log = LoggerFactory.getLogger(RepositoryMetadataWriter.class);<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public static void write( ArchivaRepositoryMetadata metadata, StorageAsset outputFile )<a name="line.52"></a>
<span class="sourceLineNo">053</span> throws RepositoryMetadataException<a name="line.53"></a>
<span class="sourceLineNo">054</span> {<a name="line.54"></a>
<span class="sourceLineNo">055</span> boolean thrown = false;<a name="line.55"></a>
<span class="sourceLineNo">056</span> try (OutputStreamWriter writer = new OutputStreamWriter( outputFile.getWriteStream(true)))<a name="line.56"></a>
<span class="sourceLineNo">057</span> {<a name="line.57"></a>
<span class="sourceLineNo">058</span> write( metadata, writer );<a name="line.58"></a>
<span class="sourceLineNo">059</span> writer.flush();<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span> catch ( IOException e )<a name="line.61"></a>
<span class="sourceLineNo">062</span> {<a name="line.62"></a>
<span class="sourceLineNo">063</span> thrown = true;<a name="line.63"></a>
<span class="sourceLineNo">064</span> throw new RepositoryMetadataException(<a name="line.64"></a>
<span class="sourceLineNo">065</span> "Unable to write metadata file: " + outputFile.getPath() + " - " + e.getMessage(), e );<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> finally<a name="line.67"></a>
<span class="sourceLineNo">068</span> {<a name="line.68"></a>
<span class="sourceLineNo">069</span> if ( thrown )<a name="line.69"></a>
<span class="sourceLineNo">070</span> {<a name="line.70"></a>
<span class="sourceLineNo">071</span> try {<a name="line.71"></a>
<span class="sourceLineNo">072</span> outputFile.getStorage().removeAsset(outputFile);<a name="line.72"></a>
<span class="sourceLineNo">073</span> } catch (IOException e) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> log.error("Could not remove asset {}", outputFile);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<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><a name="line.79"></a>
<span class="sourceLineNo">080</span> public static void write( ArchivaRepositoryMetadata metadata, Writer writer )<a name="line.80"></a>
<span class="sourceLineNo">081</span> throws RepositoryMetadataException<a name="line.81"></a>
<span class="sourceLineNo">082</span> {<a name="line.82"></a>
<span class="sourceLineNo">083</span> Document doc = null;<a name="line.83"></a>
<span class="sourceLineNo">084</span> try {<a name="line.84"></a>
<span class="sourceLineNo">085</span> doc = XmlUtil.createDocument();<a name="line.85"></a>
<span class="sourceLineNo">086</span> } catch (ParserConfigurationException e) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> throw new RepositoryMetadataException("Could not create xml doc " + e.getMessage(), e);<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> Element root = doc.createElement( "metadata" );<a name="line.90"></a>
<span class="sourceLineNo">091</span> doc.appendChild(root);<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> addOptionalElementText( root, "groupId", metadata.getGroupId() );<a name="line.93"></a>
<span class="sourceLineNo">094</span> addOptionalElementText( root, "artifactId", metadata.getArtifactId() );<a name="line.94"></a>
<span class="sourceLineNo">095</span> addOptionalElementText( root, "version", metadata.getVersion() );<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> if ( CollectionUtils.isNotEmpty( metadata.getPlugins() ) )<a name="line.97"></a>
<span class="sourceLineNo">098</span> {<a name="line.98"></a>
<span class="sourceLineNo">099</span> Element plugins = XmlUtil.addChild(root, "plugins" );<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> List&lt;Plugin&gt; pluginList = metadata.getPlugins();<a name="line.101"></a>
<span class="sourceLineNo">102</span> Collections.sort( pluginList, PluginComparator.INSTANCE );<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> for ( Plugin plugin : metadata.getPlugins() )<a name="line.104"></a>
<span class="sourceLineNo">105</span> {<a name="line.105"></a>
<span class="sourceLineNo">106</span> Element p = XmlUtil.addChild(plugins, "plugin" );<a name="line.106"></a>
<span class="sourceLineNo">107</span> XmlUtil.addChild(doc, p, "prefix" ).setTextContent( plugin.getPrefix() );<a name="line.107"></a>
<span class="sourceLineNo">108</span> XmlUtil.addChild(doc, p, "artifactId" ).setTextContent( plugin.getArtifactId() );<a name="line.108"></a>
<span class="sourceLineNo">109</span> addOptionalElementText( p, "name", plugin.getName() );<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> if ( CollectionUtils.isNotEmpty( metadata.getAvailableVersions() ) //<a name="line.113"></a>
<span class="sourceLineNo">114</span> || StringUtils.isNotBlank( metadata.getReleasedVersion() ) //<a name="line.114"></a>
<span class="sourceLineNo">115</span> || StringUtils.isNotBlank( metadata.getLatestVersion() ) //<a name="line.115"></a>
<span class="sourceLineNo">116</span> || StringUtils.isNotBlank( metadata.getLastUpdated() ) //<a name="line.116"></a>
<span class="sourceLineNo">117</span> || ( metadata.getSnapshotVersion() != null ) )<a name="line.117"></a>
<span class="sourceLineNo">118</span> {<a name="line.118"></a>
<span class="sourceLineNo">119</span> Element versioning = XmlUtil.addChild(root, "versioning" );<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> addOptionalElementText( versioning, "latest", metadata.getLatestVersion() );<a name="line.121"></a>
<span class="sourceLineNo">122</span> addOptionalElementText( versioning, "release", metadata.getReleasedVersion() );<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> if ( metadata.getSnapshotVersion() != null )<a name="line.124"></a>
<span class="sourceLineNo">125</span> {<a name="line.125"></a>
<span class="sourceLineNo">126</span> Element snapshot = XmlUtil.addChild(versioning, "snapshot" );<a name="line.126"></a>
<span class="sourceLineNo">127</span> String bnum = String.valueOf( metadata.getSnapshotVersion().getBuildNumber() );<a name="line.127"></a>
<span class="sourceLineNo">128</span> addOptionalElementText( snapshot, "buildNumber", bnum );<a name="line.128"></a>
<span class="sourceLineNo">129</span> addOptionalElementText( snapshot, "timestamp", metadata.getSnapshotVersion().getTimestamp() );<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> if ( CollectionUtils.isNotEmpty( metadata.getAvailableVersions() ) )<a name="line.132"></a>
<span class="sourceLineNo">133</span> {<a name="line.133"></a>
<span class="sourceLineNo">134</span> Element versions = XmlUtil.addChild(versioning, "versions" );<a name="line.134"></a>
<span class="sourceLineNo">135</span> Iterator&lt;String&gt; it = metadata.getAvailableVersions().iterator();<a name="line.135"></a>
<span class="sourceLineNo">136</span> while ( it.hasNext() )<a name="line.136"></a>
<span class="sourceLineNo">137</span> {<a name="line.137"></a>
<span class="sourceLineNo">138</span> String version = it.next();<a name="line.138"></a>
<span class="sourceLineNo">139</span> XmlUtil.addChild(versions, "version" ).setTextContent( version );<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> addOptionalElementText( versioning, "lastUpdated", metadata.getLastUpdated() );<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> try<a name="line.146"></a>
<span class="sourceLineNo">147</span> {<a name="line.147"></a>
<span class="sourceLineNo">148</span> XMLWriter.write( doc, writer );<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> catch ( XMLException e )<a name="line.150"></a>
<span class="sourceLineNo">151</span> {<a name="line.151"></a>
<span class="sourceLineNo">152</span> throw new RepositoryMetadataException( "Unable to write xml contents to writer: " + e.getMessage(), e );<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> private static void addOptionalElementText( Element elem, String elemName, String text )<a name="line.156"></a>
<span class="sourceLineNo">157</span> {<a name="line.157"></a>
<span class="sourceLineNo">158</span> if ( StringUtils.isBlank( text ) )<a name="line.158"></a>
<span class="sourceLineNo">159</span> {<a name="line.159"></a>
<span class="sourceLineNo">160</span> return;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> XmlUtil.addChild(elem, elemName ).setTextContent( text );<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> private static class PluginComparator<a name="line.166"></a>
<span class="sourceLineNo">167</span> implements Comparator&lt;Plugin&gt;<a name="line.167"></a>
<span class="sourceLineNo">168</span> {<a name="line.168"></a>
<span class="sourceLineNo">169</span> private static final PluginComparator INSTANCE = new PluginComparator();<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span> public int compare( Plugin plugin, Plugin plugin2 )<a name="line.172"></a>
<span class="sourceLineNo">173</span> {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if ( plugin.getPrefix() != null &amp;&amp; plugin2.getPrefix() != null )<a name="line.174"></a>
<span class="sourceLineNo">175</span> {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return plugin.getPrefix().compareTo( plugin2.getPrefix() );<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span> if ( plugin.getName() != null &amp;&amp; plugin2.getName() != null )<a name="line.178"></a>
<span class="sourceLineNo">179</span> {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return plugin.getName().compareTo( plugin2.getName() );<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> // we assume artifactId is not null which sounds good :-)<a name="line.182"></a>
<span class="sourceLineNo">183</span> return plugin.getArtifactId().compareTo( plugin2.getArtifactId() );<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span>}<a name="line.186"></a>
</pre>
</div>
</body>
</html>