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