Google Git
Sign in
apache / hbase-site / 6be7f1c569b0f0f64151e4687d98bbf050cb369a / . / devapidocs / src-html / org / apache / hadoop / hbase / util / Addressing.html
blob: ebb6dd85b756fe188643a3467c6031bd6dea7730 [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, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.util;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.Inet4Address;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.Inet6Address;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.InetSocketAddress;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.NetworkInterface;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.SocketException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Enumeration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Utility for network addresses, resolving and naming.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class Addressing {<a name="line.33"></a>
<span class="sourceLineNo">034</span> public static final String VALID_PORT_REGEX = "[\\d]+";<a name="line.34"></a>
<span class="sourceLineNo">035</span> public static final String HOSTNAME_PORT_SEPARATOR = ":";<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> * Create a socket address<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param hostAndPort Formatted as &lt;code&gt;&amp;lt;hostname&amp;gt; ':' &amp;lt;port&amp;gt;&lt;/code&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @return An InetSocketInstance<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> public static InetSocketAddress<a name="line.42"></a>
<span class="sourceLineNo">043</span> createInetSocketAddressFromHostAndPortStr(final String hostAndPort) {<a name="line.43"></a>
<span class="sourceLineNo">044</span> return new InetSocketAddress(parseHostname(hostAndPort), parsePort(hostAndPort));<a name="line.44"></a>
<span class="sourceLineNo">045</span> }<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Create a host-and-port string<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param hostname Server hostname<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param port Server port<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return Returns a concatenation of &lt;code&gt;hostname&lt;/code&gt; and &lt;code&gt;port&lt;/code&gt; in following<a name="line.51"></a>
<span class="sourceLineNo">052</span> * form: &lt;code&gt;&amp;lt;hostname&amp;gt; ':' &amp;lt;port&amp;gt;&lt;/code&gt;. For example, if hostname is<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;code&gt;example.org&lt;/code&gt; and port is 1234, this method will return<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;code&gt;example.org:1234&lt;/code&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> public static String createHostAndPortStr(final String hostname, final int port) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> return hostname + HOSTNAME_PORT_SEPARATOR + port;<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Parse the hostname portion of a host-and-port string<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param hostAndPort Formatted as &lt;code&gt;&amp;lt;hostname&amp;gt; ':' &amp;lt;port&amp;gt;&lt;/code&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @return The hostname portion of &lt;code&gt;hostAndPort&lt;/code&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public static String parseHostname(final String hostAndPort) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> int colonIndex = hostAndPort.lastIndexOf(HOSTNAME_PORT_SEPARATOR);<a name="line.66"></a>
<span class="sourceLineNo">067</span> if (colonIndex &lt; 0) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> throw new IllegalArgumentException("Not a host:port pair: " + hostAndPort);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> return hostAndPort.substring(0, colonIndex);<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Parse the port portion of a host-and-port string<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param hostAndPort Formatted as &lt;code&gt;&amp;lt;hostname&amp;gt; ':' &amp;lt;port&amp;gt;&lt;/code&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @return The port portion of &lt;code&gt;hostAndPort&lt;/code&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> public static int parsePort(final String hostAndPort) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> int colonIndex = hostAndPort.lastIndexOf(HOSTNAME_PORT_SEPARATOR);<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (colonIndex &lt; 0) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> throw new IllegalArgumentException("Not a host:port pair: " + hostAndPort);<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> return Integer.parseInt(hostAndPort.substring(colonIndex + 1));<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> public static InetAddress getIpAddress() throws SocketException {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return getIpAddress(new AddressSelectionCondition() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> @Override<a name="line.88"></a>
<span class="sourceLineNo">089</span> public boolean isAcceptableAddress(InetAddress addr) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> return addr instanceof Inet4Address || addr instanceof Inet6Address;<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> });<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> public static InetAddress getIp4Address() throws SocketException {<a name="line.95"></a>
<span class="sourceLineNo">096</span> return getIpAddress(new AddressSelectionCondition() {<a name="line.96"></a>
<span class="sourceLineNo">097</span> @Override<a name="line.97"></a>
<span class="sourceLineNo">098</span> public boolean isAcceptableAddress(InetAddress addr) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return addr instanceof Inet4Address;<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> });<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> public static InetAddress getIp6Address() throws SocketException {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return getIpAddress(new AddressSelectionCondition() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public boolean isAcceptableAddress(InetAddress addr) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return addr instanceof Inet6Address;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> });<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> private static InetAddress getIpAddress(AddressSelectionCondition condition)<a name="line.113"></a>
<span class="sourceLineNo">114</span> throws SocketException {<a name="line.114"></a>
<span class="sourceLineNo">115</span> // Before we connect somewhere, we cannot be sure about what we'd be bound to; however,<a name="line.115"></a>
<span class="sourceLineNo">116</span> // we only connect when the message where client ID is, is long constructed. Thus,<a name="line.116"></a>
<span class="sourceLineNo">117</span> // just use whichever IP address we can find.<a name="line.117"></a>
<span class="sourceLineNo">118</span> Enumeration&lt;NetworkInterface&gt; interfaces = NetworkInterface.getNetworkInterfaces();<a name="line.118"></a>
<span class="sourceLineNo">119</span> while (interfaces.hasMoreElements()) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> NetworkInterface current = interfaces.nextElement();<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (!current.isUp() || current.isLoopback() || current.isVirtual()) continue;<a name="line.121"></a>
<span class="sourceLineNo">122</span> Enumeration&lt;InetAddress&gt; addresses = current.getInetAddresses();<a name="line.122"></a>
<span class="sourceLineNo">123</span> while (addresses.hasMoreElements()) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> InetAddress addr = addresses.nextElement();<a name="line.124"></a>
<span class="sourceLineNo">125</span> if (addr.isLoopbackAddress()) continue;<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (condition.isAcceptableAddress(addr)) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return addr;<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> throw new SocketException("Can't get our ip address, interfaces are: " + interfaces);<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Given an InetAddress, checks to see if the address is a local address, by comparing the address<a name="line.136"></a>
<span class="sourceLineNo">137</span> * with all the interfaces on the node.<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @param addr address to check if it is local node's address<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @return true if the address corresponds to the local node<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public static boolean isLocalAddress(InetAddress addr) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> // Check if the address is any local or loop back<a name="line.142"></a>
<span class="sourceLineNo">143</span> boolean local = addr.isAnyLocalAddress() || addr.isLoopbackAddress();<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> // Check if the address is defined on any interface<a name="line.145"></a>
<span class="sourceLineNo">146</span> if (!local) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> try {<a name="line.147"></a>
<span class="sourceLineNo">148</span> local = NetworkInterface.getByInetAddress(addr) != null;<a name="line.148"></a>
<span class="sourceLineNo">149</span> } catch (SocketException e) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> local = false;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> return local;<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
<span class="sourceLineNo">157</span> * Given an InetSocketAddress object returns a String represent of it. This is a util method for<a name="line.157"></a>
<span class="sourceLineNo">158</span> * Java 17. The toString() function of InetSocketAddress will flag the unresolved address with a<a name="line.158"></a>
<span class="sourceLineNo">159</span> * substring in the string, which will result in unexpected problem. We should use this util<a name="line.159"></a>
<span class="sourceLineNo">160</span> * function to get the string when we not sure whether the input address is resolved or not.<a name="line.160"></a>
<span class="sourceLineNo">161</span> * @param address address to convert to a "host:port" String.<a name="line.161"></a>
<span class="sourceLineNo">162</span> * @return the String represent of the given address, like "foo:1234".<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> public static String inetSocketAddress2String(InetSocketAddress address) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return address.isUnresolved()<a name="line.165"></a>
<span class="sourceLineNo">166</span> ? address.toString().replace("/&lt;unresolved&gt;", "")<a name="line.166"></a>
<span class="sourceLineNo">167</span> : address.toString();<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> /** Interface for AddressSelectionCondition to check if address is acceptable */<a name="line.170"></a>
<span class="sourceLineNo">171</span> public interface AddressSelectionCondition {<a name="line.171"></a>
<span class="sourceLineNo">172</span> /**<a name="line.172"></a>
<span class="sourceLineNo">173</span> * Condition on which to accept inet address<a name="line.173"></a>
<span class="sourceLineNo">174</span> * @param address to check<a name="line.174"></a>
<span class="sourceLineNo">175</span> * @return true to accept this address<a name="line.175"></a>
<span class="sourceLineNo">176</span> */<a name="line.176"></a>
<span class="sourceLineNo">177</span> public boolean isAcceptableAddress(InetAddress address);<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span>}<a name="line.179"></a>
</pre>
</div>
</body>
</html>