blob: 63dac5203ac0d7e59b57f3c6b97b83e805b1b4c4 [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.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.commons.lang3.StringUtils;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.URI;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.net.URISyntaxException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.time.Duration;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Feature for remote index download.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>public class RemoteIndexFeature implements RepositoryFeature&lt;RemoteIndexFeature&gt; {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> private boolean downloadRemoteIndex = false;<a name="line.34"></a>
<span class="sourceLineNo">035</span> private URI indexUri;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> {<a name="line.37"></a>
<span class="sourceLineNo">038</span> try {<a name="line.38"></a>
<span class="sourceLineNo">039</span> indexUri = new URI(".index");<a name="line.39"></a>
<span class="sourceLineNo">040</span> } catch (URISyntaxException e) {<a name="line.40"></a>
<span class="sourceLineNo">041</span> // Ignore<a name="line.41"></a>
<span class="sourceLineNo">042</span> }<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> private boolean downloadRemoteIndexOnStartup = false;<a name="line.45"></a>
<span class="sourceLineNo">046</span> private Duration downloadTimeout = Duration.ofSeconds( 600 );<a name="line.46"></a>
<span class="sourceLineNo">047</span> private String proxyId = "";<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> @Override<a name="line.50"></a>
<span class="sourceLineNo">051</span> public RemoteIndexFeature get() {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return this;<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * True, if the remote index should be downloaded.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @return True if download, otherwise false.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> public boolean isDownloadRemoteIndex() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> return downloadRemoteIndex;<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> public void setDownloadRemoteIndex(boolean downloadRemoteIndex) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> this.downloadRemoteIndex = downloadRemoteIndex;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * The URI to access the remote index. May be a relative URI that is relative to the<a name="line.68"></a>
<span class="sourceLineNo">069</span> * repository URI.<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @return<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> public URI getIndexUri() {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return indexUri;<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> * Sets the URI to access the remote index. May be a relative URI that is relative to the<a name="line.78"></a>
<span class="sourceLineNo">079</span> * repository URI. The allowed URI schemes are dependent on the repository type.<a name="line.79"></a>
<span class="sourceLineNo">080</span> *<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @param indexUri The URI of the index<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> public void setIndexUri(URI indexUri) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> this.indexUri = indexUri;<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> * Returns true, if the remote index should be downloaded on startup of the repository.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @return true, if the index should be downloaded during startup, otherwise false.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> public boolean isDownloadRemoteIndexOnStartup() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return downloadRemoteIndexOnStartup;<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Sets the flag for download of the remote repository index.<a name="line.96"></a>
<span class="sourceLineNo">097</span> *<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param downloadRemoteIndexOnStartup<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> public void setDownloadRemoteIndexOnStartup(boolean downloadRemoteIndexOnStartup) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> this.downloadRemoteIndexOnStartup = downloadRemoteIndexOnStartup;<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> /**<a name="line.104"></a>
<span class="sourceLineNo">105</span> * Returns the timeout after that the remote index download is aborted.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @return the time duration after that, the download is aborted.<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span> public Duration getDownloadTimeout() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> return this.downloadTimeout;<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> * Sets the timeout after that a remote index download will be aborted.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @param timeout The duration<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public void setDownloadTimeout(Duration timeout) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> this.downloadTimeout = timeout;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<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> * Returns the id of the proxy, that should be used to download the remote index.<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @return The proxy id<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public String getProxyId( )<a name="line.124"></a>
<span class="sourceLineNo">125</span> {<a name="line.125"></a>
<span class="sourceLineNo">126</span> return proxyId;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Sets the id of the proxy that should be used to download the remote index.<a name="line.130"></a>
<span class="sourceLineNo">131</span> * @param proxyId<a name="line.131"></a>
<span class="sourceLineNo">132</span> */<a name="line.132"></a>
<span class="sourceLineNo">133</span> public void setProxyId( String proxyId )<a name="line.133"></a>
<span class="sourceLineNo">134</span> {<a name="line.134"></a>
<span class="sourceLineNo">135</span> this.proxyId = proxyId;<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> /**<a name="line.138"></a>
<span class="sourceLineNo">139</span> * Returns true, if there is a index available.<a name="line.139"></a>
<span class="sourceLineNo">140</span> *<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @return<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> public boolean hasIndex() {<a name="line.143"></a>
<span class="sourceLineNo">144</span> return this.indexUri!=null &amp;&amp; !StringUtils.isEmpty( this.indexUri.getPath() );<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> @Override<a name="line.147"></a>
<span class="sourceLineNo">148</span> public String toString() {<a name="line.148"></a>
<span class="sourceLineNo">149</span> StringBuilder str = new StringBuilder();<a name="line.149"></a>
<span class="sourceLineNo">150</span> return str.append("RemoteIndexFeature:{downloadRemoteIndex=").append(downloadRemoteIndex)<a name="line.150"></a>
<span class="sourceLineNo">151</span> .append(",indexURI=").append(indexUri)<a name="line.151"></a>
<span class="sourceLineNo">152</span> .append(",downloadOnStartup=").append(downloadRemoteIndexOnStartup)<a name="line.152"></a>
<span class="sourceLineNo">153</span> .append(",timeout=").append(downloadTimeout).append("}").toString();<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>
</pre>
</div>
</body>
</html>