Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.18 / testapidocs / src-html / org / apache / mina / filter / keepalive / KeepAliveFilterTest.html
blob: ef0fb2f4f8f1586731185388d4a0821efd1bf1fa [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.filter.keepalive;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.apache.mina.filter.keepalive.KeepAliveRequestTimeoutHandler.EXCEPTION;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.junit.Assert.assertFalse;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import static org.junit.Assert.assertNotNull;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.net.InetSocketAddress;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.atomic.AtomicBoolean;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.future.ConnectFuture;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.service.IoHandlerAdapter;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.core.session.IdleStatus;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.mina.core.session.IoSession;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.mina.transport.socket.nio.NioSocketAcceptor;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.mina.transport.socket.nio.NioSocketConnector;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.junit.After;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.junit.Before;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.junit.Test;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Tests {@link KeepAliveFilter} used by the connector with different<a name="line.41"></a>
<span class="sourceLineNo">042</span> * interested {@link IdleStatus}es.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class KeepAliveFilterTest {<a name="line.46"></a>
<span class="sourceLineNo">047</span> // Constants -----------------------------------------------------<a name="line.47"></a>
<span class="sourceLineNo">048</span> static final IoBuffer PING = IoBuffer.wrap(new byte[] { 1 });<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> static final IoBuffer PONG = IoBuffer.wrap(new byte[] { 2 });<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final int INTERVAL = 2;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private static final int TIMEOUT = 1;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private int port;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private NioSocketAcceptor acceptor;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> @Before<a name="line.60"></a>
<span class="sourceLineNo">061</span> public void setUp() throws Exception {<a name="line.61"></a>
<span class="sourceLineNo">062</span> acceptor = new NioSocketAcceptor();<a name="line.62"></a>
<span class="sourceLineNo">063</span> KeepAliveMessageFactory factory = new ServerFactory();<a name="line.63"></a>
<span class="sourceLineNo">064</span> KeepAliveFilter filter = new KeepAliveFilter(factory, IdleStatus.BOTH_IDLE);<a name="line.64"></a>
<span class="sourceLineNo">065</span> acceptor.getFilterChain().addLast("keep-alive", filter);<a name="line.65"></a>
<span class="sourceLineNo">066</span> acceptor.setHandler(new IoHandlerAdapter());<a name="line.66"></a>
<span class="sourceLineNo">067</span> acceptor.setDefaultLocalAddress(new InetSocketAddress(0));<a name="line.67"></a>
<span class="sourceLineNo">068</span> acceptor.bind();<a name="line.68"></a>
<span class="sourceLineNo">069</span> port = acceptor.getLocalAddress().getPort();<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> @After<a name="line.72"></a>
<span class="sourceLineNo">073</span> public void tearDown() throws Exception {<a name="line.73"></a>
<span class="sourceLineNo">074</span> acceptor.unbind();<a name="line.74"></a>
<span class="sourceLineNo">075</span> acceptor.dispose();<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> @Test<a name="line.78"></a>
<span class="sourceLineNo">079</span> public void testKeepAliveFilterForReaderIdle() throws Exception {<a name="line.79"></a>
<span class="sourceLineNo">080</span> keepAliveFilterForIdleStatus(IdleStatus.READER_IDLE);<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> @Test<a name="line.83"></a>
<span class="sourceLineNo">084</span> public void testKeepAliveFilterForBothIdle() throws Exception {<a name="line.84"></a>
<span class="sourceLineNo">085</span> keepAliveFilterForIdleStatus(IdleStatus.BOTH_IDLE);<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> @Test<a name="line.88"></a>
<span class="sourceLineNo">089</span> public void testKeepAliveFilterForWriterIdle() throws Exception {<a name="line.89"></a>
<span class="sourceLineNo">090</span> keepAliveFilterForIdleStatus(IdleStatus.WRITER_IDLE);<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> // Package protected ---------------------------------------------<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> // Protected -----------------------------------------------------<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> // Private -------------------------------------------------------<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> private void keepAliveFilterForIdleStatus(IdleStatus status) throws Exception {<a name="line.99"></a>
<span class="sourceLineNo">100</span> NioSocketConnector connector = new NioSocketConnector();<a name="line.100"></a>
<span class="sourceLineNo">101</span> KeepAliveFilter filter = new KeepAliveFilter(new ClientFactory(), status, EXCEPTION, INTERVAL, TIMEOUT);<a name="line.101"></a>
<span class="sourceLineNo">102</span> filter.setForwardEvent(true);<a name="line.102"></a>
<span class="sourceLineNo">103</span> connector.getFilterChain().addLast("keep-alive", filter);<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> final AtomicBoolean gotException = new AtomicBoolean(false);<a name="line.105"></a>
<span class="sourceLineNo">106</span> connector.setHandler(new IoHandlerAdapter() {<a name="line.106"></a>
<span class="sourceLineNo">107</span> @Override<a name="line.107"></a>
<span class="sourceLineNo">108</span> public void exceptionCaught(IoSession session, Throwable cause) throws Exception {<a name="line.108"></a>
<span class="sourceLineNo">109</span> //cause.printStackTrace();<a name="line.109"></a>
<span class="sourceLineNo">110</span> gotException.set(true);<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> @Override<a name="line.113"></a>
<span class="sourceLineNo">114</span> public void sessionIdle(IoSession session, IdleStatus status) throws Exception {<a name="line.114"></a>
<span class="sourceLineNo">115</span> // Do nothing<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><a name="line.118"></a>
<span class="sourceLineNo">119</span> ConnectFuture future = connector.connect(new InetSocketAddress("127.0.0.1", port)).awaitUninterruptibly();<a name="line.119"></a>
<span class="sourceLineNo">120</span> IoSession session = future.getSession();<a name="line.120"></a>
<span class="sourceLineNo">121</span> assertNotNull(session);<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> Thread.sleep((INTERVAL + TIMEOUT + 1) * 1000);<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> assertFalse("got an exception on the client", gotException.get());<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> session.closeNow();<a name="line.127"></a>
<span class="sourceLineNo">128</span> connector.dispose();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> static boolean checkRequest(IoBuffer message) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> IoBuffer buff = message;<a name="line.132"></a>
<span class="sourceLineNo">133</span> boolean check = buff.get() == 1;<a name="line.133"></a>
<span class="sourceLineNo">134</span> buff.rewind();<a name="line.134"></a>
<span class="sourceLineNo">135</span> return check;<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> static boolean checkResponse(IoBuffer message) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> IoBuffer buff = message;<a name="line.139"></a>
<span class="sourceLineNo">140</span> boolean check = buff.get() == 2;<a name="line.140"></a>
<span class="sourceLineNo">141</span> buff.rewind();<a name="line.141"></a>
<span class="sourceLineNo">142</span> return check;<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> // Inner classes -------------------------------------------------<a name="line.145"></a>
<span class="sourceLineNo">146</span> private final class ServerFactory implements KeepAliveMessageFactory {<a name="line.146"></a>
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
<span class="sourceLineNo">148</span> * Default constructor<a name="line.148"></a>
<span class="sourceLineNo">149</span> */<a name="line.149"></a>
<span class="sourceLineNo">150</span> public ServerFactory() {<a name="line.150"></a>
<span class="sourceLineNo">151</span> super();<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> public Object getRequest(IoSession session) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return null;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> public Object getResponse(IoSession session, Object request) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return PONG.duplicate();<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> public boolean isRequest(IoSession session, Object message) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> if (message instanceof IoBuffer) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> return checkRequest((IoBuffer) message);<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span> return false;<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> public boolean isResponse(IoSession session, Object message) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> if (message instanceof IoBuffer) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> return checkResponse((IoBuffer) message);<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span> return false;<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> private final class ClientFactory implements KeepAliveMessageFactory {<a name="line.177"></a>
<span class="sourceLineNo">178</span> /**<a name="line.178"></a>
<span class="sourceLineNo">179</span> * Default constructor<a name="line.179"></a>
<span class="sourceLineNo">180</span> */<a name="line.180"></a>
<span class="sourceLineNo">181</span> public ClientFactory() {<a name="line.181"></a>
<span class="sourceLineNo">182</span> super();<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> public Object getRequest(IoSession session) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return PING.duplicate();<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> public Object getResponse(IoSession session, Object request) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> return null;<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> public boolean isRequest(IoSession session, Object message) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (message instanceof IoBuffer) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return checkRequest((IoBuffer) message);<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span> return false;<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> public boolean isResponse(IoSession session, Object message) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> if (message instanceof IoBuffer) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> return checkResponse((IoBuffer) message);<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> return false;<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<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>
</pre>
</div>
</body>
</html>