blob: e28358729521056671c03b6872f1eda45810940f [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.replication, interface: ReplicationEndpoint, class: ReplicateContext">
<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.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.List;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.UUID;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.concurrent.TimeoutException;</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.fs.FileSystem;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.Abortable;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.Server;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.TableDescriptors;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.replication.regionserver.MetricsSource;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.wal.WAL.Entry;</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">/**</span>
<span class="source-line-no">036</span><span id="line-36"> * ReplicationEndpoint is a plugin which implements replication to other HBase clusters, or other</span>
<span class="source-line-no">037</span><span id="line-37"> * systems. ReplicationEndpoint implementation can be specified at the peer creation time by</span>
<span class="source-line-no">038</span><span id="line-38"> * specifying it in the {@link ReplicationPeerConfig}. A ReplicationEndpoint is run in a thread in</span>
<span class="source-line-no">039</span><span id="line-39"> * each region server in the same process.</span>
<span class="source-line-no">040</span><span id="line-40"> * &lt;p&gt;</span>
<span class="source-line-no">041</span><span id="line-41"> * ReplicationEndpoint is closely tied to ReplicationSource in a producer-consumer relation.</span>
<span class="source-line-no">042</span><span id="line-42"> * ReplicationSource is an HBase-private class which tails the logs and manages the queue of logs</span>
<span class="source-line-no">043</span><span id="line-43"> * plus management and persistence of all the state for replication. ReplicationEndpoint on the</span>
<span class="source-line-no">044</span><span id="line-44"> * other hand is responsible for doing the actual shipping and persisting of the WAL entries in the</span>
<span class="source-line-no">045</span><span id="line-45"> * other cluster.</span>
<span class="source-line-no">046</span><span id="line-46"> */</span>
<span class="source-line-no">047</span><span id="line-47">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)</span>
<span class="source-line-no">048</span><span id="line-48">public interface ReplicationEndpoint extends ReplicationPeerConfigListener {</span>
<span class="source-line-no">049</span><span id="line-49"> // TODO: This class needs doc. Has a Context and a ReplicationContext. Then has #start, #stop.</span>
<span class="source-line-no">050</span><span id="line-50"> // How they relate? Do we #start before #init(Context)? We fail fast if you don't?</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)</span>
<span class="source-line-no">053</span><span id="line-53"> class Context {</span>
<span class="source-line-no">054</span><span id="line-54"> private final Server server;</span>
<span class="source-line-no">055</span><span id="line-55"> private final Configuration localConf;</span>
<span class="source-line-no">056</span><span id="line-56"> private final Configuration conf;</span>
<span class="source-line-no">057</span><span id="line-57"> private final FileSystem fs;</span>
<span class="source-line-no">058</span><span id="line-58"> private final TableDescriptors tableDescriptors;</span>
<span class="source-line-no">059</span><span id="line-59"> private final ReplicationPeer replicationPeer;</span>
<span class="source-line-no">060</span><span id="line-60"> private final String peerId;</span>
<span class="source-line-no">061</span><span id="line-61"> private final UUID clusterId;</span>
<span class="source-line-no">062</span><span id="line-62"> private final MetricsSource metrics;</span>
<span class="source-line-no">063</span><span id="line-63"> private final Abortable abortable;</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> @InterfaceAudience.Private</span>
<span class="source-line-no">066</span><span id="line-66"> public Context(final Server server, final Configuration localConf, final Configuration conf,</span>
<span class="source-line-no">067</span><span id="line-67"> final FileSystem fs, final String peerId, final UUID clusterId,</span>
<span class="source-line-no">068</span><span id="line-68"> final ReplicationPeer replicationPeer, final MetricsSource metrics,</span>
<span class="source-line-no">069</span><span id="line-69"> final TableDescriptors tableDescriptors, final Abortable abortable) {</span>
<span class="source-line-no">070</span><span id="line-70"> this.server = server;</span>
<span class="source-line-no">071</span><span id="line-71"> this.localConf = localConf;</span>
<span class="source-line-no">072</span><span id="line-72"> this.conf = conf;</span>
<span class="source-line-no">073</span><span id="line-73"> this.fs = fs;</span>
<span class="source-line-no">074</span><span id="line-74"> this.clusterId = clusterId;</span>
<span class="source-line-no">075</span><span id="line-75"> this.peerId = peerId;</span>
<span class="source-line-no">076</span><span id="line-76"> this.replicationPeer = replicationPeer;</span>
<span class="source-line-no">077</span><span id="line-77"> this.metrics = metrics;</span>
<span class="source-line-no">078</span><span id="line-78"> this.tableDescriptors = tableDescriptors;</span>
<span class="source-line-no">079</span><span id="line-79"> this.abortable = abortable;</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"> public Server getServer() {</span>
<span class="source-line-no">083</span><span id="line-83"> return server;</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"> public Configuration getConfiguration() {</span>
<span class="source-line-no">087</span><span id="line-87"> return conf;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> public Configuration getLocalConfiguration() {</span>
<span class="source-line-no">091</span><span id="line-91"> return localConf;</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> public FileSystem getFilesystem() {</span>
<span class="source-line-no">095</span><span id="line-95"> return fs;</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"> public UUID getClusterId() {</span>
<span class="source-line-no">099</span><span id="line-99"> return clusterId;</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> public String getPeerId() {</span>
<span class="source-line-no">103</span><span id="line-103"> return peerId;</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"> public ReplicationPeerConfig getPeerConfig() {</span>
<span class="source-line-no">107</span><span id="line-107"> return replicationPeer.getPeerConfig();</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> public ReplicationPeer getReplicationPeer() {</span>
<span class="source-line-no">111</span><span id="line-111"> return replicationPeer;</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"> public MetricsSource getMetrics() {</span>
<span class="source-line-no">115</span><span id="line-115"> return metrics;</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> public TableDescriptors getTableDescriptors() {</span>
<span class="source-line-no">119</span><span id="line-119"> return tableDescriptors;</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> public Abortable getAbortable() {</span>
<span class="source-line-no">123</span><span id="line-123"> return abortable;</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>
<span class="source-line-no">126</span><span id="line-126"></span>
<span class="source-line-no">127</span><span id="line-127"> /**</span>
<span class="source-line-no">128</span><span id="line-128"> * Initialize the replication endpoint with the given context.</span>
<span class="source-line-no">129</span><span id="line-129"> * @param context replication context</span>
<span class="source-line-no">130</span><span id="line-130"> * @throws IOException error occur when initialize the endpoint.</span>
<span class="source-line-no">131</span><span id="line-131"> */</span>
<span class="source-line-no">132</span><span id="line-132"> void init(Context context) throws IOException;</span>
<span class="source-line-no">133</span><span id="line-133"></span>
<span class="source-line-no">134</span><span id="line-134"> /**</span>
<span class="source-line-no">135</span><span id="line-135"> * Whether or not, the replication endpoint can replicate to it's source cluster with the same</span>
<span class="source-line-no">136</span><span id="line-136"> * UUID</span>
<span class="source-line-no">137</span><span id="line-137"> */</span>
<span class="source-line-no">138</span><span id="line-138"> boolean canReplicateToSameCluster();</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140"> /**</span>
<span class="source-line-no">141</span><span id="line-141"> * Returns a UUID of the provided peer id. Every HBase cluster instance has a persisted associated</span>
<span class="source-line-no">142</span><span id="line-142"> * UUID. If the replication is not performed to an actual HBase cluster (but some other system),</span>
<span class="source-line-no">143</span><span id="line-143"> * the UUID returned has to uniquely identify the connected target system.</span>
<span class="source-line-no">144</span><span id="line-144"> * @return a UUID or null if the peer cluster does not exist or is not connected.</span>
<span class="source-line-no">145</span><span id="line-145"> */</span>
<span class="source-line-no">146</span><span id="line-146"> UUID getPeerUUID();</span>
<span class="source-line-no">147</span><span id="line-147"></span>
<span class="source-line-no">148</span><span id="line-148"> /**</span>
<span class="source-line-no">149</span><span id="line-149"> * Returns a WALEntryFilter to use for filtering out WALEntries from the log. Replication</span>
<span class="source-line-no">150</span><span id="line-150"> * infrastructure will call this filter before sending the edits to shipEdits().</span>
<span class="source-line-no">151</span><span id="line-151"> * @return a {@link WALEntryFilter} or null.</span>
<span class="source-line-no">152</span><span id="line-152"> */</span>
<span class="source-line-no">153</span><span id="line-153"> WALEntryFilter getWALEntryfilter();</span>
<span class="source-line-no">154</span><span id="line-154"></span>
<span class="source-line-no">155</span><span id="line-155"> /**</span>
<span class="source-line-no">156</span><span id="line-156"> * A context for {@link ReplicationEndpoint#replicate(ReplicateContext)} method.</span>
<span class="source-line-no">157</span><span id="line-157"> */</span>
<span class="source-line-no">158</span><span id="line-158"> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)</span>
<span class="source-line-no">159</span><span id="line-159"> static class ReplicateContext {</span>
<span class="source-line-no">160</span><span id="line-160"> List&lt;Entry&gt; entries;</span>
<span class="source-line-no">161</span><span id="line-161"> int size;</span>
<span class="source-line-no">162</span><span id="line-162"> String walGroupId;</span>
<span class="source-line-no">163</span><span id="line-163"> int timeout;</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> @InterfaceAudience.Private</span>
<span class="source-line-no">166</span><span id="line-166"> public ReplicateContext() {</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> public ReplicateContext setEntries(List&lt;Entry&gt; entries) {</span>
<span class="source-line-no">170</span><span id="line-170"> this.entries = entries;</span>
<span class="source-line-no">171</span><span id="line-171"> return this;</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173"></span>
<span class="source-line-no">174</span><span id="line-174"> public ReplicateContext setSize(int size) {</span>
<span class="source-line-no">175</span><span id="line-175"> this.size = size;</span>
<span class="source-line-no">176</span><span id="line-176"> return this;</span>
<span class="source-line-no">177</span><span id="line-177"> }</span>
<span class="source-line-no">178</span><span id="line-178"></span>
<span class="source-line-no">179</span><span id="line-179"> public ReplicateContext setWalGroupId(String walGroupId) {</span>
<span class="source-line-no">180</span><span id="line-180"> this.walGroupId = walGroupId;</span>
<span class="source-line-no">181</span><span id="line-181"> return this;</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"></span>
<span class="source-line-no">184</span><span id="line-184"> public List&lt;Entry&gt; getEntries() {</span>
<span class="source-line-no">185</span><span id="line-185"> return entries;</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> public int getSize() {</span>
<span class="source-line-no">189</span><span id="line-189"> return size;</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"></span>
<span class="source-line-no">192</span><span id="line-192"> public String getWalGroupId() {</span>
<span class="source-line-no">193</span><span id="line-193"> return walGroupId;</span>
<span class="source-line-no">194</span><span id="line-194"> }</span>
<span class="source-line-no">195</span><span id="line-195"></span>
<span class="source-line-no">196</span><span id="line-196"> public void setTimeout(int timeout) {</span>
<span class="source-line-no">197</span><span id="line-197"> this.timeout = timeout;</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> public int getTimeout() {</span>
<span class="source-line-no">201</span><span id="line-201"> return this.timeout;</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"> }</span>
<span class="source-line-no">204</span><span id="line-204"></span>
<span class="source-line-no">205</span><span id="line-205"> /**</span>
<span class="source-line-no">206</span><span id="line-206"> * Replicate the given set of entries (in the context) to the other cluster. Can block until all</span>
<span class="source-line-no">207</span><span id="line-207"> * the given entries are replicated. Upon this method is returned, all entries that were passed in</span>
<span class="source-line-no">208</span><span id="line-208"> * the context are assumed to be persisted in the target cluster.</span>
<span class="source-line-no">209</span><span id="line-209"> * @param replicateContext a context where WAL entries and other parameters can be obtained.</span>
<span class="source-line-no">210</span><span id="line-210"> */</span>
<span class="source-line-no">211</span><span id="line-211"> boolean replicate(ReplicateContext replicateContext);</span>
<span class="source-line-no">212</span><span id="line-212"></span>
<span class="source-line-no">213</span><span id="line-213"> // The below methods are inspired by Guava Service. See</span>
<span class="source-line-no">214</span><span id="line-214"> // https://github.com/google/guava/wiki/ServiceExplained for overview of Guava Service.</span>
<span class="source-line-no">215</span><span id="line-215"> // Below we implement a subset only with different names on some methods so we can implement</span>
<span class="source-line-no">216</span><span id="line-216"> // the below internally using Guava (without exposing our implementation to</span>
<span class="source-line-no">217</span><span id="line-217"> // ReplicationEndpoint implementors.</span>
<span class="source-line-no">218</span><span id="line-218"></span>
<span class="source-line-no">219</span><span id="line-219"> /**</span>
<span class="source-line-no">220</span><span id="line-220"> * Returns {@code true} if this service is RUNNING.</span>
<span class="source-line-no">221</span><span id="line-221"> */</span>
<span class="source-line-no">222</span><span id="line-222"> boolean isRunning();</span>
<span class="source-line-no">223</span><span id="line-223"></span>
<span class="source-line-no">224</span><span id="line-224"> /** Returns Return {@code true} is this service is STARTING (but not yet RUNNING). */</span>
<span class="source-line-no">225</span><span id="line-225"> boolean isStarting();</span>
<span class="source-line-no">226</span><span id="line-226"></span>
<span class="source-line-no">227</span><span id="line-227"> /**</span>
<span class="source-line-no">228</span><span id="line-228"> * Initiates service startup and returns immediately. A stopped service may not be restarted.</span>
<span class="source-line-no">229</span><span id="line-229"> * Equivalent of startAsync call in Guava Service.</span>
<span class="source-line-no">230</span><span id="line-230"> * @throws IllegalStateException if the service is not new, if it has been run already.</span>
<span class="source-line-no">231</span><span id="line-231"> */</span>
<span class="source-line-no">232</span><span id="line-232"> void start();</span>
<span class="source-line-no">233</span><span id="line-233"></span>
<span class="source-line-no">234</span><span id="line-234"> /**</span>
<span class="source-line-no">235</span><span id="line-235"> * Waits for the {@link ReplicationEndpoint} to be up and running.</span>
<span class="source-line-no">236</span><span id="line-236"> * @throws IllegalStateException if the service reaches a state from which it is not possible to</span>
<span class="source-line-no">237</span><span id="line-237"> * enter the (internal) running state. e.g. if the state is</span>
<span class="source-line-no">238</span><span id="line-238"> * terminated when this method is called then this will throw an</span>
<span class="source-line-no">239</span><span id="line-239"> * IllegalStateException.</span>
<span class="source-line-no">240</span><span id="line-240"> */</span>
<span class="source-line-no">241</span><span id="line-241"> void awaitRunning();</span>
<span class="source-line-no">242</span><span id="line-242"></span>
<span class="source-line-no">243</span><span id="line-243"> /**</span>
<span class="source-line-no">244</span><span id="line-244"> * Waits for the {@link ReplicationEndpoint} to to be up and running for no more than the given</span>
<span class="source-line-no">245</span><span id="line-245"> * time.</span>
<span class="source-line-no">246</span><span id="line-246"> * @param timeout the maximum time to wait</span>
<span class="source-line-no">247</span><span id="line-247"> * @param unit the time unit of the timeout argument</span>
<span class="source-line-no">248</span><span id="line-248"> * @throws TimeoutException if the service has not reached the given state within the</span>
<span class="source-line-no">249</span><span id="line-249"> * deadline</span>
<span class="source-line-no">250</span><span id="line-250"> * @throws IllegalStateException if the service reaches a state from which it is not possible to</span>
<span class="source-line-no">251</span><span id="line-251"> * enter the (internal) running state. e.g. if the state is</span>
<span class="source-line-no">252</span><span id="line-252"> * terminated when this method is called then this will throw an</span>
<span class="source-line-no">253</span><span id="line-253"> * IllegalStateException.</span>
<span class="source-line-no">254</span><span id="line-254"> */</span>
<span class="source-line-no">255</span><span id="line-255"> void awaitRunning(long timeout, TimeUnit unit) throws TimeoutException;</span>
<span class="source-line-no">256</span><span id="line-256"></span>
<span class="source-line-no">257</span><span id="line-257"> /**</span>
<span class="source-line-no">258</span><span id="line-258"> * If the service is starting or running, this initiates service shutdown and returns immediately.</span>
<span class="source-line-no">259</span><span id="line-259"> * If the service has already been stopped, this method returns immediately without taking action.</span>
<span class="source-line-no">260</span><span id="line-260"> * Equivalent of stopAsync call in Guava Service.</span>
<span class="source-line-no">261</span><span id="line-261"> */</span>
<span class="source-line-no">262</span><span id="line-262"> void stop();</span>
<span class="source-line-no">263</span><span id="line-263"></span>
<span class="source-line-no">264</span><span id="line-264"> /**</span>
<span class="source-line-no">265</span><span id="line-265"> * Waits for the {@link ReplicationEndpoint} to reach the terminated (internal) state.</span>
<span class="source-line-no">266</span><span id="line-266"> * @throws IllegalStateException if the service FAILED.</span>
<span class="source-line-no">267</span><span id="line-267"> */</span>
<span class="source-line-no">268</span><span id="line-268"> void awaitTerminated();</span>
<span class="source-line-no">269</span><span id="line-269"></span>
<span class="source-line-no">270</span><span id="line-270"> /**</span>
<span class="source-line-no">271</span><span id="line-271"> * Waits for the {@link ReplicationEndpoint} to reach a terminal state for no more than the given</span>
<span class="source-line-no">272</span><span id="line-272"> * time.</span>
<span class="source-line-no">273</span><span id="line-273"> * @param timeout the maximum time to wait</span>
<span class="source-line-no">274</span><span id="line-274"> * @param unit the time unit of the timeout argument</span>
<span class="source-line-no">275</span><span id="line-275"> * @throws TimeoutException if the service has not reached the given state within the</span>
<span class="source-line-no">276</span><span id="line-276"> * deadline</span>
<span class="source-line-no">277</span><span id="line-277"> * @throws IllegalStateException if the service FAILED.</span>
<span class="source-line-no">278</span><span id="line-278"> */</span>
<span class="source-line-no">279</span><span id="line-279"> void awaitTerminated(long timeout, TimeUnit unit) throws TimeoutException;</span>
<span class="source-line-no">280</span><span id="line-280"></span>
<span class="source-line-no">281</span><span id="line-281"> /**</span>
<span class="source-line-no">282</span><span id="line-282"> * Returns the {@link Throwable} that caused this service to fail.</span>
<span class="source-line-no">283</span><span id="line-283"> * @throws IllegalStateException if this service's state isn't FAILED.</span>
<span class="source-line-no">284</span><span id="line-284"> */</span>
<span class="source-line-no">285</span><span id="line-285"> Throwable failureCause();</span>
<span class="source-line-no">286</span><span id="line-286">}</span>
</pre>
</div>
</main>
</body>
</html>