blob: cb0cd24a2263d26ad8dc373a8c235d6f419ee600 [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.namequeues, class: LogEventHandler">
<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.namequeues;</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 com.lmax.disruptor.EventHandler;</span>
<span class="source-line-no">021</span><span id="line-21">import com.lmax.disruptor.RingBuffer;</span>
<span class="source-line-no">022</span><span id="line-22">import java.lang.reflect.InvocationTargetException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.HashMap;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Map;</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.client.Connection;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.namequeues.request.NamedQueueGetRequest;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.namequeues.response.NamedQueueGetResponse;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">030</span><span id="line-30">import org.slf4j.Logger;</span>
<span class="source-line-no">031</span><span id="line-31">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">/**</span>
<span class="source-line-no">034</span><span id="line-34"> * Event Handler run by disruptor ringbuffer consumer. Although this is generic implementation for</span>
<span class="source-line-no">035</span><span id="line-35"> * namedQueue, it can have individual queue specific logic.</span>
<span class="source-line-no">036</span><span id="line-36"> */</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span>
<span class="source-line-no">038</span><span id="line-38">class LogEventHandler implements EventHandler&lt;RingBufferEnvelope&gt; {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> private static final Logger LOG = LoggerFactory.getLogger(LogEventHandler.class);</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> // Map that binds namedQueues to corresponding queue service implementation.</span>
<span class="source-line-no">043</span><span id="line-43"> // If NamedQueue of specific type is enabled, corresponding service will be used to</span>
<span class="source-line-no">044</span><span id="line-44"> // insert and retrieve records.</span>
<span class="source-line-no">045</span><span id="line-45"> // Individual queue sizes should be determined based on their individual configs within</span>
<span class="source-line-no">046</span><span id="line-46"> // each service.</span>
<span class="source-line-no">047</span><span id="line-47"> private final Map&lt;NamedQueuePayload.NamedQueueEvent, NamedQueueService&gt; namedQueueServices =</span>
<span class="source-line-no">048</span><span id="line-48"> new HashMap&lt;&gt;();</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> private static final String NAMED_QUEUE_PROVIDER_CLASSES = "hbase.namedqueue.provider.classes";</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> LogEventHandler(final Configuration conf) {</span>
<span class="source-line-no">053</span><span id="line-53"> for (String implName : conf.getStringCollection(NAMED_QUEUE_PROVIDER_CLASSES)) {</span>
<span class="source-line-no">054</span><span id="line-54"> Class&lt;?&gt; clz;</span>
<span class="source-line-no">055</span><span id="line-55"> try {</span>
<span class="source-line-no">056</span><span id="line-56"> clz = Class.forName(implName);</span>
<span class="source-line-no">057</span><span id="line-57"> } catch (ClassNotFoundException e) {</span>
<span class="source-line-no">058</span><span id="line-58"> LOG.warn("Failed to find NamedQueueService implementor class {}", implName, e);</span>
<span class="source-line-no">059</span><span id="line-59"> continue;</span>
<span class="source-line-no">060</span><span id="line-60"> }</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> if (!NamedQueueService.class.isAssignableFrom(clz)) {</span>
<span class="source-line-no">063</span><span id="line-63"> LOG.warn("Class {} is not implementor of NamedQueueService.", clz);</span>
<span class="source-line-no">064</span><span id="line-64"> continue;</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> // add all service mappings here</span>
<span class="source-line-no">068</span><span id="line-68"> try {</span>
<span class="source-line-no">069</span><span id="line-69"> NamedQueueService namedQueueService =</span>
<span class="source-line-no">070</span><span id="line-70"> (NamedQueueService) clz.getConstructor(Configuration.class).newInstance(conf);</span>
<span class="source-line-no">071</span><span id="line-71"> namedQueueServices.put(namedQueueService.getEvent(), namedQueueService);</span>
<span class="source-line-no">072</span><span id="line-72"> } catch (InstantiationException | IllegalAccessException | NoSuchMethodException</span>
<span class="source-line-no">073</span><span id="line-73"> | InvocationTargetException e) {</span>
<span class="source-line-no">074</span><span id="line-74"> LOG.warn("Unable to instantiate/add NamedQueueService implementor {} to service map.", clz,</span>
<span class="source-line-no">075</span><span id="line-75"> e);</span>
<span class="source-line-no">076</span><span id="line-76"> }</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> /**</span>
<span class="source-line-no">081</span><span id="line-81"> * Called when a publisher has published an event to the {@link RingBuffer}. This is generic</span>
<span class="source-line-no">082</span><span id="line-82"> * consumer of disruptor ringbuffer and for each new namedQueue that we add, we should also</span>
<span class="source-line-no">083</span><span id="line-83"> * provide specific consumer logic here.</span>
<span class="source-line-no">084</span><span id="line-84"> * @param event published to the {@link RingBuffer}</span>
<span class="source-line-no">085</span><span id="line-85"> * @param sequence of the event being processed</span>
<span class="source-line-no">086</span><span id="line-86"> * @param endOfBatch flag to indicate if this is the last event in a batch from the</span>
<span class="source-line-no">087</span><span id="line-87"> * {@link RingBuffer}</span>
<span class="source-line-no">088</span><span id="line-88"> */</span>
<span class="source-line-no">089</span><span id="line-89"> @Override</span>
<span class="source-line-no">090</span><span id="line-90"> public void onEvent(RingBufferEnvelope event, long sequence, boolean endOfBatch) {</span>
<span class="source-line-no">091</span><span id="line-91"> final NamedQueuePayload namedQueuePayload = event.getPayload();</span>
<span class="source-line-no">092</span><span id="line-92"> // consume ringbuffer payload based on event type</span>
<span class="source-line-no">093</span><span id="line-93"> namedQueueServices.get(namedQueuePayload.getNamedQueueEvent())</span>
<span class="source-line-no">094</span><span id="line-94"> .consumeEventFromDisruptor(namedQueuePayload);</span>
<span class="source-line-no">095</span><span id="line-95"> }</span>
<span class="source-line-no">096</span><span id="line-96"></span>
<span class="source-line-no">097</span><span id="line-97"> /**</span>
<span class="source-line-no">098</span><span id="line-98"> * Cleans up queues maintained by services.</span>
<span class="source-line-no">099</span><span id="line-99"> * @param namedQueueEvent type of queue to clear</span>
<span class="source-line-no">100</span><span id="line-100"> * @return true if queue is cleaned up, false otherwise</span>
<span class="source-line-no">101</span><span id="line-101"> */</span>
<span class="source-line-no">102</span><span id="line-102"> boolean clearNamedQueue(NamedQueuePayload.NamedQueueEvent namedQueueEvent) {</span>
<span class="source-line-no">103</span><span id="line-103"> return namedQueueServices.get(namedQueueEvent).clearNamedQueue();</span>
<span class="source-line-no">104</span><span id="line-104"> }</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"> * Add all in memory queue records to system table. The implementors can use system table or</span>
<span class="source-line-no">108</span><span id="line-108"> * direct HDFS file or ZK as persistence system.</span>
<span class="source-line-no">109</span><span id="line-109"> */</span>
<span class="source-line-no">110</span><span id="line-110"> void persistAll(NamedQueuePayload.NamedQueueEvent namedQueueEvent, Connection connection) {</span>
<span class="source-line-no">111</span><span id="line-111"> namedQueueServices.get(namedQueueEvent).persistAll(connection);</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> /**</span>
<span class="source-line-no">115</span><span id="line-115"> * Retrieve in memory queue records from ringbuffer</span>
<span class="source-line-no">116</span><span id="line-116"> * @param request namedQueue request with event type</span>
<span class="source-line-no">117</span><span id="line-117"> * @return queue records from ringbuffer after filter (if applied)</span>
<span class="source-line-no">118</span><span id="line-118"> */</span>
<span class="source-line-no">119</span><span id="line-119"> NamedQueueGetResponse getNamedQueueRecords(NamedQueueGetRequest request) {</span>
<span class="source-line-no">120</span><span id="line-120"> return namedQueueServices.get(request.getNamedQueueEvent()).getNamedQueueRecords(request);</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">}</span>
</pre>
</div>
</main>
</body>
</html>