| <!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: BufferCallBeforeInitHandler, enum: BufferCallAction"> |
| <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.util.HashMap;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span> |
| <span class="source-line-no">023</span><span id="line-23">import javax.net.ssl.SSLException;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.slf4j.Logger;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.io.netty.channel.ChannelDuplexHandler;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.io.netty.channel.ChannelPromise;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">/**</span> |
| <span class="source-line-no">033</span><span id="line-33"> * We will expose the connection to upper layer before initialized, so we need to buffer the calls</span> |
| <span class="source-line-no">034</span><span id="line-34"> * passed in and write them out once the connection is established.</span> |
| <span class="source-line-no">035</span><span id="line-35"> */</span> |
| <span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Private</span> |
| <span class="source-line-no">037</span><span id="line-37">class BufferCallBeforeInitHandler extends ChannelDuplexHandler {</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39"> private static final Logger LOG = LoggerFactory.getLogger(BufferCallBeforeInitHandler.class);</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> static final String NAME = "BufferCall";</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> private enum BufferCallAction {</span> |
| <span class="source-line-no">044</span><span id="line-44"> FLUSH,</span> |
| <span class="source-line-no">045</span><span id="line-45"> FAIL</span> |
| <span class="source-line-no">046</span><span id="line-46"> }</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> public static final class BufferCallEvent {</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> public final BufferCallAction action;</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> public final IOException error;</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> private BufferCallEvent(BufferCallBeforeInitHandler.BufferCallAction action,</span> |
| <span class="source-line-no">055</span><span id="line-55"> IOException error) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> this.action = action;</span> |
| <span class="source-line-no">057</span><span id="line-57"> this.error = error;</span> |
| <span class="source-line-no">058</span><span id="line-58"> }</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> public static BufferCallBeforeInitHandler.BufferCallEvent success() {</span> |
| <span class="source-line-no">061</span><span id="line-61"> return SUCCESS_EVENT;</span> |
| <span class="source-line-no">062</span><span id="line-62"> }</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> public static BufferCallBeforeInitHandler.BufferCallEvent fail(IOException error) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> return new BufferCallEvent(BufferCallAction.FAIL, error);</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> private static final BufferCallEvent SUCCESS_EVENT =</span> |
| <span class="source-line-no">070</span><span id="line-70"> new BufferCallEvent(BufferCallAction.FLUSH, null);</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> private final Map<Integer, Call> id2Call = new HashMap<>();</span> |
| <span class="source-line-no">073</span><span id="line-73"></span> |
| <span class="source-line-no">074</span><span id="line-74"> @Override</span> |
| <span class="source-line-no">075</span><span id="line-75"> public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> if (msg instanceof Call) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> Call call = (Call) msg;</span> |
| <span class="source-line-no">078</span><span id="line-78"> id2Call.put(call.id, call);</span> |
| <span class="source-line-no">079</span><span id="line-79"> // The call is already in track so here we set the write operation as success.</span> |
| <span class="source-line-no">080</span><span id="line-80"> // We will fail the call directly if we can not write it out.</span> |
| <span class="source-line-no">081</span><span id="line-81"> promise.trySuccess();</span> |
| <span class="source-line-no">082</span><span id="line-82"> } else {</span> |
| <span class="source-line-no">083</span><span id="line-83"> ctx.write(msg, promise);</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> @Override</span> |
| <span class="source-line-no">088</span><span id="line-88"> public void flush(ChannelHandlerContext ctx) throws Exception {</span> |
| <span class="source-line-no">089</span><span id="line-89"> // do not flush anything out</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> @Override</span> |
| <span class="source-line-no">093</span><span id="line-93"> public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {</span> |
| <span class="source-line-no">094</span><span id="line-94"> if (evt instanceof BufferCallEvent) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> BufferCallEvent bcEvt = (BufferCallBeforeInitHandler.BufferCallEvent) evt;</span> |
| <span class="source-line-no">096</span><span id="line-96"> switch (bcEvt.action) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> case FLUSH:</span> |
| <span class="source-line-no">098</span><span id="line-98"> for (Call call : id2Call.values()) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> ctx.write(call);</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"> ctx.flush();</span> |
| <span class="source-line-no">102</span><span id="line-102"> ctx.pipeline().remove(this);</span> |
| <span class="source-line-no">103</span><span id="line-103"> break;</span> |
| <span class="source-line-no">104</span><span id="line-104"> case FAIL:</span> |
| <span class="source-line-no">105</span><span id="line-105"> for (Call call : id2Call.values()) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> call.setException(bcEvt.error);</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"> // here we do not remove us from the pipeline, for receiving possible exceptions and log</span> |
| <span class="source-line-no">109</span><span id="line-109"> // it, especially the ssl exceptions, to prevent it reaching the tail of the pipeline and</span> |
| <span class="source-line-no">110</span><span id="line-110"> // generate a confusing netty WARN</span> |
| <span class="source-line-no">111</span><span id="line-111"> break;</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> } else if (evt instanceof CallEvent) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> // just remove the call for now until we add other call event other than timeout and cancel.</span> |
| <span class="source-line-no">115</span><span id="line-115"> id2Call.remove(((CallEvent) evt).call.id);</span> |
| <span class="source-line-no">116</span><span id="line-116"> } else {</span> |
| <span class="source-line-no">117</span><span id="line-117"> ctx.fireUserEventTriggered(evt);</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> private boolean isSslError(Throwable cause) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> Throwable error = cause;</span> |
| <span class="source-line-no">123</span><span id="line-123"> do {</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (error instanceof SSLException) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> return true;</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> error = error.getCause();</span> |
| <span class="source-line-no">128</span><span id="line-128"> } while (error != null);</span> |
| <span class="source-line-no">129</span><span id="line-129"> return false;</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> @Override</span> |
| <span class="source-line-no">133</span><span id="line-133"> public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {</span> |
| <span class="source-line-no">134</span><span id="line-134"> if (isSslError(cause)) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> // this should have been logged in other places, see HBASE-27782 for more details.</span> |
| <span class="source-line-no">136</span><span id="line-136"> // here we just log it with debug and tell users that this is not a critical problem,</span> |
| <span class="source-line-no">137</span><span id="line-137"> // otherwise if we just pass it through the pipeline, it will lead to a confusing</span> |
| <span class="source-line-no">138</span><span id="line-138"> // "An exceptionCaught() event was fired, and it reached at the tail of the pipeline"</span> |
| <span class="source-line-no">139</span><span id="line-139"> LOG.debug(</span> |
| <span class="source-line-no">140</span><span id="line-140"> "got ssl exception, which should have already been proceeded, log it here to"</span> |
| <span class="source-line-no">141</span><span id="line-141"> + " prevent it being passed to netty's TailContext and trigger a confusing WARN message",</span> |
| <span class="source-line-no">142</span><span id="line-142"> cause);</span> |
| <span class="source-line-no">143</span><span id="line-143"> } else {</span> |
| <span class="source-line-no">144</span><span id="line-144"> ctx.fireExceptionCaught(cause);</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
