| <!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.features;<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><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.archiva.repository.Repository;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.archiva.repository.event.RepositoryIndexEvent;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.archiva.event.EventHandler;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.archiva.repository.storage.StorageAsset;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.commons.lang3.StringUtils;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.net.URI;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.net.URISyntaxException;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import static org.apache.archiva.indexer.ArchivaIndexManager.DEFAULT_INDEX_PATH;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import static org.apache.archiva.indexer.ArchivaIndexManager.DEFAULT_PACKED_INDEX_PATH;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * This feature provides information about index creation.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Repositories that support this feature are able to create indexes and download them from remote repositories.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Repositories may have a normal and packed index. A normal index is used by repository search utilities, the packed<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * index is for downloading purpose.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * A index may have a remote and a local representation. The remote representation is used for downloading and<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * updating the local representation.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> *<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * The feature is throwing a {@link RepositoryIndexEvent}, if the URI of the index has been changed.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>public class IndexCreationFeature extends AbstractFeature implements RepositoryFeature<IndexCreationFeature>{<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private boolean skipPackedIndexCreation = false;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private URI indexPath;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private URI packedIndexPath;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private StorageAsset localIndexPath;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private StorageAsset localPackedIndexPath;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private Repository repo;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public IndexCreationFeature(Repository repository, EventHandler listener) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> super(listener);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> this.repo = repository;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> try {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> this.indexPath = new URI(DEFAULT_INDEX_PATH);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> this.packedIndexPath = new URI(DEFAULT_PACKED_INDEX_PATH);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> } catch (URISyntaxException e) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> // Does not happen<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> e.printStackTrace();<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<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> public IndexCreationFeature(boolean skipPackedIndexCreation) {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> this.skipPackedIndexCreation = skipPackedIndexCreation;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> try {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> this.indexPath = new URI(DEFAULT_INDEX_PATH);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this.packedIndexPath = new URI(DEFAULT_PACKED_INDEX_PATH);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> } catch (URISyntaxException e) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> // Does not happen<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> e.printStackTrace();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> @Override<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public IndexCreationFeature get() {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return this;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Returns true, if no packed index files should be created.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return True, if no packed index files are created, otherwise false.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public boolean isSkipPackedIndexCreation() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return skipPackedIndexCreation;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Sets the flag for packed index creation.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> *<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param skipPackedIndexCreation<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public void setSkipPackedIndexCreation(boolean skipPackedIndexCreation) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> this.skipPackedIndexCreation = skipPackedIndexCreation;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Returns the path that is used to store the index. The path may be a absolute URI or relative to the<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * base URI of the repository.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @return the uri (may be relative or absolute)<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> public URI getIndexPath( )<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> return indexPath;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> /**<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Sets the path that is used to store the index. The path may be either absolute or a<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * path that is relative to the repository storage path (either a local or remote path).<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> *<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @param indexPath the uri to the index path (may be relative)<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> public void setIndexPath( URI indexPath )<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> if ((this.indexPath==null && indexPath!=null) || !this.indexPath.equals(indexPath)) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> URI oldVal = this.indexPath;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> this.indexPath = indexPath;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> pushEvent(RepositoryIndexEvent.indexUriChange(this, repo, oldVal, this.indexPath));<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * Returns true, if this repository has a index defined.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> *<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @return <code>true</code>, if a index path is set, otherwise <code>false</code><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> public boolean hasIndex() {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> return this.indexPath!=null && !StringUtils.isEmpty( this.indexPath.getPath() );<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> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Returns the path where the index is stored physically.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> *<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @return<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> */<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> public StorageAsset getLocalIndexPath() {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> return localIndexPath;<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> * Sets the path where the index is stored locally.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> *<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param localIndexPath<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public void setLocalIndexPath(StorageAsset localIndexPath) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> this.localIndexPath = localIndexPath;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><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> * Returns the path of the packed index.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @return<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> */<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> public URI getPackedIndexPath() {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> return packedIndexPath;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /**<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * Sets the path (relative or absolute) of the packed index.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> *<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * Throws a {@link RepositoryIndexEvent.Index#PACKED_INDEX_URI_CHANGE}, if the value changes.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> *<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @param packedIndexPath the new path uri for the packed index<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public void setPackedIndexPath(URI packedIndexPath) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> URI oldVal = this.packedIndexPath;<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> this.packedIndexPath = packedIndexPath;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> pushEvent(RepositoryIndexEvent.packedIndexUriChange(this, repo, oldVal, this.packedIndexPath));<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> |
| <span class="sourceLineNo">187</span> * Returns the directory where the packed index is stored.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> */<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> public StorageAsset getLocalPackedIndexPath() {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> return localPackedIndexPath;<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> /**<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * Sets the path where the packed index is stored physically. This method should only be used by the<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * MavenIndexProvider implementations.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> *<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * @param localPackedIndexPath<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> */<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> public void setLocalPackedIndexPath(StorageAsset localPackedIndexPath) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> this.localPackedIndexPath = localPackedIndexPath;<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> @Override<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> public String toString() {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> StringBuilder sb = new StringBuilder();<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> sb.append("IndexCreationFeature:{").append("skipPackedIndexCreation=").append(skipPackedIndexCreation)<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> .append(",indexPath=").append(indexPath).append(",packedIndexPath=").append(packedIndexPath).append("}");<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> return sb.toString();<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span>}<a name="line.211"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
