blob: 54306a21a41b30f23f0382b1a5c1106d5040c6e4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<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>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.proxy;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetSocketAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.SocketAddress;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.Executor;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.mina.core.file.FileRegion;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.mina.core.filterchain.IoFilter;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.core.future.ConnectFuture;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.future.DefaultConnectFuture;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.service.AbstractIoConnector;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.core.service.DefaultTransportMetadata;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.mina.core.service.IoHandler;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.mina.core.service.TransportMetadata;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.mina.core.session.IoSession;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.mina.core.session.IoSessionConfig;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.mina.core.session.IoSessionInitializer;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.mina.proxy.filter.ProxyFilter;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.mina.proxy.handlers.socks.SocksProxyRequest;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.mina.proxy.session.ProxyIoSession;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.mina.proxy.session.ProxyIoSessionInitializer;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.mina.transport.socket.DefaultSocketSessionConfig;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.mina.transport.socket.SocketConnector;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.mina.transport.socket.SocketSessionConfig;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>/**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * ProxyConnector.java - Decorator for {@link SocketConnector} to provide proxy<a name="line.47"></a>
<span class="sourceLineNo">048</span> * support, as suggested by MINA list discussions.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * Operates by intercepting connect requests and replacing the endpoint address<a name="line.50"></a>
<span class="sourceLineNo">051</span> * with the proxy address, then adding a {@link ProxyFilter} as the first<a name="line.51"></a>
<span class="sourceLineNo">052</span> * {@link IoFilter} which performs any necessary handshaking with the proxy<a name="line.52"></a>
<span class="sourceLineNo">053</span> * before allowing data to flow normally. During the handshake, any outgoing<a name="line.53"></a>
<span class="sourceLineNo">054</span> * write requests are buffered.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * <a name="line.55"></a>
<span class="sourceLineNo">056</span> * @see &lt;a<a name="line.56"></a>
<span class="sourceLineNo">057</span> * href="http://www.nabble.com/Meta-Transport%3A-an-idea-on-implementing-reconnection-and-proxy-td12969001.html"&gt;Proxy<a name="line.57"></a>
<span class="sourceLineNo">058</span> * reconnection&lt;/a&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @see &lt;a href="http://issues.apache.org/jira/browse/DIRMINA-415"&gt;Proxy<a name="line.59"></a>
<span class="sourceLineNo">060</span> * support&lt;/a&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * <a name="line.61"></a>
<span class="sourceLineNo">062</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @since MINA 2.0.0-M3<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span>public class ProxyConnector extends AbstractIoConnector {<a name="line.65"></a>
<span class="sourceLineNo">066</span> private static final TransportMetadata METADATA = new DefaultTransportMetadata("proxy", "proxyconnector", false,<a name="line.66"></a>
<span class="sourceLineNo">067</span> true, InetSocketAddress.class, SocketSessionConfig.class, IoBuffer.class, FileRegion.class);<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> * Wrapped connector to use for outgoing TCP connections.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> private SocketConnector connector = null;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Proxy filter instance.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> private final ProxyFilter proxyFilter = new ProxyFilter();<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> * The {@link ProxyIoSession} in use.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> private ProxyIoSession proxyIoSession;<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * This future will notify it's listeners when really connected to the target<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> private DefaultConnectFuture future;<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> * Creates a new proxy connector.<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> public ProxyConnector() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> super(new DefaultSocketSessionConfig(), null);<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> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Creates a new proxy connector.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * <a name="line.98"></a>
<span class="sourceLineNo">099</span> * @param connector Connector used to establish proxy connections.<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> public ProxyConnector(final SocketConnector connector) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> this(connector, new DefaultSocketSessionConfig(), null);<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> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Creates a new proxy connector.<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @see AbstractIoConnector#AbstractIoConnector(IoSessionConfig, Executor).<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public ProxyConnector(final SocketConnector connector, IoSessionConfig config, Executor executor) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> super(config, executor);<a name="line.110"></a>
<span class="sourceLineNo">111</span> setConnector(connector);<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> /**<a name="line.114"></a>
<span class="sourceLineNo">115</span> * {@inheritDoc}<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> public IoSessionConfig getSessionConfig() {<a name="line.117"></a>
<span class="sourceLineNo">118</span> return connector.getSessionConfig();<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> * Returns the {@link ProxyIoSession} linked with this connector.<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public ProxyIoSession getProxyIoSession() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> return proxyIoSession;<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<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> * Sets the proxy session object of this connector.<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @param proxyIoSession the configuration of this connector.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> public void setProxyIoSession(ProxyIoSession proxyIoSession) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> if (proxyIoSession == null) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> throw new IllegalArgumentException("proxySession object cannot be null");<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> if (proxyIoSession.getProxyAddress() == null) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> throw new IllegalArgumentException("proxySession.proxyAddress cannot be null");<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> proxyIoSession.setConnector(this);<a name="line.141"></a>
<span class="sourceLineNo">142</span> setDefaultRemoteAddress(proxyIoSession.getProxyAddress());<a name="line.142"></a>
<span class="sourceLineNo">143</span> this.proxyIoSession = proxyIoSession;<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> * Connects to the specified &lt;code&gt;address&lt;/code&gt;. If communication starts<a name="line.147"></a>
<span class="sourceLineNo">148</span> * successfully, events are fired to the connector's &lt;code&gt;handler&lt;/code&gt;.<a name="line.148"></a>
<span class="sourceLineNo">149</span> * <a name="line.149"></a>
<span class="sourceLineNo">150</span> * @param remoteAddress the remote address to connect to<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @param localAddress the local address<a name="line.151"></a>
<span class="sourceLineNo">152</span> * @param sessionInitializer the session initializer<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @return {@link ConnectFuture} that will tell the result of the connection attempt<a name="line.153"></a>
<span class="sourceLineNo">154</span> */<a name="line.154"></a>
<span class="sourceLineNo">155</span> @SuppressWarnings("unchecked")<a name="line.155"></a>
<span class="sourceLineNo">156</span> @Override<a name="line.156"></a>
<span class="sourceLineNo">157</span> protected ConnectFuture connect0(final SocketAddress remoteAddress, final SocketAddress localAddress,<a name="line.157"></a>
<span class="sourceLineNo">158</span> final IoSessionInitializer&lt;? extends ConnectFuture&gt; sessionInitializer) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (!proxyIoSession.isReconnectionNeeded()) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> // First connection<a name="line.160"></a>
<span class="sourceLineNo">161</span> IoHandler handler = getHandler();<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (!(handler instanceof AbstractProxyIoHandler)) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> throw new IllegalArgumentException("IoHandler must be an instance of AbstractProxyIoHandler");<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> connector.setHandler(handler);<a name="line.166"></a>
<span class="sourceLineNo">167</span> future = new DefaultConnectFuture();<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> ConnectFuture conFuture = connector.connect(proxyIoSession.getProxyAddress(), new ProxyIoSessionInitializer(<a name="line.170"></a>
<span class="sourceLineNo">171</span> sessionInitializer, proxyIoSession));<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> // If proxy does not use reconnection like socks the connector's<a name="line.173"></a>
<span class="sourceLineNo">174</span> // future is returned. If we're in the middle of a reconnection<a name="line.174"></a>
<span class="sourceLineNo">175</span> // then we send back the connector's future which is only used<a name="line.175"></a>
<span class="sourceLineNo">176</span> // internally while &lt;code&gt;future&lt;/code&gt; will be used to notify<a name="line.176"></a>
<span class="sourceLineNo">177</span> // the user of the connection state.<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (proxyIoSession.getRequest() instanceof SocksProxyRequest || proxyIoSession.isReconnectionNeeded()) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> return conFuture;<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> return future;<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<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> * Cancels the real connection when reconnection is in use.<a name="line.186"></a>
<span class="sourceLineNo">187</span> */<a name="line.187"></a>
<span class="sourceLineNo">188</span> public void cancelConnectFuture() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> future.cancel();<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Fires the connection event on the real future to notify the client.<a name="line.193"></a>
<span class="sourceLineNo">194</span> * <a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param session the current session<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @return the future holding the connected session<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> protected ConnectFuture fireConnected(final IoSession session) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> future.setSession(session);<a name="line.199"></a>
<span class="sourceLineNo">200</span> return future;<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<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> * Get the {@link SocketConnector} to be used for connections<a name="line.204"></a>
<span class="sourceLineNo">205</span> * to the proxy server.<a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> public final SocketConnector getConnector() {<a name="line.207"></a>
<span class="sourceLineNo">208</span> return connector;<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<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>
<span class="sourceLineNo">212</span> * Sets the {@link SocketConnector} to be used for connections<a name="line.212"></a>
<span class="sourceLineNo">213</span> * to the proxy server.<a name="line.213"></a>
<span class="sourceLineNo">214</span> * <a name="line.214"></a>
<span class="sourceLineNo">215</span> * @param connector the connector to use<a name="line.215"></a>
<span class="sourceLineNo">216</span> */<a name="line.216"></a>
<span class="sourceLineNo">217</span> private final void setConnector(final SocketConnector connector) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> if (connector == null) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> throw new IllegalArgumentException("connector cannot be null");<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span><a name="line.221"></a>
<span class="sourceLineNo">222</span> this.connector = connector;<a name="line.222"></a>
<span class="sourceLineNo">223</span> String className = ProxyFilter.class.getName();<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> // Removes an old ProxyFilter instance from the chain<a name="line.225"></a>
<span class="sourceLineNo">226</span> if (connector.getFilterChain().contains(className)) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> connector.getFilterChain().remove(className);<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span> // Insert the ProxyFilter as the first filter in the filter chain builder<a name="line.230"></a>
<span class="sourceLineNo">231</span> connector.getFilterChain().addFirst(className, proxyFilter);<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span><a name="line.233"></a>
<span class="sourceLineNo">234</span> /**<a name="line.234"></a>
<span class="sourceLineNo">235</span> * {@inheritDoc}<a name="line.235"></a>
<span class="sourceLineNo">236</span> */<a name="line.236"></a>
<span class="sourceLineNo">237</span> @Override<a name="line.237"></a>
<span class="sourceLineNo">238</span> protected void dispose0() throws Exception {<a name="line.238"></a>
<span class="sourceLineNo">239</span> if (connector != null) {<a name="line.239"></a>
<span class="sourceLineNo">240</span> connector.dispose();<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span> }<a name="line.242"></a>
<span class="sourceLineNo">243</span><a name="line.243"></a>
<span class="sourceLineNo">244</span> /**<a name="line.244"></a>
<span class="sourceLineNo">245</span> * {@inheritDoc}<a name="line.245"></a>
<span class="sourceLineNo">246</span> */<a name="line.246"></a>
<span class="sourceLineNo">247</span> public TransportMetadata getTransportMetadata() {<a name="line.247"></a>
<span class="sourceLineNo">248</span> return METADATA;<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>
</pre>
</div>
</body>
</html>