| <!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.util.LinkedList;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Queue;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.mina.core.filterchain.IoFilter.NextFilter;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.core.future.DefaultWriteFuture;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.mina.core.future.WriteFuture;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.mina.core.session.IoSession;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.mina.core.write.DefaultWriteRequest;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.mina.core.write.WriteRequest;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.mina.proxy.filter.ProxyFilter;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.mina.proxy.filter.ProxyHandshakeIoBuffer;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.mina.proxy.session.ProxyIoSession;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.slf4j.Logger;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.slf4j.LoggerFactory;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span>/**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * AbstractProxyLogicHandler.java - Helper class to handle proxy handshaking logic. Derived classes <a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * implement proxy type specific logic.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Based upon SSLHandler from mina-filter-ssl.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @since MINA 2.0.0-M3<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public abstract class AbstractProxyLogicHandler implements ProxyLogicHandler {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private final static Logger LOGGER = LoggerFactory.getLogger(AbstractProxyLogicHandler.class);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Object that contains all the proxy authentication session informations.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> private ProxyIoSession proxyIoSession;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Queue of write events which occurred before the proxy handshake had completed.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private Queue<Event> writeRequestQueue = null;<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> * Has the handshake been completed.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private boolean handshakeComplete = false;<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> * Creates a new {@link AbstractProxyLogicHandler}.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param proxyIoSession {@link ProxyIoSession} in use.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public AbstractProxyLogicHandler(ProxyIoSession proxyIoSession) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> this.proxyIoSession = proxyIoSession;<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> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Returns the proxy filter {@link ProxyFilter}.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> protected ProxyFilter getProxyFilter() {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return proxyIoSession.getProxyFilter();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Returns the session.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> protected IoSession getSession() {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> return proxyIoSession.getSession();<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> * Returns the {@link ProxyIoSession} object.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> public ProxyIoSession getProxyIoSession() {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return proxyIoSession;<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> * Writes data to the proxy server.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * <a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param nextFilter the next filter<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param data Data buffer to be written.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> protected WriteFuture writeData(final NextFilter nextFilter, final IoBuffer data) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> // write net data<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> ProxyHandshakeIoBuffer writeBuffer = new ProxyHandshakeIoBuffer(data);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> LOGGER.debug(" session write: {}", writeBuffer);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> WriteFuture writeFuture = new DefaultWriteFuture(getSession());<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> getProxyFilter().writeData(nextFilter, getSession(), new DefaultWriteRequest(writeBuffer, writeFuture), true);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return writeFuture;<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> * Returns <code>true</code> if handshaking is complete and<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * data can be sent through the proxy.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public boolean isHandshakeComplete() {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> synchronized (this) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return handshakeComplete;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> /**<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * Signals that the handshake has finished.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> protected final void setHandshakeComplete() {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> synchronized (this) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> handshakeComplete = true;<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> ProxyIoSession proxyIoSession = getProxyIoSession();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> proxyIoSession.getConnector().fireConnected(proxyIoSession.getSession()).awaitUninterruptibly();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> LOGGER.debug(" handshake completed");<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> // Connected OK<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> try {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> proxyIoSession.getEventQueue().flushPendingSessionEvents();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> flushPendingWriteRequests();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> } catch (Exception ex) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> LOGGER.error("Unable to flush pending write requests", ex);<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><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Send any write requests which were queued whilst waiting for handshaking to complete.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> */<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> protected synchronized void flushPendingWriteRequests() throws Exception {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> LOGGER.debug(" flushPendingWriteRequests()");<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> if (writeRequestQueue == null) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return;<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> Event scheduledWrite;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> while ((scheduledWrite = writeRequestQueue.poll()) != null) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> LOGGER.debug(" Flushing buffered write request: {}", scheduledWrite.data);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> getProxyFilter().filterWrite(scheduledWrite.nextFilter, getSession(), (WriteRequest) scheduledWrite.data);<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> // Free queue<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> writeRequestQueue = null;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * Enqueue a message to be written once handshaking is complete.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> public synchronized void enqueueWriteRequest(final NextFilter nextFilter, final WriteRequest writeRequest) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> if (writeRequestQueue == null) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> writeRequestQueue = new LinkedList<Event>();<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> writeRequestQueue.offer(new Event(nextFilter, writeRequest));<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> /**<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * Closes the session.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * <a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param message the error message<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param t the exception which caused the session closing<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> protected void closeSession(final String message, final Throwable t) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> if (t != null) {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> LOGGER.error(message, t);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> proxyIoSession.setAuthenticationFailed(true);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> } else {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> LOGGER.error(message);<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> getSession().close(true);<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> /**<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * Closes the session.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * <a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * @param message the error message<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> */<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> protected void closeSession(final String message) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> closeSession(message, null);<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> /**<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * Event wrapper class for enqueued events.<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> */<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> private final static class Event {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> private final NextFilter nextFilter;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> private final Object data;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> Event(final NextFilter nextFilter, final Object data) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> this.nextFilter = nextFilter;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> this.data = data;<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public Object getData() {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return data;<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> public NextFilter getNextFilter() {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> return nextFilter;<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
