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

   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 import java.util.List;
  23
  24 import org.apache.yetus.audience.InterfaceAudience;
  25 import org.apache.hadoop.hbase.CellScanner;
  26 import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.WALEntry;
  27
  28 /**
  29  * A sink for a replication stream has to expose this service.
  30  * This service allows an application to hook into the
  31  * regionserver and behave as a replication sink.
  32  */
  33 @InterfaceAudience.Private
  34 public interface ReplicationSinkService extends ReplicationService {
  35   /**
  36    * Carry on the list of log entries down to the sink
  37    * @param entries list of WALEntries to replicate
  38    * @param cells Cells that the WALEntries refer to (if cells is non-null)
  39    * @param replicationClusterId Id which will uniquely identify source cluster FS client
  40    *          configurations in the replication configuration directory
  41    * @param sourceBaseNamespaceDirPath Path that point to the source cluster base namespace
  42    *          directory required for replicating hfiles
  43    * @param sourceHFileArchiveDirPath Path that point to the source cluster hfile archive directory
  44    * @throws IOException
  45    */
  46   void replicateLogEntries(List<WALEntry> entries, CellScanner cells, String replicationClusterId,
  47       String sourceBaseNamespaceDirPath, String sourceHFileArchiveDirPath) throws IOException;
  48 }