hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/ReplicationService.java

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