Google Git
Sign in
apache / archiva-web-content / 2fbf6a601fc3e048834e995bd5571cdb6e452fbd / . / ref / 3.0.0-SNAPSHOT / apidocs / src-html / org / apache / archiva / proxy / model / ProxyConnector.html
blob: d7f2a82bb60dd30fc40d0d6705efc20feaf33427 [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.proxy.model;<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.policies.Policy;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.archiva.policies.PolicyOption;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.archiva.repository.ManagedRepository;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.archiva.repository.RemoteRepository;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.archiva.repository.connector.RepositoryConnector;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Iterator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Map;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * This represents a connector for a repository to a remote repository that is proxied.<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class ProxyConnector<a name="line.35"></a>
<span class="sourceLineNo">036</span> implements RepositoryConnector<a name="line.36"></a>
<span class="sourceLineNo">037</span>{<a name="line.37"></a>
<span class="sourceLineNo">038</span> private ManagedRepository sourceRepository;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> private RemoteRepository targetRepository;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private List&lt;String&gt; blacklist;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private List&lt;String&gt; whitelist;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private String proxyId;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> private int order;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private Map&lt;Policy, PolicyOption&gt; policies;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private boolean enabled;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private Map&lt;String, String&gt; properties;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> public ProxyConnector()<a name="line.56"></a>
<span class="sourceLineNo">057</span> {<a name="line.57"></a>
<span class="sourceLineNo">058</span> // no op<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @see RepositoryConnector#isEnabled()<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> @Override<a name="line.64"></a>
<span class="sourceLineNo">065</span> public boolean isEnabled()<a name="line.65"></a>
<span class="sourceLineNo">066</span> {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return enabled;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @see RepositoryConnector#enable()<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> @Override<a name="line.74"></a>
<span class="sourceLineNo">075</span> public void enable()<a name="line.75"></a>
<span class="sourceLineNo">076</span> {<a name="line.76"></a>
<span class="sourceLineNo">077</span> this.enabled = true;<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> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @see RepositoryConnector#disable()<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> @Override<a name="line.83"></a>
<span class="sourceLineNo">084</span> public void disable( )<a name="line.84"></a>
<span class="sourceLineNo">085</span> {<a name="line.85"></a>
<span class="sourceLineNo">086</span> this.enabled = false;<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<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> * @see RepositoryConnector#getBlacklist()<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> @Override<a name="line.92"></a>
<span class="sourceLineNo">093</span> public List&lt;String&gt; getBlacklist()<a name="line.93"></a>
<span class="sourceLineNo">094</span> {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return blacklist;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Sets the blacklist. The list is a string of paths.<a name="line.99"></a>
<span class="sourceLineNo">100</span> *<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @param blacklist List of paths.<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> public void setBlacklist( List&lt;String&gt; blacklist )<a name="line.103"></a>
<span class="sourceLineNo">104</span> {<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.blacklist = blacklist;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @see RepositoryConnector#getSourceRepository()<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public ManagedRepository getSourceRepository()<a name="line.112"></a>
<span class="sourceLineNo">113</span> {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return sourceRepository;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> /**<a name="line.117"></a>
<span class="sourceLineNo">118</span> * Sets the source repository.<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @param sourceRepository The managed repository which is the local representation of the proxy.<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> public void setSourceRepository( ManagedRepository sourceRepository )<a name="line.121"></a>
<span class="sourceLineNo">122</span> {<a name="line.122"></a>
<span class="sourceLineNo">123</span> this.sourceRepository = sourceRepository;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @see ProxyConnector#getTargetRepository()<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span> public RemoteRepository getTargetRepository()<a name="line.130"></a>
<span class="sourceLineNo">131</span> {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return targetRepository;<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> * Sets the target repository.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @param targetRepository The remote repository, where the artifacts are downloaded from.<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public void setTargetRepository( RemoteRepository targetRepository )<a name="line.139"></a>
<span class="sourceLineNo">140</span> {<a name="line.140"></a>
<span class="sourceLineNo">141</span> this.targetRepository = targetRepository;<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @see ProxyConnector#getWhitelist()<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 List&lt;String&gt; getWhitelist()<a name="line.148"></a>
<span class="sourceLineNo">149</span> {<a name="line.149"></a>
<span class="sourceLineNo">150</span> return whitelist;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> /**<a name="line.153"></a>
<span class="sourceLineNo">154</span> * Sets the list of paths that are proxied.<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @param whitelist List of paths.<a name="line.155"></a>
<span class="sourceLineNo">156</span> */<a name="line.156"></a>
<span class="sourceLineNo">157</span> public void setWhitelist( List&lt;String&gt; whitelist )<a name="line.157"></a>
<span class="sourceLineNo">158</span> {<a name="line.158"></a>
<span class="sourceLineNo">159</span> this.whitelist = whitelist;<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<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> * Returns the policies that are defined<a name="line.163"></a>
<span class="sourceLineNo">164</span> * @return<a name="line.164"></a>
<span class="sourceLineNo">165</span> */<a name="line.165"></a>
<span class="sourceLineNo">166</span> public Map&lt;Policy, PolicyOption&gt; getPolicies()<a name="line.166"></a>
<span class="sourceLineNo">167</span> {<a name="line.167"></a>
<span class="sourceLineNo">168</span> return policies;<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> /**<a name="line.171"></a>
<span class="sourceLineNo">172</span> * Sets policies that set the behaviour of this proxy connector.<a name="line.172"></a>
<span class="sourceLineNo">173</span> * @param policies A map of policies with each option.<a name="line.173"></a>
<span class="sourceLineNo">174</span> */<a name="line.174"></a>
<span class="sourceLineNo">175</span> public void setPolicies( Map&lt;Policy, PolicyOption&gt; policies )<a name="line.175"></a>
<span class="sourceLineNo">176</span> {<a name="line.176"></a>
<span class="sourceLineNo">177</span> this.policies = policies;<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
<span class="sourceLineNo">181</span> * Adds a new policy.<a name="line.181"></a>
<span class="sourceLineNo">182</span> * @param policy The policy to add.<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @param option The option for the policy.<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> public void addPolicy( Policy policy, PolicyOption option )<a name="line.185"></a>
<span class="sourceLineNo">186</span> {<a name="line.186"></a>
<span class="sourceLineNo">187</span> this.policies.put( policy, option );<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Returns the id of this proxy connector.<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @return The id string.<a name="line.192"></a>
<span class="sourceLineNo">193</span> */<a name="line.193"></a>
<span class="sourceLineNo">194</span> public String getProxyId()<a name="line.194"></a>
<span class="sourceLineNo">195</span> {<a name="line.195"></a>
<span class="sourceLineNo">196</span> return proxyId;<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> /**<a name="line.199"></a>
<span class="sourceLineNo">200</span> * Sets the id of this proxy connector.<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @param proxyId A id string.<a name="line.201"></a>
<span class="sourceLineNo">202</span> */<a name="line.202"></a>
<span class="sourceLineNo">203</span> public void setProxyId( String proxyId )<a name="line.203"></a>
<span class="sourceLineNo">204</span> {<a name="line.204"></a>
<span class="sourceLineNo">205</span> this.proxyId = proxyId;<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span><a name="line.207"></a>
<span class="sourceLineNo">208</span> @Override<a name="line.208"></a>
<span class="sourceLineNo">209</span> public String toString()<a name="line.209"></a>
<span class="sourceLineNo">210</span> {<a name="line.210"></a>
<span class="sourceLineNo">211</span> StringBuilder sb = new StringBuilder();<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> sb.append( "ProxyConnector[\n" );<a name="line.213"></a>
<span class="sourceLineNo">214</span> sb.append( " source: [managed] " ).append( this.sourceRepository.getId() ).append( "\n" );<a name="line.214"></a>
<span class="sourceLineNo">215</span> sb.append( " target: [remote] " ).append( this.targetRepository.getId() ).append( "\n" );<a name="line.215"></a>
<span class="sourceLineNo">216</span> sb.append( " proxyId:" ).append( this.proxyId ).append( "\n" );<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> Iterator&lt;Policy&gt; keys = this.policies.keySet().iterator();<a name="line.218"></a>
<span class="sourceLineNo">219</span> while ( keys.hasNext() )<a name="line.219"></a>
<span class="sourceLineNo">220</span> {<a name="line.220"></a>
<span class="sourceLineNo">221</span> String name = keys.next().getId();<a name="line.221"></a>
<span class="sourceLineNo">222</span> sb.append( " policy[" ).append( name ).append( "]:" );<a name="line.222"></a>
<span class="sourceLineNo">223</span> sb.append( this.policies.get( name ) ).append( "\n" );<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> sb.append( "]" );<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span> return sb.toString();<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
<span class="sourceLineNo">232</span> * Returns a number that orders the proxy connectors numerically.<a name="line.232"></a>
<span class="sourceLineNo">233</span> * @return The order number of this connector.<a name="line.233"></a>
<span class="sourceLineNo">234</span> */<a name="line.234"></a>
<span class="sourceLineNo">235</span> public int getOrder()<a name="line.235"></a>
<span class="sourceLineNo">236</span> {<a name="line.236"></a>
<span class="sourceLineNo">237</span> return order;<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> /**<a name="line.240"></a>
<span class="sourceLineNo">241</span> * Set the order number of this proxy connector.<a name="line.241"></a>
<span class="sourceLineNo">242</span> *<a name="line.242"></a>
<span class="sourceLineNo">243</span> * @param order The order number.<a name="line.243"></a>
<span class="sourceLineNo">244</span> */<a name="line.244"></a>
<span class="sourceLineNo">245</span> public void setOrder( int order )<a name="line.245"></a>
<span class="sourceLineNo">246</span> {<a name="line.246"></a>
<span class="sourceLineNo">247</span> this.order = order;<a name="line.247"></a>
<span class="sourceLineNo">248</span> }<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span> /**<a name="line.250"></a>
<span class="sourceLineNo">251</span> * Returns additional properties defined for this connector.<a name="line.251"></a>
<span class="sourceLineNo">252</span> * @return Map of key, value pairs.<a name="line.252"></a>
<span class="sourceLineNo">253</span> */<a name="line.253"></a>
<span class="sourceLineNo">254</span> public Map&lt;String, String&gt; getProperties() {<a name="line.254"></a>
<span class="sourceLineNo">255</span> return properties;<a name="line.255"></a>
<span class="sourceLineNo">256</span> }<a name="line.256"></a>
<span class="sourceLineNo">257</span><a name="line.257"></a>
<span class="sourceLineNo">258</span> /**<a name="line.258"></a>
<span class="sourceLineNo">259</span> * Sets additional properties for this connector.<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @param properties Map of key, value pairs.<a name="line.260"></a>
<span class="sourceLineNo">261</span> */<a name="line.261"></a>
<span class="sourceLineNo">262</span> public void setProperties(Map&lt;String, String&gt; properties) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> this.properties = properties;<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span>}<a name="line.265"></a>
</pre>
</div>
</body>
</html>