View Javadoc

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.fs.FileSystem;
26  import org.apache.hadoop.fs.Path;
27  
28  /**
29   * Gateway to Cluster Replication.  
30   * Used by {@link org.apache.hadoop.hbase.regionserver.HRegionServer}.
31   * One such application is a cross-datacenter
32   * replication service that can keep two hbase clusters in sync.
33   */
34  @InterfaceAudience.Private
35  public interface ReplicationService {
36  
37    /**
38     * Initializes the replication service object.
39     * @throws IOException
40     */
41    void initialize(
42      Server rs, FileSystem fs, Path logdir, Path oldLogDir
43    ) throws IOException;
44  
45    /**
46     * Start replication services.
47     * @throws IOException
48     */
49    void startReplicationService() throws IOException;
50  
51    /**
52     * Stops replication service.
53     */
54    void stopReplicationService();
55  }