blob: 0fcfe6b542d38f5629bdbfad4a027568a57d09f7 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AvailablePortFinder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/mina/util/AvailablePortFinder.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * @(#) $Id: AvailablePortFinder.java 210062 2005-07-11 03:52:38Z trustin $</em>
<a name="3" href="#3">3</a> <em class="comment"> * </em>
<a name="4" href="#4">4</a> <em class="comment"> * Copyright 2004 The Apache Software Foundation</em>
<a name="5" href="#5">5</a> <em class="comment"> *</em>
<a name="6" href="#6">6</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="7" href="#7">7</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="8" href="#8">8</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="comment"> *</em>
<a name="12" href="#12">12</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a> <em class="comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a> <em class="comment"> *</em>
<a name="18" href="#18">18</a> <em class="comment"> */</em>
<a name="19" href="#19">19</a> <strong>package</strong> <a href="../../../../org/apache/mina/util/package-summary.html">org.apache.mina.util</a>;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong>import</strong> java.io.IOException;
<a name="22" href="#22">22</a> <strong>import</strong> java.net.DatagramSocket;
<a name="23" href="#23">23</a> <strong>import</strong> java.net.ServerSocket;
<a name="24" href="#24">24</a> <strong>import</strong> java.util.NoSuchElementException;
<a name="25" href="#25">25</a> <strong>import</strong> java.util.Set;
<a name="26" href="#26">26</a> <strong>import</strong> java.util.TreeSet;
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
<a name="30" href="#30">30</a> <em> * Finds currently available server ports.</em>
<a name="31" href="#31">31</a> <em> *</em>
<a name="32" href="#32">32</a> <em> * @author The Apache Directory Project</em>
<a name="33" href="#33">33</a> <em> * @version $Rev: 210062 $</em>
<a name="34" href="#34">34</a> <em> * @see &lt;a href="<a href="http://www.iana.org/assignments/port-numbers" target="alexandria_uri">http://www.iana.org/assignments/port-numbers</a>">IANA.org&lt;/a></em>
<a name="35" href="#35">35</a> <em> */</em>
<a name="36" href="#36">36</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/mina/util/AvailablePortFinder.html">AvailablePortFinder</a>
<a name="37" href="#37">37</a> {
<a name="38" href="#38">38</a> <em>/**<em>*</em></em>
<a name="39" href="#39">39</a> <em> * The minimum number of server port number.</em>
<a name="40" href="#40">40</a> <em> */</em>
<a name="41" href="#41">41</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> MIN_PORT_NUMBER = 1;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em>/**<em>*</em></em>
<a name="44" href="#44">44</a> <em> * The maximum number of server port number.</em>
<a name="45" href="#45">45</a> <em> */</em>
<a name="46" href="#46">46</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> MAX_PORT_NUMBER = 49151;
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a> <em>/**<em>*</em></em>
<a name="49" href="#49">49</a> <em> * Creates a new instance.</em>
<a name="50" href="#50">50</a> <em> */</em>
<a name="51" href="#51">51</a> <strong>private</strong> <a href="../../../../org/apache/mina/util/AvailablePortFinder.html">AvailablePortFinder</a>()
<a name="52" href="#52">52</a> {
<a name="53" href="#53">53</a> }
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <em>/**<em>*</em></em>
<a name="56" href="#56">56</a> <em> * Returns the {@link Set} of currently available port numbers</em>
<a name="57" href="#57">57</a> <em> * ({@link Integer}). This method is identical to</em>
<a name="58" href="#58">58</a> <em> * &lt;code>getAvailablePorts(MIN_PORT_NUMBER, MAX_PORT_NUMBER)&lt;/code>.</em>
<a name="59" href="#59">59</a> <em> *</em>
<a name="60" href="#60">60</a> <em> * WARNING: this can take a very long time.</em>
<a name="61" href="#61">61</a> <em> */</em>
<a name="62" href="#62">62</a> <strong>public</strong> <strong>static</strong> Set getAvailablePorts()
<a name="63" href="#63">63</a> {
<a name="64" href="#64">64</a> <strong>return</strong> getAvailablePorts(MIN_PORT_NUMBER, MAX_PORT_NUMBER);
<a name="65" href="#65">65</a> }
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <em>/**<em>*</em></em>
<a name="68" href="#68">68</a> <em> * Gets the next available port starting at the lowest port number.</em>
<a name="69" href="#69">69</a> <em> *</em>
<a name="70" href="#70">70</a> <em> * @throws NoSuchElementException if there are no ports available</em>
<a name="71" href="#71">71</a> <em> */</em>
<a name="72" href="#72">72</a> <strong>public</strong> <strong>static</strong> <strong>int</strong> getNextAvailable()
<a name="73" href="#73">73</a> {
<a name="74" href="#74">74</a> <strong>return</strong> getNextAvailable(MIN_PORT_NUMBER);
<a name="75" href="#75">75</a> }
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <em>/**<em>*</em></em>
<a name="78" href="#78">78</a> <em> * Gets the next available port starting at a port.</em>
<a name="79" href="#79">79</a> <em> *</em>
<a name="80" href="#80">80</a> <em> * @param fromPort the port to scan for availability</em>
<a name="81" href="#81">81</a> <em> * @throws NoSuchElementException if there are no ports available</em>
<a name="82" href="#82">82</a> <em> */</em>
<a name="83" href="#83">83</a> <strong>public</strong> <strong>static</strong> <strong>int</strong> getNextAvailable(<strong>int</strong> fromPort)
<a name="84" href="#84">84</a> {
<a name="85" href="#85">85</a> <strong>if</strong> ((fromPort &lt; MIN_PORT_NUMBER) || (fromPort > MAX_PORT_NUMBER))
<a name="86" href="#86">86</a> {
<a name="87" href="#87">87</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid start port: "</span>
<a name="88" href="#88">88</a> + fromPort);
<a name="89" href="#89">89</a> }
<a name="90" href="#90">90</a>
<a name="91" href="#91">91</a> <strong>for</strong> (<strong>int</strong> i = fromPort; i &lt;= MAX_PORT_NUMBER; i++)
<a name="92" href="#92">92</a> {
<a name="93" href="#93">93</a> ServerSocket ss = <strong>null</strong>;
<a name="94" href="#94">94</a> DatagramSocket ds = <strong>null</strong>;
<a name="95" href="#95">95</a> <strong>try</strong>
<a name="96" href="#96">96</a> {
<a name="97" href="#97">97</a> ss = <strong>new</strong> ServerSocket(i);
<a name="98" href="#98">98</a> ds = <strong>new</strong> DatagramSocket(i);
<a name="99" href="#99">99</a> <strong>return</strong> i;
<a name="100" href="#100">100</a> }
<a name="101" href="#101">101</a> <strong>catch</strong> (IOException e)
<a name="102" href="#102">102</a> {
<a name="103" href="#103">103</a> }
<a name="104" href="#104">104</a> <strong>finally</strong>
<a name="105" href="#105">105</a> {
<a name="106" href="#106">106</a> <strong>if</strong> (ds != <strong>null</strong>)
<a name="107" href="#107">107</a> {
<a name="108" href="#108">108</a> ds.close();
<a name="109" href="#109">109</a> }
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <strong>if</strong> (ss != <strong>null</strong>)
<a name="112" href="#112">112</a> {
<a name="113" href="#113">113</a> <strong>try</strong>
<a name="114" href="#114">114</a> {
<a name="115" href="#115">115</a> ss.close();
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a> <strong>catch</strong> (IOException e)
<a name="118" href="#118">118</a> {
<a name="119" href="#119">119</a> <em class="comment">/*<em class="comment"> should not be thrown */</em></em>
<a name="120" href="#120">120</a> }
<a name="121" href="#121">121</a> }
<a name="122" href="#122">122</a> }
<a name="123" href="#123">123</a> }
<a name="124" href="#124">124</a>
<a name="125" href="#125">125</a> <strong>throw</strong> <strong>new</strong> NoSuchElementException(<span class="string">"Could not find an available port "</span>
<a name="126" href="#126">126</a> + <span class="string">"above "</span> + fromPort);
<a name="127" href="#127">127</a> }
<a name="128" href="#128">128</a>
<a name="129" href="#129">129</a> <em>/**<em>*</em></em>
<a name="130" href="#130">130</a> <em> * Checks to see if a specific port is available.</em>
<a name="131" href="#131">131</a> <em> *</em>
<a name="132" href="#132">132</a> <em> * @param port the port to check for availability</em>
<a name="133" href="#133">133</a> <em> */</em>
<a name="134" href="#134">134</a> <strong>public</strong> <strong>static</strong> <strong>boolean</strong> available( <strong>int</strong> port )
<a name="135" href="#135">135</a> {
<a name="136" href="#136">136</a> <strong>if</strong> ( ( port &lt; MIN_PORT_NUMBER) || ( port > MAX_PORT_NUMBER ) )
<a name="137" href="#137">137</a> {
<a name="138" href="#138">138</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException( <span class="string">"Invalid start port: "</span> + port );
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a>
<a name="141" href="#141">141</a> ServerSocket s = <strong>null</strong>;
<a name="142" href="#142">142</a> <strong>try</strong>
<a name="143" href="#143">143</a> {
<a name="144" href="#144">144</a> s = <strong>new</strong> ServerSocket( port );
<a name="145" href="#145">145</a> <strong>return</strong> <strong>true</strong>;
<a name="146" href="#146">146</a> }
<a name="147" href="#147">147</a> <strong>catch</strong> ( IOException e )
<a name="148" href="#148">148</a> {
<a name="149" href="#149">149</a> <strong>return</strong> false;
<a name="150" href="#150">150</a> }
<a name="151" href="#151">151</a> <strong>finally</strong>
<a name="152" href="#152">152</a> {
<a name="153" href="#153">153</a> <strong>if</strong> ( s != <strong>null</strong> )
<a name="154" href="#154">154</a> {
<a name="155" href="#155">155</a> <strong>try</strong>
<a name="156" href="#156">156</a> {
<a name="157" href="#157">157</a> s.close();
<a name="158" href="#158">158</a> }
<a name="159" href="#159">159</a> <strong>catch</strong> (IOException e)
<a name="160" href="#160">160</a> {
<a name="161" href="#161">161</a> <em class="comment">/*<em class="comment"> should not be thrown */</em></em>
<a name="162" href="#162">162</a> }
<a name="163" href="#163">163</a> }
<a name="164" href="#164">164</a> }
<a name="165" href="#165">165</a> }
<a name="166" href="#166">166</a>
<a name="167" href="#167">167</a> <em>/**<em>*</em></em>
<a name="168" href="#168">168</a> <em> * Returns the {@link Set} of currently avaliable port numbers ({@link Integer})</em>
<a name="169" href="#169">169</a> <em> * between the specified port range.</em>
<a name="170" href="#170">170</a> <em> *</em>
<a name="171" href="#171">171</a> <em> * @throws IllegalArgumentException if port range is not between</em>
<a name="172" href="#172">172</a> <em> * {@link #MIN_PORT_NUMBER} and {@link #MAX_PORT_NUMBER} or</em>
<a name="173" href="#173">173</a> <em> * &lt;code>fromPort&lt;/code> if greater than &lt;code>toPort&lt;/code>.</em>
<a name="174" href="#174">174</a> <em> */</em>
<a name="175" href="#175">175</a> <strong>public</strong> <strong>static</strong> Set getAvailablePorts(<strong>int</strong> fromPort, <strong>int</strong> toPort)
<a name="176" href="#176">176</a> {
<a name="177" href="#177">177</a> <strong>if</strong> (
<a name="178" href="#178">178</a> (fromPort &lt; MIN_PORT_NUMBER) || (toPort > MAX_PORT_NUMBER)
<a name="179" href="#179">179</a> || (fromPort > toPort))
<a name="180" href="#180">180</a> {
<a name="181" href="#181">181</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid port range: "</span>
<a name="182" href="#182">182</a> + fromPort + <span class="string">" ~ "</span> + toPort);
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> Set result = <strong>new</strong> TreeSet();
<a name="186" href="#186">186</a>
<a name="187" href="#187">187</a> <strong>for</strong> (<strong>int</strong> i = fromPort; i &lt;= toPort; i++)
<a name="188" href="#188">188</a> {
<a name="189" href="#189">189</a> ServerSocket s = <strong>null</strong>;
<a name="190" href="#190">190</a>
<a name="191" href="#191">191</a> <strong>try</strong>
<a name="192" href="#192">192</a> {
<a name="193" href="#193">193</a> s = <strong>new</strong> ServerSocket(i);
<a name="194" href="#194">194</a> result.add(<strong>new</strong> Integer(i));
<a name="195" href="#195">195</a> }
<a name="196" href="#196">196</a> <strong>catch</strong> (IOException e)
<a name="197" href="#197">197</a> {
<a name="198" href="#198">198</a> }
<a name="199" href="#199">199</a> <strong>finally</strong>
<a name="200" href="#200">200</a> {
<a name="201" href="#201">201</a> <strong>if</strong> (s != <strong>null</strong>)
<a name="202" href="#202">202</a> {
<a name="203" href="#203">203</a> <strong>try</strong>
<a name="204" href="#204">204</a> {
<a name="205" href="#205">205</a> s.close();
<a name="206" href="#206">206</a> }
<a name="207" href="#207">207</a> <strong>catch</strong> (IOException e)
<a name="208" href="#208">208</a> {
<a name="209" href="#209">209</a> <em class="comment">/*<em class="comment"> should not be thrown */</em></em>
<a name="210" href="#210">210</a> }
<a name="211" href="#211">211</a> }
<a name="212" href="#212">212</a> }
<a name="213" href="#213">213</a> }
<a name="214" href="#214">214</a>
<a name="215" href="#215">215</a> <strong>return</strong> result;
<a name="216" href="#216">216</a> }
<a name="217" href="#217">217</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>