Google Git
Sign in
apache / phoenix-omid-site / refs/heads/asf-site / . / xref / org / apache / omid / tso / NetworkInterfaceUtils.html
blob: 69f7f2887b151f3a9a95da64d5fe7b0cc89549dd [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=UTF-8" />
<title>NetworkInterfaceUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../target/site/apidocs/org/apache/omid/tso/NetworkInterfaceUtils.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_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 class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <strong class="jxr_keyword">package</strong> org.apache.omid.tso;
<a class="jxr_linenumber" name="19" href="#19">19</a>
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.phoenix.thirdparty.com.google.common.net.HostAndPort;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="23" href="#23">23</a>
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.net.InetAddress;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.net.NetworkInterface;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.net.SocketException;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.net.UnknownHostException;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a class="jxr_linenumber" name="29" href="#29">29</a>
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/omid/tso/NetworkInterfaceUtils.html">NetworkInterfaceUtils</a> {
<a class="jxr_linenumber" name="31" href="#31">31</a>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(NetworkInterfaceUtils.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Returns an &lt;code&gt;InetAddress&lt;/code&gt; object encapsulating what is most</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * likely the machine's LAN IP address.</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * This method is intended for use as a replacement of JDK method</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * &lt;code&gt;InetAddress.getLocalHost&lt;/code&gt;, because that method is ambiguous</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * on Linux systems. Linux systems enumerate the loopback network</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * interface the same way as regular LAN network interfaces, but the JDK</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * &lt;code&gt;InetAddress.getLocalHost&lt;/code&gt; method does not specify the</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * algorithm used to select the address returned under such circumstances,</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * and will often return the loopback address, which is not valid for</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * network communication. Details</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4665037" target="alexandria_uri">http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4665037</a>"&gt;here&lt;/a&gt;.</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * This method will scan all IP addresses on a particular network interface</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * specified as parameter on the host machine to determine the IP address</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * most likely to be the machine's LAN address. If the machine has multiple</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * IP addresses, this method will prefer a site-local IP address (e.g.</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * 192.168.x.x or 10.10.x.x, usually IPv4) if the machine has one (and will</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * return the first site-local address if the machine has more than one),</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * but if the machine does not hold a site-local address, this method will</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * return simply the first non-loopback address found (IPv4 or IPv6).</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * If this method cannot find a non-loopback address using this selection</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * algorithm, it will fall back to calling and returning the result of JDK</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * method &lt;code&gt;InetAddress.getLocalHost()&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param ifaceName</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * The name of the network interface to extract the IP address</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * from</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @throws UnknownHostException</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * If the LAN address of the machine cannot be found.</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">static</strong> InetAddress getIPAddressFromNetworkInterface(String ifaceName)
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">throws</strong> SocketException, UnknownHostException {
<a class="jxr_linenumber" name="70" href="#70">70</a>
<a class="jxr_linenumber" name="71" href="#71">71</a> NetworkInterface iface = NetworkInterface.getByName(ifaceName);
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> (iface == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a class="jxr_linenumber" name="74" href="#74">74</a> <span class="jxr_string">"Network interface "</span> + ifaceName + <span class="jxr_string">" not found"</span>);
<a class="jxr_linenumber" name="75" href="#75">75</a> }
<a class="jxr_linenumber" name="76" href="#76">76</a>
<a class="jxr_linenumber" name="77" href="#77">77</a> InetAddress candidateAddress = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="78" href="#78">78</a> Enumeration&lt;InetAddress&gt; inetAddrs = iface.getInetAddresses();
<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">while</strong> (inetAddrs.hasMoreElements()) {
<a class="jxr_linenumber" name="80" href="#80">80</a> InetAddress inetAddr = inetAddrs.nextElement();
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (!inetAddr.isLoopbackAddress()) {
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (inetAddr.isSiteLocalAddress()) {
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> inetAddr; <em class="jxr_comment">// Return non-loopback site-local address</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (candidateAddress == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_comment">// Found non-loopback address, but not necessarily site-local</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> candidateAddress = inetAddr;
<a class="jxr_linenumber" name="87" href="#87">87</a> }
<a class="jxr_linenumber" name="88" href="#88">88</a> }
<a class="jxr_linenumber" name="89" href="#89">89</a> }
<a class="jxr_linenumber" name="90" href="#90">90</a>
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (candidateAddress != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_comment">// Site-local address not found, but found other non-loopback addr</em>
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_comment">// Server might have a non-site-local address assigned to its NIC</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_comment">// (or might be running IPv6 which deprecates "site-local" concept)</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">return</strong> candidateAddress;
<a class="jxr_linenumber" name="96" href="#96">96</a> }
<a class="jxr_linenumber" name="97" href="#97">97</a>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_comment">// At this point, we did not find a non-loopback address.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_comment">// Fall back to returning whatever InetAddress.getLocalHost() returns</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> InetAddress jdkSuppliedAddress = InetAddress.getLocalHost();
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (jdkSuppliedAddress == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnknownHostException(
<a class="jxr_linenumber" name="103" href="#103">103</a> <span class="jxr_string">"InetAddress.getLocalHost() unexpectedly returned null."</span>);
<a class="jxr_linenumber" name="104" href="#104">104</a> }
<a class="jxr_linenumber" name="105" href="#105">105</a> <strong class="jxr_keyword">return</strong> jdkSuppliedAddress;
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a>
<a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getTSOHostAndPort(<a href="../../../../org/apache/omid/tso/TSOServerConfig.html">TSOServerConfig</a> config) <strong class="jxr_keyword">throws</strong> SocketException, UnknownHostException {
<a class="jxr_linenumber" name="109" href="#109">109</a>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_comment">// Build TSO host:port string and validate it</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">final</strong> String tsoNetIfaceName = config.getNetworkIfaceName();
<a class="jxr_linenumber" name="112" href="#112">112</a> InetAddress addr = getIPAddressFromNetworkInterface(tsoNetIfaceName);
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> tsoPort = config.getPort();
<a class="jxr_linenumber" name="114" href="#114">114</a>
<a class="jxr_linenumber" name="115" href="#115">115</a> String tsoHostAndPortAsString = <span class="jxr_string">"N/A"</span>;
<a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="117" href="#117">117</a> tsoHostAndPortAsString = HostAndPort.fromParts(addr.getHostAddress(), tsoPort).toString();
<a class="jxr_linenumber" name="118" href="#118">118</a> } <strong class="jxr_keyword">catch</strong> (IllegalArgumentException e) {
<a class="jxr_linenumber" name="119" href="#119">119</a> LOG.error(<span class="jxr_string">"Cannot parse TSO host:port string {}"</span>, tsoHostAndPortAsString);
<a class="jxr_linenumber" name="120" href="#120">120</a> <strong class="jxr_keyword">throw</strong> e;
<a class="jxr_linenumber" name="121" href="#121">121</a> }
<a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">return</strong> tsoHostAndPortAsString;
<a class="jxr_linenumber" name="123" href="#123">123</a>
<a class="jxr_linenumber" name="124" href="#124">124</a> }
<a class="jxr_linenumber" name="125" href="#125">125</a>
<a class="jxr_linenumber" name="126" href="#126">126</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>