blob: 72535c0b6e6e75534a80febd5b521d81a51bacc0 [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 edu.umd.cs.findbugs.annotations.NonNull;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.lang.reflect.Method;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.UnknownHostException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Wrapper around Hadoop's DNS class to hide reflection.<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>@InterfaceAudience.Private<a name="line.30"></a>
<span class="sourceLineNo">031</span>@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "REC_CATCH_EXCEPTION",<a name="line.31"></a>
<span class="sourceLineNo">032</span> justification = "If exception, presume HAS_NEW_DNS_GET_DEFAULT_HOST_API false")<a name="line.32"></a>
<span class="sourceLineNo">033</span>public final class DNS {<a name="line.33"></a>
<span class="sourceLineNo">034</span> // key to the config parameter of server hostname<a name="line.34"></a>
<span class="sourceLineNo">035</span> // the specification of server hostname is optional. The hostname should be resolvable from<a name="line.35"></a>
<span class="sourceLineNo">036</span> // both master and region server<a name="line.36"></a>
<span class="sourceLineNo">037</span> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)<a name="line.37"></a>
<span class="sourceLineNo">038</span> public static final String UNSAFE_RS_HOSTNAME_KEY = "hbase.unsafe.regionserver.hostname";<a name="line.38"></a>
<span class="sourceLineNo">039</span> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)<a name="line.39"></a>
<span class="sourceLineNo">040</span> public static final String MASTER_HOSTNAME_KEY = "hbase.master.hostname";<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private static boolean HAS_NEW_DNS_GET_DEFAULT_HOST_API;<a name="line.42"></a>
<span class="sourceLineNo">043</span> private static Method GET_DEFAULT_HOST_METHOD;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @deprecated since 2.4.0 and will be removed in 4.0.0. Use {@link DNS#UNSAFE_RS_HOSTNAME_KEY}<a name="line.46"></a>
<span class="sourceLineNo">047</span> * instead.<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @see &lt;a href="https://issues.apache.org/jira/browse/HBASE-24667"&gt;HBASE-24667&lt;/a&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> @Deprecated<a name="line.50"></a>
<span class="sourceLineNo">051</span> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)<a name="line.51"></a>
<span class="sourceLineNo">052</span> public static final String RS_HOSTNAME_KEY = "hbase.regionserver.hostname";<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> static {<a name="line.54"></a>
<span class="sourceLineNo">055</span> try {<a name="line.55"></a>
<span class="sourceLineNo">056</span> GET_DEFAULT_HOST_METHOD = org.apache.hadoop.net.DNS.class.getMethod("getDefaultHost",<a name="line.56"></a>
<span class="sourceLineNo">057</span> String.class, String.class, boolean.class);<a name="line.57"></a>
<span class="sourceLineNo">058</span> HAS_NEW_DNS_GET_DEFAULT_HOST_API = true;<a name="line.58"></a>
<span class="sourceLineNo">059</span> } catch (Exception e) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> HAS_NEW_DNS_GET_DEFAULT_HOST_API = false; // FindBugs: Causes REC_CATCH_EXCEPTION. Suppressed<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> public enum ServerType {<a name="line.64"></a>
<span class="sourceLineNo">065</span> MASTER("master"),<a name="line.65"></a>
<span class="sourceLineNo">066</span> REGIONSERVER("regionserver");<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> private String name;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> ServerType(String name) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> this.name = name;<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> public String getName() {<a name="line.74"></a>
<span class="sourceLineNo">075</span> return name;<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> private DNS() {<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Wrapper around DNS.getDefaultHost(String, String), calling DNS.getDefaultHost(String, String,<a name="line.83"></a>
<span class="sourceLineNo">084</span> * boolean) when available.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @param strInterface The network interface to query.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @param nameserver The DNS host name.<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @return The default host names associated with IPs bound to the network interface.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> public static String getDefaultHost(String strInterface, String nameserver)<a name="line.89"></a>
<span class="sourceLineNo">090</span> throws UnknownHostException {<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (HAS_NEW_DNS_GET_DEFAULT_HOST_API) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> try {<a name="line.92"></a>
<span class="sourceLineNo">093</span> // Hadoop-2.8 includes a String, String, boolean variant of getDefaultHost<a name="line.93"></a>
<span class="sourceLineNo">094</span> // which properly handles multi-homed systems with Kerberos.<a name="line.94"></a>
<span class="sourceLineNo">095</span> return (String) GET_DEFAULT_HOST_METHOD.invoke(null, strInterface, nameserver, true);<a name="line.95"></a>
<span class="sourceLineNo">096</span> } catch (Exception e) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> // If we can't invoke the method as it should exist, throw an exception<a name="line.97"></a>
<span class="sourceLineNo">098</span> throw new RuntimeException("Failed to invoke DNS.getDefaultHost via reflection", e);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> } else {<a name="line.100"></a>
<span class="sourceLineNo">101</span> return org.apache.hadoop.net.DNS.getDefaultHost(strInterface, nameserver);<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><a name="line.104"></a>
<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Get the configured hostname for a given ServerType. Gets the default hostname if not specified<a name="line.106"></a>
<span class="sourceLineNo">107</span> * in the configuration.<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @param conf Configuration to look up.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @param serverType ServerType to look up in the configuration for overrides.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> public static String getHostname(@NonNull Configuration conf, @NonNull ServerType serverType)<a name="line.111"></a>
<span class="sourceLineNo">112</span> throws UnknownHostException {<a name="line.112"></a>
<span class="sourceLineNo">113</span> String hostname;<a name="line.113"></a>
<span class="sourceLineNo">114</span> switch (serverType) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> case MASTER:<a name="line.115"></a>
<span class="sourceLineNo">116</span> hostname = conf.get(MASTER_HOSTNAME_KEY);<a name="line.116"></a>
<span class="sourceLineNo">117</span> break;<a name="line.117"></a>
<span class="sourceLineNo">118</span> case REGIONSERVER:<a name="line.118"></a>
<span class="sourceLineNo">119</span> hostname = conf.get(UNSAFE_RS_HOSTNAME_KEY);<a name="line.119"></a>
<span class="sourceLineNo">120</span> break;<a name="line.120"></a>
<span class="sourceLineNo">121</span> default:<a name="line.121"></a>
<span class="sourceLineNo">122</span> hostname = null;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (hostname == null || hostname.isEmpty()) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> return Strings.domainNamePointerToHostName(<a name="line.125"></a>
<span class="sourceLineNo">126</span> getDefaultHost(conf.get("hbase." + serverType.getName() + ".dns.interface", "default"),<a name="line.126"></a>
<span class="sourceLineNo">127</span> conf.get("hbase." + serverType.getName() + ".dns.nameserver", "default")));<a name="line.127"></a>
<span class="sourceLineNo">128</span> } else {<a name="line.128"></a>
<span class="sourceLineNo">129</span> return hostname;<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 name="line.132"></a>
</pre>
</div>
</body>
</html>