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 java.util.List;
022import org.apache.hadoop.hbase.ExtendedCellScanner;
023import org.apache.yetus.audience.InterfaceAudience;
024
025import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.WALEntry;
026
027/**
028 * A sink for a replication stream has to expose this service. This service allows an application to
029 * hook into the regionserver and behave as a replication sink.
030 */
031@InterfaceAudience.Private
032public interface ReplicationSinkService extends ReplicationService {
033  /**
034   * Carry on the list of log entries down to the sink
035   * @param entries                    list of WALEntries to replicate
036   * @param cells                      Cells that the WALEntries refer to (if cells is non-null)
037   * @param replicationClusterId       Id which will uniquely identify source cluster FS client
038   *                                   configurations in the replication configuration directory
039   * @param sourceBaseNamespaceDirPath Path that point to the source cluster base namespace
040   *                                   directory required for replicating hfiles
041   * @param sourceHFileArchiveDirPath  Path that point to the source cluster hfile archive directory
042   */
043  void replicateLogEntries(List<WALEntry> entries, ExtendedCellScanner cells,
044    String replicationClusterId, String sourceBaseNamespaceDirPath,
045    String sourceHFileArchiveDirPath) throws IOException;
046}