001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver;
019
020import java.io.IOException;
021import org.apache.hadoop.fs.FileSystem;
022import org.apache.hadoop.fs.Path;
023import org.apache.hadoop.hbase.Server;
024import org.apache.hadoop.hbase.replication.regionserver.ReplicationLoad;
025import org.apache.hadoop.hbase.wal.WALProvider;
026import org.apache.yetus.audience.InterfaceAudience;
027
028/**
029 * Gateway to Cluster Replication. Used by
030 * {@link org.apache.hadoop.hbase.regionserver.HRegionServer}. One such application is a
031 * cross-datacenter replication service that can keep two hbase clusters in sync.
032 */
033@InterfaceAudience.Private
034public interface ReplicationService {
035
036  /**
037   * Initializes the replication service object.
038   * @param walProvider can be null if not initialized inside a live region server environment, for
039   *          example, {@code ReplicationSyncUp}.
040   */
041  void initialize(Server rs, FileSystem fs, Path logdir, Path oldLogDir, WALProvider walProvider)
042      throws IOException;
043
044  /**
045   * Start replication services.
046   */
047  void startReplicationService() throws IOException;
048
049  /**
050   * Stops replication service.
051   */
052  void stopReplicationService();
053
054  /**
055   * Refresh and Get ReplicationLoad
056   */
057  ReplicationLoad refreshAndGetReplicationLoad();
058}