blob: 21af05aa8375f911e65a69f72e95f1fb28ad6c78 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.ipc, class: NettyRpcClient">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.ipc;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.net.SocketAddress;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Collections;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.Map;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.concurrent.atomic.AtomicReference;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.MetricsConnection;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.exceptions.X509Exception;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.io.FileChangeWatcher;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.io.crypto.tls.X509Util;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.util.Pair;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hbase.thirdparty.io.netty.channel.Channel;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hbase.thirdparty.io.netty.channel.EventLoopGroup;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hbase.thirdparty.io.netty.channel.nio.NioEventLoopGroup;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.io.netty.channel.socket.nio.NioSocketChannel;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.io.netty.handler.ssl.SslContext;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.io.netty.util.concurrent.DefaultThreadFactory;</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42">/**</span>
<span class="source-line-no">043</span><span id="line-43"> * Netty client for the requests and responses.</span>
<span class="source-line-no">044</span><span id="line-44"> * @since 2.0.0</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)</span>
<span class="source-line-no">047</span><span id="line-47">public class NettyRpcClient extends AbstractRpcClient&lt;NettyRpcConnection&gt; {</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> final EventLoopGroup group;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> final Class&lt;? extends Channel&gt; channelClass;</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> private final boolean shutdownGroupWhenClose;</span>
<span class="source-line-no">054</span><span id="line-54"> private final AtomicReference&lt;SslContext&gt; sslContextForClient = new AtomicReference&lt;&gt;();</span>
<span class="source-line-no">055</span><span id="line-55"> private final AtomicReference&lt;FileChangeWatcher&gt; keyStoreWatcher = new AtomicReference&lt;&gt;();</span>
<span class="source-line-no">056</span><span id="line-56"> private final AtomicReference&lt;FileChangeWatcher&gt; trustStoreWatcher = new AtomicReference&lt;&gt;();</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> public NettyRpcClient(Configuration configuration, String clusterId, SocketAddress localAddress,</span>
<span class="source-line-no">059</span><span id="line-59"> MetricsConnection metrics) {</span>
<span class="source-line-no">060</span><span id="line-60"> this(configuration, clusterId, localAddress, metrics, Collections.emptyMap());</span>
<span class="source-line-no">061</span><span id="line-61"> }</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> public NettyRpcClient(Configuration configuration, String clusterId, SocketAddress localAddress,</span>
<span class="source-line-no">064</span><span id="line-64"> MetricsConnection metrics, Map&lt;String, byte[]&gt; connectionAttributes) {</span>
<span class="source-line-no">065</span><span id="line-65"> super(configuration, clusterId, localAddress, metrics, connectionAttributes);</span>
<span class="source-line-no">066</span><span id="line-66"> Pair&lt;EventLoopGroup, Class&lt;? extends Channel&gt;&gt; groupAndChannelClass =</span>
<span class="source-line-no">067</span><span id="line-67"> NettyRpcClientConfigHelper.getEventLoopConfig(conf);</span>
<span class="source-line-no">068</span><span id="line-68"> if (groupAndChannelClass == null) {</span>
<span class="source-line-no">069</span><span id="line-69"> // Use our own EventLoopGroup.</span>
<span class="source-line-no">070</span><span id="line-70"> int threadCount =</span>
<span class="source-line-no">071</span><span id="line-71"> conf.getInt(NettyRpcClientConfigHelper.HBASE_NETTY_EVENTLOOP_RPCCLIENT_THREADCOUNT_KEY, 0);</span>
<span class="source-line-no">072</span><span id="line-72"> this.group = new NioEventLoopGroup(threadCount,</span>
<span class="source-line-no">073</span><span id="line-73"> new DefaultThreadFactory("RPCClient(own)-NioEventLoopGroup", true, Thread.NORM_PRIORITY));</span>
<span class="source-line-no">074</span><span id="line-74"> this.channelClass = NioSocketChannel.class;</span>
<span class="source-line-no">075</span><span id="line-75"> this.shutdownGroupWhenClose = true;</span>
<span class="source-line-no">076</span><span id="line-76"> } else {</span>
<span class="source-line-no">077</span><span id="line-77"> this.group = groupAndChannelClass.getFirst();</span>
<span class="source-line-no">078</span><span id="line-78"> this.channelClass = groupAndChannelClass.getSecond();</span>
<span class="source-line-no">079</span><span id="line-79"> this.shutdownGroupWhenClose = false;</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> /** Used in test only. */</span>
<span class="source-line-no">084</span><span id="line-84"> public NettyRpcClient(Configuration configuration) {</span>
<span class="source-line-no">085</span><span id="line-85"> this(configuration, HConstants.CLUSTER_ID_DEFAULT, null, null, Collections.emptyMap());</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"></span>
<span class="source-line-no">088</span><span id="line-88"> @Override</span>
<span class="source-line-no">089</span><span id="line-89"> protected NettyRpcConnection createConnection(ConnectionId remoteId) throws IOException {</span>
<span class="source-line-no">090</span><span id="line-90"> return new NettyRpcConnection(this, remoteId);</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> @Override</span>
<span class="source-line-no">094</span><span id="line-94"> protected void closeInternal() {</span>
<span class="source-line-no">095</span><span id="line-95"> if (shutdownGroupWhenClose) {</span>
<span class="source-line-no">096</span><span id="line-96"> group.shutdownGracefully();</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> FileChangeWatcher ks = keyStoreWatcher.getAndSet(null);</span>
<span class="source-line-no">099</span><span id="line-99"> if (ks != null) {</span>
<span class="source-line-no">100</span><span id="line-100"> ks.stop();</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"> FileChangeWatcher ts = trustStoreWatcher.getAndSet(null);</span>
<span class="source-line-no">103</span><span id="line-103"> if (ts != null) {</span>
<span class="source-line-no">104</span><span id="line-104"> ts.stop();</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> SslContext getSslContext() throws X509Exception, IOException {</span>
<span class="source-line-no">109</span><span id="line-109"> SslContext result = sslContextForClient.get();</span>
<span class="source-line-no">110</span><span id="line-110"> if (result == null) {</span>
<span class="source-line-no">111</span><span id="line-111"> result = X509Util.createSslContextForClient(conf);</span>
<span class="source-line-no">112</span><span id="line-112"> if (!sslContextForClient.compareAndSet(null, result)) {</span>
<span class="source-line-no">113</span><span id="line-113"> // lost the race, another thread already set the value</span>
<span class="source-line-no">114</span><span id="line-114"> result = sslContextForClient.get();</span>
<span class="source-line-no">115</span><span id="line-115"> } else if (</span>
<span class="source-line-no">116</span><span id="line-116"> keyStoreWatcher.get() == null &amp;&amp; trustStoreWatcher.get() == null</span>
<span class="source-line-no">117</span><span id="line-117"> &amp;&amp; conf.getBoolean(X509Util.TLS_CERT_RELOAD, false)</span>
<span class="source-line-no">118</span><span id="line-118"> ) {</span>
<span class="source-line-no">119</span><span id="line-119"> X509Util.enableCertFileReloading(conf, keyStoreWatcher, trustStoreWatcher,</span>
<span class="source-line-no">120</span><span id="line-120"> () -&gt; sslContextForClient.set(null));</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"> return result;</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125">}</span>
</pre>
</div>
</main>
</body>
</html>