blob: 34a9b4cb0ea922d87997dd02fa6e007bca854dd1 [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.replication.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.TableName;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.client.AsyncConnection;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Implementations are installed on a Replication Sink called from inside<a name="line.27"></a>
<span class="sourceLineNo">028</span> * ReplicationSink#replicateEntries to filter replicated WALEntries based off WALEntry attributes.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Currently only table name and replication write time are exposed (WALEntry is a private,<a name="line.29"></a>
<span class="sourceLineNo">030</span> * internal class so we cannot pass it here). To install, set<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;code&gt;hbase.replication.sink.walentryfilter&lt;/code&gt; to the name of the implementing<a name="line.31"></a>
<span class="sourceLineNo">032</span> * class. Implementing class must have a no-param Constructor.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;This filter is of limited use. It is better to filter on the replication source rather than<a name="line.33"></a>
<span class="sourceLineNo">034</span> * here after the edits have been shipped on the replication sink. That said, applications such<a name="line.34"></a>
<span class="sourceLineNo">035</span> * as the hbase-indexer want to filter out any edits that were made before replication was enabled.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @see org.apache.hadoop.hbase.replication.WALEntryFilter for filtering on the replication<a name="line.36"></a>
<span class="sourceLineNo">037</span> * source-side.<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)<a name="line.39"></a>
<span class="sourceLineNo">040</span>@InterfaceStability.Evolving<a name="line.40"></a>
<span class="sourceLineNo">041</span>public interface WALEntrySinkFilter {<a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Name of configuration to set with name of implementing WALEntrySinkFilter class.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> public static final String WAL_ENTRY_FILTER_KEY = "hbase.replication.sink.walentrysinkfilter";<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> * Called after Construction.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Use passed Connection to keep any context the filter might need.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> void init(AsyncConnection conn);<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param table Table edit is destined for.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param writeTime Time at which the edit was created on the source.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @return True if we are to filter out the edit.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> boolean filter(TableName table, long writeTime);<a name="line.58"></a>
<span class="sourceLineNo">059</span>}<a name="line.59"></a>
</pre>
</div>
</body>
</html>