1 /*
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 package org.apache.hadoop.hbase.regionserver;
20
21 import java.io.IOException;
22
23 import org.apache.hadoop.hbase.Server;
24 import org.apache.hadoop.hbase.classification.InterfaceAudience;
25 import org.apache.hadoop.hbase.replication.regionserver.ReplicationLoad;
26 import org.apache.hadoop.fs.FileSystem;
27 import org.apache.hadoop.fs.Path;
28
29 /**
30 * Gateway to Cluster Replication.
31 * Used by {@link org.apache.hadoop.hbase.regionserver.HRegionServer}.
32 * One such application is a cross-datacenter
33 * replication service that can keep two hbase clusters in sync.
34 */
35 @InterfaceAudience.Private
36 public interface ReplicationService {
37
38 /**
39 * Initializes the replication service object.
40 * @throws IOException
41 */
42 void initialize(
43 Server rs, FileSystem fs, Path logdir, Path oldLogDir
44 ) throws IOException;
45
46 /**
47 * Start replication services.
48 * @throws IOException
49 */
50 void startReplicationService() throws IOException;
51
52 /**
53 * Stops replication service.
54 */
55 void stopReplicationService();
56
57 /**
58 * Refresh and Get ReplicationLoad
59 */
60 public ReplicationLoad refreshAndGetReplicationLoad();
61 }