| <!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.replication, interface: ReplicationPeer"> |
| <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.replication;</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.util.List;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Set;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * ReplicationPeer manages enabled / disabled state for the peer.</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)</span> |
| <span class="source-line-no">032</span><span id="line-32">public interface ReplicationPeer {</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34"> /**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * State of the peer, whether it is enabled or not</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.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)</span> |
| <span class="source-line-no">038</span><span id="line-38"> enum PeerState {</span> |
| <span class="source-line-no">039</span><span id="line-39"> ENABLED,</span> |
| <span class="source-line-no">040</span><span id="line-40"> DISABLED</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"> /**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Get the identifier of this peer</span> |
| <span class="source-line-no">045</span><span id="line-45"> * @return string representation of the id</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47"> String getId();</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> /**</span> |
| <span class="source-line-no">050</span><span id="line-50"> * Returns the state of the peer by reading local cache.</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @return the enabled state</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53"> PeerState getPeerState();</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /**</span> |
| <span class="source-line-no">056</span><span id="line-56"> * Returns the sync replication state of the peer by reading local cache.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * <p></span> |
| <span class="source-line-no">058</span><span id="line-58"> * If the peer is not a synchronous replication peer, a {@link SyncReplicationState#NONE} will be</span> |
| <span class="source-line-no">059</span><span id="line-59"> * returned.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @return the sync replication state</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> SyncReplicationState getSyncReplicationState();</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * Test whether the peer is enabled.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @return {@code true} if enabled, otherwise {@code false}.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> default boolean isPeerEnabled() {</span> |
| <span class="source-line-no">069</span><span id="line-69"> return getPeerState() == PeerState.ENABLED;</span> |
| <span class="source-line-no">070</span><span id="line-70"> }</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Get the peer config object</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @return the ReplicationPeerConfig for this peer</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> ReplicationPeerConfig getPeerConfig();</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"> * Get the configuration object required to communicate with this peer</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @return configuration object</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> Configuration getConfiguration();</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Get replicable (table, cf-list) map of this peer</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @return the replicable (table, cf-list) map</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> Map<TableName, List<String>> getTableCFs();</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /**</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Get replicable namespace set of this peer</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @return the replicable namespaces set</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> Set<String> getNamespaces();</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"> * Get the per node bandwidth upper limit for this peer</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @return the bandwidth upper limit</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> long getPeerBandwidth();</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Register a peer config listener to catch the peer config change event.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @param listener listener to catch the peer config change event.</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> void registerPeerConfigListener(ReplicationPeerConfigListener listener);</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /**</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @deprecated since 2.1.0 and will be removed in 4.0.0. Use</span> |
| <span class="source-line-no">110</span><span id="line-110"> * {@link #registerPeerConfigListener(ReplicationPeerConfigListener)} instead.</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @see #registerPeerConfigListener(ReplicationPeerConfigListener)</span> |
| <span class="source-line-no">112</span><span id="line-112"> * @see <a href="https://issues.apache.org/jira/browse/HBASE-10573">HBASE-19573</a></span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> @Deprecated</span> |
| <span class="source-line-no">115</span><span id="line-115"> default void trackPeerConfigChanges(ReplicationPeerConfigListener listener) {</span> |
| <span class="source-line-no">116</span><span id="line-116"> registerPeerConfigListener(listener);</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
