blob: 52a55f83cb5b0f0be73a28f15f790891686f58e8 [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.executor;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.EnumSet;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.Executor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.ExecutorService;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.Executors;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.ThreadFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.TimeUnit;<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.filterchain.IoFilterAdapter;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.filterchain.IoFilterChain;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.filterchain.IoFilterEvent;<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.IoEventType;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.mina.core.session.IoSession;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.mina.core.write.WriteRequest;<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> * A filter that forwards I/O events to {@link Executor} to enforce a certain<a name="line.38"></a>
<span class="sourceLineNo">039</span> * thread model while allowing the events per session to be processed<a name="line.39"></a>
<span class="sourceLineNo">040</span> * simultaneously. You can apply various thread model by inserting this filter<a name="line.40"></a>
<span class="sourceLineNo">041</span> * to a {@link IoFilterChain}.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * <a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;h2&gt;Life Cycle Management&lt;/h2&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * <a name="line.44"></a>
<span class="sourceLineNo">045</span> * Please note that this filter doesn't manage the life cycle of the {@link Executor}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * If you created this filter using {@link #ExecutorFilter(Executor)} or similar<a name="line.46"></a>
<span class="sourceLineNo">047</span> * constructor that accepts an {@link Executor} that you've instantiated, you have<a name="line.47"></a>
<span class="sourceLineNo">048</span> * full control and responsibility of managing its life cycle (e.g. calling<a name="line.48"></a>
<span class="sourceLineNo">049</span> * {@link ExecutorService#shutdown()}.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;p&gt; <a name="line.50"></a>
<span class="sourceLineNo">051</span> * If you created this filter using convenience constructors like<a name="line.51"></a>
<span class="sourceLineNo">052</span> * {@link #ExecutorFilter(int)}, then you can shut down the executor by calling<a name="line.52"></a>
<span class="sourceLineNo">053</span> * {@link #destroy()} explicitly.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * <a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;h2&gt;Event Ordering&lt;/h2&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * <a name="line.56"></a>
<span class="sourceLineNo">057</span> * All convenience constructors of this filter creates a new<a name="line.57"></a>
<span class="sourceLineNo">058</span> * {@link OrderedThreadPoolExecutor} instance. Therefore, the order of event is<a name="line.58"></a>
<span class="sourceLineNo">059</span> * maintained like the following:<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;ul&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;li&gt;All event handler methods are called exclusively.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * (e.g. messageReceived and messageSent can't be invoked at the same time.)&lt;/li&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;li&gt;The event order is never mixed up.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * (e.g. messageReceived is always invoked before sessionClosed or messageSent.)&lt;/li&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;/ul&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * However, if you specified other {@link Executor} instance in the constructor,<a name="line.66"></a>
<span class="sourceLineNo">067</span> * the order of events are not maintained at all. This means more than one event<a name="line.67"></a>
<span class="sourceLineNo">068</span> * handler methods can be invoked at the same time with mixed order. For example,<a name="line.68"></a>
<span class="sourceLineNo">069</span> * let's assume that messageReceived, messageSent, and sessionClosed events are<a name="line.69"></a>
<span class="sourceLineNo">070</span> * fired.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;ul&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;li&gt;All event handler methods can be called simultaneously.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * (e.g. messageReceived and messageSent can be invoked at the same time.)&lt;/li&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;li&gt;The event order can be mixed up.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * (e.g. sessionClosed or messageSent can be invoked before messageReceived<a name="line.75"></a>
<span class="sourceLineNo">076</span> * is invoked.)&lt;/li&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;/ul&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> * If you need to maintain the order of events per session, please specify an<a name="line.78"></a>
<span class="sourceLineNo">079</span> * {@link OrderedThreadPoolExecutor} instance or use the convenience constructors.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * <a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;h2&gt;Selective Filtering&lt;/h2&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * <a name="line.82"></a>
<span class="sourceLineNo">083</span> * By default, all event types but &lt;tt&gt;sessionCreated&lt;/tt&gt;, &lt;tt&gt;filterWrite&lt;/tt&gt;,<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;tt&gt;filterClose&lt;/tt&gt; and &lt;tt&gt;filterSetTrafficMask&lt;/tt&gt; are submitted to the<a name="line.84"></a>
<span class="sourceLineNo">085</span> * underlying executor, which is most common setting.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;p&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> * If you want to submit only a certain set of event types, you can specify them<a name="line.87"></a>
<span class="sourceLineNo">088</span> * in the constructor. For example, you could configure a thread pool for<a name="line.88"></a>
<span class="sourceLineNo">089</span> * write operation for the maximum performance:<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;pre&gt;&lt;code&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * IoService service = ...;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * DefaultIoFilterChainBuilder chain = service.getFilterChain();<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <a name="line.93"></a>
<span class="sourceLineNo">094</span> * chain.addLast("codec", new ProtocolCodecFilter(...));<a name="line.94"></a>
<span class="sourceLineNo">095</span> * // Use one thread pool for most events.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * chain.addLast("executor1", new ExecutorFilter());<a name="line.96"></a>
<span class="sourceLineNo">097</span> * // and another dedicated thread pool for 'filterWrite' events.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * chain.addLast("executor2", new ExecutorFilter(IoEventType.WRITE));<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;/code&gt;&lt;/pre&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> * <a name="line.100"></a>
<span class="sourceLineNo">101</span> * &lt;h2&gt;Preventing {@link OutOfMemoryError}&lt;/h2&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span> * <a name="line.102"></a>
<span class="sourceLineNo">103</span> * Please refer to {@link IoEventQueueThrottle}, which is specified as<a name="line.103"></a>
<span class="sourceLineNo">104</span> * a parameter of the convenience constructors.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * <a name="line.105"></a>
<span class="sourceLineNo">106</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * <a name="line.107"></a>
<span class="sourceLineNo">108</span> * @see OrderedThreadPoolExecutor<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @see UnorderedThreadPoolExecutor<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @org.apache.xbean.XBean<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span>public class ExecutorFilter extends IoFilterAdapter {<a name="line.112"></a>
<span class="sourceLineNo">113</span> /** The list of handled events */<a name="line.113"></a>
<span class="sourceLineNo">114</span> private EnumSet&lt;IoEventType&gt; eventTypes;<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /** The associated executor */<a name="line.116"></a>
<span class="sourceLineNo">117</span> private Executor executor;<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> /** A flag set if the executor can be managed */<a name="line.119"></a>
<span class="sourceLineNo">120</span> private boolean manageableExecutor;<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> /** The default pool size */<a name="line.122"></a>
<span class="sourceLineNo">123</span> private static final int DEFAULT_MAX_POOL_SIZE = 16;<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /** The number of thread to create at startup */<a name="line.125"></a>
<span class="sourceLineNo">126</span> private static final int BASE_THREAD_NUMBER = 0;<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> /** The default KeepAlive time, in seconds */<a name="line.128"></a>
<span class="sourceLineNo">129</span> private static final long DEFAULT_KEEPALIVE_TIME = 30;<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> * A set of flags used to tell if the Executor has been created <a name="line.132"></a>
<span class="sourceLineNo">133</span> * in the constructor or passed as an argument. In the second case, <a name="line.133"></a>
<span class="sourceLineNo">134</span> * the executor state can be managed.<a name="line.134"></a>
<span class="sourceLineNo">135</span> **/<a name="line.135"></a>
<span class="sourceLineNo">136</span> private static final boolean MANAGEABLE_EXECUTOR = true;<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> private static final boolean NOT_MANAGEABLE_EXECUTOR = false;<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> /** A list of default EventTypes to be handled by the executor */<a name="line.140"></a>
<span class="sourceLineNo">141</span> private static IoEventType[] DEFAULT_EVENT_SET = new IoEventType[] { IoEventType.EXCEPTION_CAUGHT,<a name="line.141"></a>
<span class="sourceLineNo">142</span> IoEventType.MESSAGE_RECEIVED, IoEventType.MESSAGE_SENT, IoEventType.SESSION_CLOSED,<a name="line.142"></a>
<span class="sourceLineNo">143</span> IoEventType.SESSION_IDLE, IoEventType.SESSION_OPENED };<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> * (Convenience constructor) Creates a new instance with a new<a name="line.146"></a>
<span class="sourceLineNo">147</span> * {@link OrderedThreadPoolExecutor}, no thread in the pool, and a <a name="line.147"></a>
<span class="sourceLineNo">148</span> * maximum of 16 threads in the pool. All the event will be handled <a name="line.148"></a>
<span class="sourceLineNo">149</span> * by this default executor.<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> public ExecutorFilter() {<a name="line.151"></a>
<span class="sourceLineNo">152</span> // Create a new default Executor<a name="line.152"></a>
<span class="sourceLineNo">153</span> Executor executor = createDefaultExecutor(BASE_THREAD_NUMBER, DEFAULT_MAX_POOL_SIZE, DEFAULT_KEEPALIVE_TIME,<a name="line.153"></a>
<span class="sourceLineNo">154</span> TimeUnit.SECONDS, Executors.defaultThreadFactory(), null);<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> // Initialize the filter<a name="line.156"></a>
<span class="sourceLineNo">157</span> init(executor, MANAGEABLE_EXECUTOR);<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * (Convenience constructor) Creates a new instance with a new<a name="line.161"></a>
<span class="sourceLineNo">162</span> * {@link OrderedThreadPoolExecutor}, no thread in the pool, but <a name="line.162"></a>
<span class="sourceLineNo">163</span> * a maximum of threads in the pool is given. All the event will be handled <a name="line.163"></a>
<span class="sourceLineNo">164</span> * by this default executor.<a name="line.164"></a>
<span class="sourceLineNo">165</span> * <a name="line.165"></a>
<span class="sourceLineNo">166</span> * @param maximumPoolSize The maximum pool size<a name="line.166"></a>
<span class="sourceLineNo">167</span> */<a name="line.167"></a>
<span class="sourceLineNo">168</span> public ExecutorFilter(int maximumPoolSize) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> // Create a new default Executor<a name="line.169"></a>
<span class="sourceLineNo">170</span> Executor executor = createDefaultExecutor(BASE_THREAD_NUMBER, maximumPoolSize, DEFAULT_KEEPALIVE_TIME,<a name="line.170"></a>
<span class="sourceLineNo">171</span> TimeUnit.SECONDS, Executors.defaultThreadFactory(), null);<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> // Initialize the filter<a name="line.173"></a>
<span class="sourceLineNo">174</span> init(executor, MANAGEABLE_EXECUTOR);<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> /**<a name="line.177"></a>
<span class="sourceLineNo">178</span> * (Convenience constructor) Creates a new instance with a new<a name="line.178"></a>
<span class="sourceLineNo">179</span> * {@link OrderedThreadPoolExecutor}, a number of thread to start with, a <a name="line.179"></a>
<span class="sourceLineNo">180</span> * maximum of threads the pool can contain. All the event will be handled <a name="line.180"></a>
<span class="sourceLineNo">181</span> * by this default executor.<a name="line.181"></a>
<span class="sourceLineNo">182</span> *<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @param corePoolSize The initial pool size<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @param maximumPoolSize The maximum pool size<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> // Create a new default Executor<a name="line.187"></a>
<span class="sourceLineNo">188</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, DEFAULT_KEEPALIVE_TIME,<a name="line.188"></a>
<span class="sourceLineNo">189</span> TimeUnit.SECONDS, Executors.defaultThreadFactory(), null);<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> // Initialize the filter<a name="line.191"></a>
<span class="sourceLineNo">192</span> init(executor, MANAGEABLE_EXECUTOR);<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> * (Convenience constructor) Creates a new instance with a new<a name="line.196"></a>
<span class="sourceLineNo">197</span> * {@link OrderedThreadPoolExecutor}.<a name="line.197"></a>
<span class="sourceLineNo">198</span> * <a name="line.198"></a>
<span class="sourceLineNo">199</span> * @param corePoolSize The initial pool size<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @param maximumPoolSize The maximum pool size<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @param keepAliveTime Default duration for a thread<a name="line.201"></a>
<span class="sourceLineNo">202</span> * @param unit Time unit used for the keepAlive value<a name="line.202"></a>
<span class="sourceLineNo">203</span> */<a name="line.203"></a>
<span class="sourceLineNo">204</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> // Create a new default Executor<a name="line.205"></a>
<span class="sourceLineNo">206</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.206"></a>
<span class="sourceLineNo">207</span> Executors.defaultThreadFactory(), null);<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> // Initialize the filter<a name="line.209"></a>
<span class="sourceLineNo">210</span> init(executor, MANAGEABLE_EXECUTOR);<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
<span class="sourceLineNo">214</span> * (Convenience constructor) Creates a new instance with a new<a name="line.214"></a>
<span class="sourceLineNo">215</span> * {@link OrderedThreadPoolExecutor}.<a name="line.215"></a>
<span class="sourceLineNo">216</span> * <a name="line.216"></a>
<span class="sourceLineNo">217</span> * @param corePoolSize The initial pool size<a name="line.217"></a>
<span class="sourceLineNo">218</span> * @param maximumPoolSize The maximum pool size<a name="line.218"></a>
<span class="sourceLineNo">219</span> * @param keepAliveTime Default duration for a thread<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @param unit Time unit used for the keepAlive value<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @param queueHandler The queue used to store events<a name="line.221"></a>
<span class="sourceLineNo">222</span> */<a name="line.222"></a>
<span class="sourceLineNo">223</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.223"></a>
<span class="sourceLineNo">224</span> IoEventQueueHandler queueHandler) {<a name="line.224"></a>
<span class="sourceLineNo">225</span> // Create a new default Executor<a name="line.225"></a>
<span class="sourceLineNo">226</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.226"></a>
<span class="sourceLineNo">227</span> Executors.defaultThreadFactory(), queueHandler);<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> // Initialize the filter<a name="line.229"></a>
<span class="sourceLineNo">230</span> init(executor, MANAGEABLE_EXECUTOR);<a name="line.230"></a>
<span class="sourceLineNo">231</span> }<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> * (Convenience constructor) Creates a new instance with a new<a name="line.234"></a>
<span class="sourceLineNo">235</span> * {@link OrderedThreadPoolExecutor}.<a name="line.235"></a>
<span class="sourceLineNo">236</span> * <a name="line.236"></a>
<span class="sourceLineNo">237</span> * @param corePoolSize The initial pool size<a name="line.237"></a>
<span class="sourceLineNo">238</span> * @param maximumPoolSize The maximum pool size<a name="line.238"></a>
<span class="sourceLineNo">239</span> * @param keepAliveTime Default duration for a thread<a name="line.239"></a>
<span class="sourceLineNo">240</span> * @param unit Time unit used for the keepAlive value<a name="line.240"></a>
<span class="sourceLineNo">241</span> * @param threadFactory The factory used to create threads<a name="line.241"></a>
<span class="sourceLineNo">242</span> */<a name="line.242"></a>
<span class="sourceLineNo">243</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.243"></a>
<span class="sourceLineNo">244</span> ThreadFactory threadFactory) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> // Create a new default Executor<a name="line.245"></a>
<span class="sourceLineNo">246</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit, threadFactory,<a name="line.246"></a>
<span class="sourceLineNo">247</span> null);<a name="line.247"></a>
<span class="sourceLineNo">248</span><a name="line.248"></a>
<span class="sourceLineNo">249</span> // Initialize the filter<a name="line.249"></a>
<span class="sourceLineNo">250</span> init(executor, MANAGEABLE_EXECUTOR);<a name="line.250"></a>
<span class="sourceLineNo">251</span> }<a name="line.251"></a>
<span class="sourceLineNo">252</span><a name="line.252"></a>
<span class="sourceLineNo">253</span> /**<a name="line.253"></a>
<span class="sourceLineNo">254</span> * (Convenience constructor) Creates a new instance with a new<a name="line.254"></a>
<span class="sourceLineNo">255</span> * {@link OrderedThreadPoolExecutor}.<a name="line.255"></a>
<span class="sourceLineNo">256</span> * <a name="line.256"></a>
<span class="sourceLineNo">257</span> * @param corePoolSize The initial pool size<a name="line.257"></a>
<span class="sourceLineNo">258</span> * @param maximumPoolSize The maximum pool size<a name="line.258"></a>
<span class="sourceLineNo">259</span> * @param keepAliveTime Default duration for a thread<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @param unit Time unit used for the keepAlive value<a name="line.260"></a>
<span class="sourceLineNo">261</span> * @param threadFactory The factory used to create threads<a name="line.261"></a>
<span class="sourceLineNo">262</span> * @param queueHandler The queue used to store events<a name="line.262"></a>
<span class="sourceLineNo">263</span> */<a name="line.263"></a>
<span class="sourceLineNo">264</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.264"></a>
<span class="sourceLineNo">265</span> ThreadFactory threadFactory, IoEventQueueHandler queueHandler) {<a name="line.265"></a>
<span class="sourceLineNo">266</span> // Create a new default Executor<a name="line.266"></a>
<span class="sourceLineNo">267</span> Executor executor = new OrderedThreadPoolExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.267"></a>
<span class="sourceLineNo">268</span> threadFactory, queueHandler);<a name="line.268"></a>
<span class="sourceLineNo">269</span><a name="line.269"></a>
<span class="sourceLineNo">270</span> // Initialize the filter<a name="line.270"></a>
<span class="sourceLineNo">271</span> init(executor, MANAGEABLE_EXECUTOR);<a name="line.271"></a>
<span class="sourceLineNo">272</span> }<a name="line.272"></a>
<span class="sourceLineNo">273</span><a name="line.273"></a>
<span class="sourceLineNo">274</span> /**<a name="line.274"></a>
<span class="sourceLineNo">275</span> * (Convenience constructor) Creates a new instance with a new<a name="line.275"></a>
<span class="sourceLineNo">276</span> * {@link OrderedThreadPoolExecutor}.<a name="line.276"></a>
<span class="sourceLineNo">277</span> * <a name="line.277"></a>
<span class="sourceLineNo">278</span> * @param eventTypes The event for which the executor will be used<a name="line.278"></a>
<span class="sourceLineNo">279</span> */<a name="line.279"></a>
<span class="sourceLineNo">280</span> public ExecutorFilter(IoEventType... eventTypes) {<a name="line.280"></a>
<span class="sourceLineNo">281</span> // Create a new default Executor<a name="line.281"></a>
<span class="sourceLineNo">282</span> Executor executor = createDefaultExecutor(BASE_THREAD_NUMBER, DEFAULT_MAX_POOL_SIZE, DEFAULT_KEEPALIVE_TIME,<a name="line.282"></a>
<span class="sourceLineNo">283</span> TimeUnit.SECONDS, Executors.defaultThreadFactory(), null);<a name="line.283"></a>
<span class="sourceLineNo">284</span><a name="line.284"></a>
<span class="sourceLineNo">285</span> // Initialize the filter<a name="line.285"></a>
<span class="sourceLineNo">286</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span> /**<a name="line.289"></a>
<span class="sourceLineNo">290</span> * (Convenience constructor) Creates a new instance with a new<a name="line.290"></a>
<span class="sourceLineNo">291</span> * {@link OrderedThreadPoolExecutor}.<a name="line.291"></a>
<span class="sourceLineNo">292</span> * <a name="line.292"></a>
<span class="sourceLineNo">293</span> * @param maximumPoolSize The maximum pool size<a name="line.293"></a>
<span class="sourceLineNo">294</span> * @param eventTypes The event for which the executor will be used<a name="line.294"></a>
<span class="sourceLineNo">295</span> */<a name="line.295"></a>
<span class="sourceLineNo">296</span> public ExecutorFilter(int maximumPoolSize, IoEventType... eventTypes) {<a name="line.296"></a>
<span class="sourceLineNo">297</span> // Create a new default Executor<a name="line.297"></a>
<span class="sourceLineNo">298</span> Executor executor = createDefaultExecutor(BASE_THREAD_NUMBER, maximumPoolSize, DEFAULT_KEEPALIVE_TIME,<a name="line.298"></a>
<span class="sourceLineNo">299</span> TimeUnit.SECONDS, Executors.defaultThreadFactory(), null);<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span> // Initialize the filter<a name="line.301"></a>
<span class="sourceLineNo">302</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.302"></a>
<span class="sourceLineNo">303</span> }<a name="line.303"></a>
<span class="sourceLineNo">304</span><a name="line.304"></a>
<span class="sourceLineNo">305</span> /**<a name="line.305"></a>
<span class="sourceLineNo">306</span> * (Convenience constructor) Creates a new instance with a new<a name="line.306"></a>
<span class="sourceLineNo">307</span> * {@link OrderedThreadPoolExecutor}.<a name="line.307"></a>
<span class="sourceLineNo">308</span> * <a name="line.308"></a>
<span class="sourceLineNo">309</span> * @param corePoolSize The initial pool size<a name="line.309"></a>
<span class="sourceLineNo">310</span> * @param maximumPoolSize The maximum pool size<a name="line.310"></a>
<span class="sourceLineNo">311</span> * @param eventTypes The event for which the executor will be used<a name="line.311"></a>
<span class="sourceLineNo">312</span> */<a name="line.312"></a>
<span class="sourceLineNo">313</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, IoEventType... eventTypes) {<a name="line.313"></a>
<span class="sourceLineNo">314</span> // Create a new default Executor<a name="line.314"></a>
<span class="sourceLineNo">315</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, DEFAULT_KEEPALIVE_TIME,<a name="line.315"></a>
<span class="sourceLineNo">316</span> TimeUnit.SECONDS, Executors.defaultThreadFactory(), null);<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span> // Initialize the filter<a name="line.318"></a>
<span class="sourceLineNo">319</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.319"></a>
<span class="sourceLineNo">320</span> }<a name="line.320"></a>
<span class="sourceLineNo">321</span><a name="line.321"></a>
<span class="sourceLineNo">322</span> /**<a name="line.322"></a>
<span class="sourceLineNo">323</span> * (Convenience constructor) Creates a new instance with a new<a name="line.323"></a>
<span class="sourceLineNo">324</span> * {@link OrderedThreadPoolExecutor}.<a name="line.324"></a>
<span class="sourceLineNo">325</span> * <a name="line.325"></a>
<span class="sourceLineNo">326</span> * @param corePoolSize The initial pool size<a name="line.326"></a>
<span class="sourceLineNo">327</span> * @param maximumPoolSize The maximum pool size<a name="line.327"></a>
<span class="sourceLineNo">328</span> * @param keepAliveTime Default duration for a thread<a name="line.328"></a>
<span class="sourceLineNo">329</span> * @param unit Time unit used for the keepAlive value<a name="line.329"></a>
<span class="sourceLineNo">330</span> * @param eventTypes The event for which the executor will be used<a name="line.330"></a>
<span class="sourceLineNo">331</span> */<a name="line.331"></a>
<span class="sourceLineNo">332</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.332"></a>
<span class="sourceLineNo">333</span> IoEventType... eventTypes) {<a name="line.333"></a>
<span class="sourceLineNo">334</span> // Create a new default Executor<a name="line.334"></a>
<span class="sourceLineNo">335</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.335"></a>
<span class="sourceLineNo">336</span> Executors.defaultThreadFactory(), null);<a name="line.336"></a>
<span class="sourceLineNo">337</span><a name="line.337"></a>
<span class="sourceLineNo">338</span> // Initialize the filter<a name="line.338"></a>
<span class="sourceLineNo">339</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.339"></a>
<span class="sourceLineNo">340</span> }<a name="line.340"></a>
<span class="sourceLineNo">341</span><a name="line.341"></a>
<span class="sourceLineNo">342</span> /**<a name="line.342"></a>
<span class="sourceLineNo">343</span> * (Convenience constructor) Creates a new instance with a new<a name="line.343"></a>
<span class="sourceLineNo">344</span> * {@link OrderedThreadPoolExecutor}.<a name="line.344"></a>
<span class="sourceLineNo">345</span> * <a name="line.345"></a>
<span class="sourceLineNo">346</span> * @param corePoolSize The initial pool size<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @param maximumPoolSize The maximum pool size<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @param keepAliveTime Default duration for a thread<a name="line.348"></a>
<span class="sourceLineNo">349</span> * @param unit Time unit used for the keepAlive value<a name="line.349"></a>
<span class="sourceLineNo">350</span> * @param queueHandler The queue used to store events<a name="line.350"></a>
<span class="sourceLineNo">351</span> * @param eventTypes The event for which the executor will be used<a name="line.351"></a>
<span class="sourceLineNo">352</span> */<a name="line.352"></a>
<span class="sourceLineNo">353</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.353"></a>
<span class="sourceLineNo">354</span> IoEventQueueHandler queueHandler, IoEventType... eventTypes) {<a name="line.354"></a>
<span class="sourceLineNo">355</span> // Create a new default Executor<a name="line.355"></a>
<span class="sourceLineNo">356</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.356"></a>
<span class="sourceLineNo">357</span> Executors.defaultThreadFactory(), queueHandler);<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> // Initialize the filter<a name="line.359"></a>
<span class="sourceLineNo">360</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.360"></a>
<span class="sourceLineNo">361</span> }<a name="line.361"></a>
<span class="sourceLineNo">362</span><a name="line.362"></a>
<span class="sourceLineNo">363</span> /**<a name="line.363"></a>
<span class="sourceLineNo">364</span> * (Convenience constructor) Creates a new instance with a new<a name="line.364"></a>
<span class="sourceLineNo">365</span> * {@link OrderedThreadPoolExecutor}.<a name="line.365"></a>
<span class="sourceLineNo">366</span> * <a name="line.366"></a>
<span class="sourceLineNo">367</span> * @param corePoolSize The initial pool size<a name="line.367"></a>
<span class="sourceLineNo">368</span> * @param maximumPoolSize The maximum pool size<a name="line.368"></a>
<span class="sourceLineNo">369</span> * @param keepAliveTime Default duration for a thread<a name="line.369"></a>
<span class="sourceLineNo">370</span> * @param unit Time unit used for the keepAlive value<a name="line.370"></a>
<span class="sourceLineNo">371</span> * @param threadFactory The factory used to create threads<a name="line.371"></a>
<span class="sourceLineNo">372</span> * @param eventTypes The event for which the executor will be used<a name="line.372"></a>
<span class="sourceLineNo">373</span> */<a name="line.373"></a>
<span class="sourceLineNo">374</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.374"></a>
<span class="sourceLineNo">375</span> ThreadFactory threadFactory, IoEventType... eventTypes) {<a name="line.375"></a>
<span class="sourceLineNo">376</span> // Create a new default Executor<a name="line.376"></a>
<span class="sourceLineNo">377</span> Executor executor = createDefaultExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit, threadFactory,<a name="line.377"></a>
<span class="sourceLineNo">378</span> null);<a name="line.378"></a>
<span class="sourceLineNo">379</span><a name="line.379"></a>
<span class="sourceLineNo">380</span> // Initialize the filter<a name="line.380"></a>
<span class="sourceLineNo">381</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> /**<a name="line.384"></a>
<span class="sourceLineNo">385</span> * (Convenience constructor) Creates a new instance with a new<a name="line.385"></a>
<span class="sourceLineNo">386</span> * {@link OrderedThreadPoolExecutor}.<a name="line.386"></a>
<span class="sourceLineNo">387</span> * <a name="line.387"></a>
<span class="sourceLineNo">388</span> * @param corePoolSize The initial pool size<a name="line.388"></a>
<span class="sourceLineNo">389</span> * @param maximumPoolSize The maximum pool size<a name="line.389"></a>
<span class="sourceLineNo">390</span> * @param keepAliveTime Default duration for a thread<a name="line.390"></a>
<span class="sourceLineNo">391</span> * @param unit Time unit used for the keepAlive value<a name="line.391"></a>
<span class="sourceLineNo">392</span> * @param threadFactory The factory used to create threads<a name="line.392"></a>
<span class="sourceLineNo">393</span> * @param queueHandler The queue used to store events<a name="line.393"></a>
<span class="sourceLineNo">394</span> * @param eventTypes The event for which the executor will be used<a name="line.394"></a>
<span class="sourceLineNo">395</span> */<a name="line.395"></a>
<span class="sourceLineNo">396</span> public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.396"></a>
<span class="sourceLineNo">397</span> ThreadFactory threadFactory, IoEventQueueHandler queueHandler, IoEventType... eventTypes) {<a name="line.397"></a>
<span class="sourceLineNo">398</span> // Create a new default Executor<a name="line.398"></a>
<span class="sourceLineNo">399</span> Executor executor = new OrderedThreadPoolExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.399"></a>
<span class="sourceLineNo">400</span> threadFactory, queueHandler);<a name="line.400"></a>
<span class="sourceLineNo">401</span><a name="line.401"></a>
<span class="sourceLineNo">402</span> // Initialize the filter<a name="line.402"></a>
<span class="sourceLineNo">403</span> init(executor, MANAGEABLE_EXECUTOR, eventTypes);<a name="line.403"></a>
<span class="sourceLineNo">404</span> }<a name="line.404"></a>
<span class="sourceLineNo">405</span><a name="line.405"></a>
<span class="sourceLineNo">406</span> /**<a name="line.406"></a>
<span class="sourceLineNo">407</span> * Creates a new instance with the specified {@link Executor}.<a name="line.407"></a>
<span class="sourceLineNo">408</span> * <a name="line.408"></a>
<span class="sourceLineNo">409</span> * @param executor the user's managed Executor to use in this filter<a name="line.409"></a>
<span class="sourceLineNo">410</span> */<a name="line.410"></a>
<span class="sourceLineNo">411</span> public ExecutorFilter(Executor executor) {<a name="line.411"></a>
<span class="sourceLineNo">412</span> // Initialize the filter<a name="line.412"></a>
<span class="sourceLineNo">413</span> init(executor, NOT_MANAGEABLE_EXECUTOR);<a name="line.413"></a>
<span class="sourceLineNo">414</span> }<a name="line.414"></a>
<span class="sourceLineNo">415</span><a name="line.415"></a>
<span class="sourceLineNo">416</span> /**<a name="line.416"></a>
<span class="sourceLineNo">417</span> * Creates a new instance with the specified {@link Executor}.<a name="line.417"></a>
<span class="sourceLineNo">418</span> * <a name="line.418"></a>
<span class="sourceLineNo">419</span> * @param executor the user's managed Executor to use in this filter<a name="line.419"></a>
<span class="sourceLineNo">420</span> * @param eventTypes The event for which the executor will be used<a name="line.420"></a>
<span class="sourceLineNo">421</span> */<a name="line.421"></a>
<span class="sourceLineNo">422</span> public ExecutorFilter(Executor executor, IoEventType... eventTypes) {<a name="line.422"></a>
<span class="sourceLineNo">423</span> // Initialize the filter<a name="line.423"></a>
<span class="sourceLineNo">424</span> init(executor, NOT_MANAGEABLE_EXECUTOR, eventTypes);<a name="line.424"></a>
<span class="sourceLineNo">425</span> }<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span> /**<a name="line.427"></a>
<span class="sourceLineNo">428</span> * Create an OrderedThreadPool executor.<a name="line.428"></a>
<span class="sourceLineNo">429</span> *<a name="line.429"></a>
<span class="sourceLineNo">430</span> * @param corePoolSize The initial pool sizePoolSize<a name="line.430"></a>
<span class="sourceLineNo">431</span> * @param maximumPoolSize The maximum pool size<a name="line.431"></a>
<span class="sourceLineNo">432</span> * @param keepAliveTime Default duration for a thread<a name="line.432"></a>
<span class="sourceLineNo">433</span> * @param unit Time unit used for the keepAlive value<a name="line.433"></a>
<span class="sourceLineNo">434</span> * @param threadFactory The factory used to create threads<a name="line.434"></a>
<span class="sourceLineNo">435</span> * @param queueHandler The queue used to store events<a name="line.435"></a>
<span class="sourceLineNo">436</span> * @return An instance of the created Executor<a name="line.436"></a>
<span class="sourceLineNo">437</span> */<a name="line.437"></a>
<span class="sourceLineNo">438</span> private Executor createDefaultExecutor(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,<a name="line.438"></a>
<span class="sourceLineNo">439</span> ThreadFactory threadFactory, IoEventQueueHandler queueHandler) {<a name="line.439"></a>
<span class="sourceLineNo">440</span> // Create a new Executor<a name="line.440"></a>
<span class="sourceLineNo">441</span> Executor executor = new OrderedThreadPoolExecutor(corePoolSize, maximumPoolSize, keepAliveTime, unit,<a name="line.441"></a>
<span class="sourceLineNo">442</span> threadFactory, queueHandler);<a name="line.442"></a>
<span class="sourceLineNo">443</span><a name="line.443"></a>
<span class="sourceLineNo">444</span> return executor;<a name="line.444"></a>
<span class="sourceLineNo">445</span> }<a name="line.445"></a>
<span class="sourceLineNo">446</span><a name="line.446"></a>
<span class="sourceLineNo">447</span> /**<a name="line.447"></a>
<span class="sourceLineNo">448</span> * Create an EnumSet from an array of EventTypes, and set the associated<a name="line.448"></a>
<span class="sourceLineNo">449</span> * eventTypes field.<a name="line.449"></a>
<span class="sourceLineNo">450</span> *<a name="line.450"></a>
<span class="sourceLineNo">451</span> * @param eventTypes The array of handled events<a name="line.451"></a>
<span class="sourceLineNo">452</span> */<a name="line.452"></a>
<span class="sourceLineNo">453</span> private void initEventTypes(IoEventType... eventTypes) {<a name="line.453"></a>
<span class="sourceLineNo">454</span> if ((eventTypes == null) || (eventTypes.length == 0)) {<a name="line.454"></a>
<span class="sourceLineNo">455</span> eventTypes = DEFAULT_EVENT_SET;<a name="line.455"></a>
<span class="sourceLineNo">456</span> }<a name="line.456"></a>
<span class="sourceLineNo">457</span><a name="line.457"></a>
<span class="sourceLineNo">458</span> // Copy the list of handled events in the event set<a name="line.458"></a>
<span class="sourceLineNo">459</span> this.eventTypes = EnumSet.of(eventTypes[0], eventTypes);<a name="line.459"></a>
<span class="sourceLineNo">460</span><a name="line.460"></a>
<span class="sourceLineNo">461</span> // Check that we don't have the SESSION_CREATED event in the set<a name="line.461"></a>
<span class="sourceLineNo">462</span> if (this.eventTypes.contains(IoEventType.SESSION_CREATED)) {<a name="line.462"></a>
<span class="sourceLineNo">463</span> this.eventTypes = null;<a name="line.463"></a>
<span class="sourceLineNo">464</span> throw new IllegalArgumentException(IoEventType.SESSION_CREATED + " is not allowed.");<a name="line.464"></a>
<span class="sourceLineNo">465</span> }<a name="line.465"></a>
<span class="sourceLineNo">466</span> }<a name="line.466"></a>
<span class="sourceLineNo">467</span><a name="line.467"></a>
<span class="sourceLineNo">468</span> /**<a name="line.468"></a>
<span class="sourceLineNo">469</span> * Creates a new instance of ExecutorFilter. This private constructor is called by all<a name="line.469"></a>
<span class="sourceLineNo">470</span> * the public constructor.<a name="line.470"></a>
<span class="sourceLineNo">471</span> *<a name="line.471"></a>
<span class="sourceLineNo">472</span> * @param executor The underlying {@link Executor} in charge of managing the Thread pool.<a name="line.472"></a>
<span class="sourceLineNo">473</span> * @param manageableExecutor Tells if the Executor's Life Cycle can be managed or not<a name="line.473"></a>
<span class="sourceLineNo">474</span> * @param eventTypes The lit of event which are handled by the executor<a name="line.474"></a>
<span class="sourceLineNo">475</span> */<a name="line.475"></a>
<span class="sourceLineNo">476</span> private void init(Executor executor, boolean manageableExecutor, IoEventType... eventTypes) {<a name="line.476"></a>
<span class="sourceLineNo">477</span> if (executor == null) {<a name="line.477"></a>
<span class="sourceLineNo">478</span> throw new IllegalArgumentException("executor");<a name="line.478"></a>
<span class="sourceLineNo">479</span> }<a name="line.479"></a>
<span class="sourceLineNo">480</span><a name="line.480"></a>
<span class="sourceLineNo">481</span> initEventTypes(eventTypes);<a name="line.481"></a>
<span class="sourceLineNo">482</span> this.executor = executor;<a name="line.482"></a>
<span class="sourceLineNo">483</span> this.manageableExecutor = manageableExecutor;<a name="line.483"></a>
<span class="sourceLineNo">484</span> }<a name="line.484"></a>
<span class="sourceLineNo">485</span><a name="line.485"></a>
<span class="sourceLineNo">486</span> /**<a name="line.486"></a>
<span class="sourceLineNo">487</span> * Shuts down the underlying executor if this filter hase been created via<a name="line.487"></a>
<span class="sourceLineNo">488</span> * a convenience constructor.<a name="line.488"></a>
<span class="sourceLineNo">489</span> */<a name="line.489"></a>
<span class="sourceLineNo">490</span> @Override<a name="line.490"></a>
<span class="sourceLineNo">491</span> public void destroy() {<a name="line.491"></a>
<span class="sourceLineNo">492</span> if (manageableExecutor) {<a name="line.492"></a>
<span class="sourceLineNo">493</span> ((ExecutorService) executor).shutdown();<a name="line.493"></a>
<span class="sourceLineNo">494</span> }<a name="line.494"></a>
<span class="sourceLineNo">495</span> }<a name="line.495"></a>
<span class="sourceLineNo">496</span><a name="line.496"></a>
<span class="sourceLineNo">497</span> /**<a name="line.497"></a>
<span class="sourceLineNo">498</span> * Returns the underlying {@link Executor} instance this filter uses.<a name="line.498"></a>
<span class="sourceLineNo">499</span> * <a name="line.499"></a>
<span class="sourceLineNo">500</span> * @return The underlying {@link Executor}<a name="line.500"></a>
<span class="sourceLineNo">501</span> */<a name="line.501"></a>
<span class="sourceLineNo">502</span> public final Executor getExecutor() {<a name="line.502"></a>
<span class="sourceLineNo">503</span> return executor;<a name="line.503"></a>
<span class="sourceLineNo">504</span> }<a name="line.504"></a>
<span class="sourceLineNo">505</span><a name="line.505"></a>
<span class="sourceLineNo">506</span> /**<a name="line.506"></a>
<span class="sourceLineNo">507</span> * Fires the specified event through the underlying executor.<a name="line.507"></a>
<span class="sourceLineNo">508</span> * <a name="line.508"></a>
<span class="sourceLineNo">509</span> * @param event The filtered event<a name="line.509"></a>
<span class="sourceLineNo">510</span> */<a name="line.510"></a>
<span class="sourceLineNo">511</span> protected void fireEvent(IoFilterEvent event) {<a name="line.511"></a>
<span class="sourceLineNo">512</span> executor.execute(event);<a name="line.512"></a>
<span class="sourceLineNo">513</span> }<a name="line.513"></a>
<span class="sourceLineNo">514</span><a name="line.514"></a>
<span class="sourceLineNo">515</span> /**<a name="line.515"></a>
<span class="sourceLineNo">516</span> * {@inheritDoc}<a name="line.516"></a>
<span class="sourceLineNo">517</span> */<a name="line.517"></a>
<span class="sourceLineNo">518</span> @Override<a name="line.518"></a>
<span class="sourceLineNo">519</span> public void onPreAdd(IoFilterChain parent, String name, NextFilter nextFilter) throws Exception {<a name="line.519"></a>
<span class="sourceLineNo">520</span> if (parent.contains(this)) {<a name="line.520"></a>
<span class="sourceLineNo">521</span> throw new IllegalArgumentException(<a name="line.521"></a>
<span class="sourceLineNo">522</span> "You can't add the same filter instance more than once. Create another instance and add it.");<a name="line.522"></a>
<span class="sourceLineNo">523</span> }<a name="line.523"></a>
<span class="sourceLineNo">524</span> }<a name="line.524"></a>
<span class="sourceLineNo">525</span><a name="line.525"></a>
<span class="sourceLineNo">526</span> /**<a name="line.526"></a>
<span class="sourceLineNo">527</span> * {@inheritDoc}<a name="line.527"></a>
<span class="sourceLineNo">528</span> */<a name="line.528"></a>
<span class="sourceLineNo">529</span> @Override<a name="line.529"></a>
<span class="sourceLineNo">530</span> public final void sessionOpened(NextFilter nextFilter, IoSession session) {<a name="line.530"></a>
<span class="sourceLineNo">531</span> if (eventTypes.contains(IoEventType.SESSION_OPENED)) {<a name="line.531"></a>
<span class="sourceLineNo">532</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.SESSION_OPENED, session, null);<a name="line.532"></a>
<span class="sourceLineNo">533</span> fireEvent(event);<a name="line.533"></a>
<span class="sourceLineNo">534</span> } else {<a name="line.534"></a>
<span class="sourceLineNo">535</span> nextFilter.sessionOpened(session);<a name="line.535"></a>
<span class="sourceLineNo">536</span> }<a name="line.536"></a>
<span class="sourceLineNo">537</span> }<a name="line.537"></a>
<span class="sourceLineNo">538</span><a name="line.538"></a>
<span class="sourceLineNo">539</span> /**<a name="line.539"></a>
<span class="sourceLineNo">540</span> * {@inheritDoc}<a name="line.540"></a>
<span class="sourceLineNo">541</span> */<a name="line.541"></a>
<span class="sourceLineNo">542</span> @Override<a name="line.542"></a>
<span class="sourceLineNo">543</span> public final void sessionClosed(NextFilter nextFilter, IoSession session) {<a name="line.543"></a>
<span class="sourceLineNo">544</span> if (eventTypes.contains(IoEventType.SESSION_CLOSED)) {<a name="line.544"></a>
<span class="sourceLineNo">545</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.SESSION_CLOSED, session, null);<a name="line.545"></a>
<span class="sourceLineNo">546</span> fireEvent(event);<a name="line.546"></a>
<span class="sourceLineNo">547</span> } else {<a name="line.547"></a>
<span class="sourceLineNo">548</span> nextFilter.sessionClosed(session);<a name="line.548"></a>
<span class="sourceLineNo">549</span> }<a name="line.549"></a>
<span class="sourceLineNo">550</span> }<a name="line.550"></a>
<span class="sourceLineNo">551</span><a name="line.551"></a>
<span class="sourceLineNo">552</span> /**<a name="line.552"></a>
<span class="sourceLineNo">553</span> * {@inheritDoc}<a name="line.553"></a>
<span class="sourceLineNo">554</span> */<a name="line.554"></a>
<span class="sourceLineNo">555</span> @Override<a name="line.555"></a>
<span class="sourceLineNo">556</span> public final void sessionIdle(NextFilter nextFilter, IoSession session, IdleStatus status) {<a name="line.556"></a>
<span class="sourceLineNo">557</span> if (eventTypes.contains(IoEventType.SESSION_IDLE)) {<a name="line.557"></a>
<span class="sourceLineNo">558</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.SESSION_IDLE, session, status);<a name="line.558"></a>
<span class="sourceLineNo">559</span> fireEvent(event);<a name="line.559"></a>
<span class="sourceLineNo">560</span> } else {<a name="line.560"></a>
<span class="sourceLineNo">561</span> nextFilter.sessionIdle(session, status);<a name="line.561"></a>
<span class="sourceLineNo">562</span> }<a name="line.562"></a>
<span class="sourceLineNo">563</span> }<a name="line.563"></a>
<span class="sourceLineNo">564</span><a name="line.564"></a>
<span class="sourceLineNo">565</span> /**<a name="line.565"></a>
<span class="sourceLineNo">566</span> * {@inheritDoc}<a name="line.566"></a>
<span class="sourceLineNo">567</span> */<a name="line.567"></a>
<span class="sourceLineNo">568</span> @Override<a name="line.568"></a>
<span class="sourceLineNo">569</span> public final void exceptionCaught(NextFilter nextFilter, IoSession session, Throwable cause) {<a name="line.569"></a>
<span class="sourceLineNo">570</span> if (eventTypes.contains(IoEventType.EXCEPTION_CAUGHT)) {<a name="line.570"></a>
<span class="sourceLineNo">571</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.EXCEPTION_CAUGHT, session, cause);<a name="line.571"></a>
<span class="sourceLineNo">572</span> fireEvent(event);<a name="line.572"></a>
<span class="sourceLineNo">573</span> } else {<a name="line.573"></a>
<span class="sourceLineNo">574</span> nextFilter.exceptionCaught(session, cause);<a name="line.574"></a>
<span class="sourceLineNo">575</span> }<a name="line.575"></a>
<span class="sourceLineNo">576</span> }<a name="line.576"></a>
<span class="sourceLineNo">577</span><a name="line.577"></a>
<span class="sourceLineNo">578</span> /**<a name="line.578"></a>
<span class="sourceLineNo">579</span> * {@inheritDoc}<a name="line.579"></a>
<span class="sourceLineNo">580</span> */<a name="line.580"></a>
<span class="sourceLineNo">581</span> @Override<a name="line.581"></a>
<span class="sourceLineNo">582</span> public final void messageReceived(NextFilter nextFilter, IoSession session, Object message) {<a name="line.582"></a>
<span class="sourceLineNo">583</span> if (eventTypes.contains(IoEventType.MESSAGE_RECEIVED)) {<a name="line.583"></a>
<span class="sourceLineNo">584</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.MESSAGE_RECEIVED, session, message);<a name="line.584"></a>
<span class="sourceLineNo">585</span> fireEvent(event);<a name="line.585"></a>
<span class="sourceLineNo">586</span> } else {<a name="line.586"></a>
<span class="sourceLineNo">587</span> nextFilter.messageReceived(session, message);<a name="line.587"></a>
<span class="sourceLineNo">588</span> }<a name="line.588"></a>
<span class="sourceLineNo">589</span> }<a name="line.589"></a>
<span class="sourceLineNo">590</span><a name="line.590"></a>
<span class="sourceLineNo">591</span> /**<a name="line.591"></a>
<span class="sourceLineNo">592</span> * {@inheritDoc}<a name="line.592"></a>
<span class="sourceLineNo">593</span> */<a name="line.593"></a>
<span class="sourceLineNo">594</span> @Override<a name="line.594"></a>
<span class="sourceLineNo">595</span> public final void messageSent(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) {<a name="line.595"></a>
<span class="sourceLineNo">596</span> if (eventTypes.contains(IoEventType.MESSAGE_SENT)) {<a name="line.596"></a>
<span class="sourceLineNo">597</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.MESSAGE_SENT, session, writeRequest);<a name="line.597"></a>
<span class="sourceLineNo">598</span> fireEvent(event);<a name="line.598"></a>
<span class="sourceLineNo">599</span> } else {<a name="line.599"></a>
<span class="sourceLineNo">600</span> nextFilter.messageSent(session, writeRequest);<a name="line.600"></a>
<span class="sourceLineNo">601</span> }<a name="line.601"></a>
<span class="sourceLineNo">602</span> }<a name="line.602"></a>
<span class="sourceLineNo">603</span><a name="line.603"></a>
<span class="sourceLineNo">604</span> /**<a name="line.604"></a>
<span class="sourceLineNo">605</span> * {@inheritDoc}<a name="line.605"></a>
<span class="sourceLineNo">606</span> */<a name="line.606"></a>
<span class="sourceLineNo">607</span> @Override<a name="line.607"></a>
<span class="sourceLineNo">608</span> public final void filterWrite(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) {<a name="line.608"></a>
<span class="sourceLineNo">609</span> if (eventTypes.contains(IoEventType.WRITE)) {<a name="line.609"></a>
<span class="sourceLineNo">610</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.WRITE, session, writeRequest);<a name="line.610"></a>
<span class="sourceLineNo">611</span> fireEvent(event);<a name="line.611"></a>
<span class="sourceLineNo">612</span> } else {<a name="line.612"></a>
<span class="sourceLineNo">613</span> nextFilter.filterWrite(session, writeRequest);<a name="line.613"></a>
<span class="sourceLineNo">614</span> }<a name="line.614"></a>
<span class="sourceLineNo">615</span> }<a name="line.615"></a>
<span class="sourceLineNo">616</span><a name="line.616"></a>
<span class="sourceLineNo">617</span> /**<a name="line.617"></a>
<span class="sourceLineNo">618</span> * {@inheritDoc}<a name="line.618"></a>
<span class="sourceLineNo">619</span> */<a name="line.619"></a>
<span class="sourceLineNo">620</span> @Override<a name="line.620"></a>
<span class="sourceLineNo">621</span> public final void filterClose(NextFilter nextFilter, IoSession session) throws Exception {<a name="line.621"></a>
<span class="sourceLineNo">622</span> if (eventTypes.contains(IoEventType.CLOSE)) {<a name="line.622"></a>
<span class="sourceLineNo">623</span> IoFilterEvent event = new IoFilterEvent(nextFilter, IoEventType.CLOSE, session, null);<a name="line.623"></a>
<span class="sourceLineNo">624</span> fireEvent(event);<a name="line.624"></a>
<span class="sourceLineNo">625</span> } else {<a name="line.625"></a>
<span class="sourceLineNo">626</span> nextFilter.filterClose(session);<a name="line.626"></a>
<span class="sourceLineNo">627</span> }<a name="line.627"></a>
<span class="sourceLineNo">628</span> }<a name="line.628"></a>
<span class="sourceLineNo">629</span>}<a name="line.629"></a>
</pre>
</div>
</body>
</html>