001/*
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.regionserver;
020
021import java.io.IOException;
022import java.util.List;
023
024import org.apache.yetus.audience.InterfaceAudience;
025import org.apache.hadoop.hbase.CellScanner;
026import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.WALEntry;
027
028/**
029 * A sink for a replication stream has to expose this service.
030 * This service allows an application to hook into the
031 * regionserver and behave as a replication sink.
032 */
033@InterfaceAudience.Private
034public interface ReplicationSinkService extends ReplicationService {
035  /**
036   * Carry on the list of log entries down to the sink
037   * @param entries list of WALEntries to replicate
038   * @param cells Cells that the WALEntries refer to (if cells is non-null)
039   * @param replicationClusterId Id which will uniquely identify source cluster FS client
040   *          configurations in the replication configuration directory
041   * @param sourceBaseNamespaceDirPath Path that point to the source cluster base namespace
042   *          directory required for replicating hfiles
043   * @param sourceHFileArchiveDirPath Path that point to the source cluster hfile archive directory
044   * @throws IOException
045   */
046  void replicateLogEntries(List<WALEntry> entries, CellScanner cells, String replicationClusterId,
047      String sourceBaseNamespaceDirPath, String sourceHFileArchiveDirPath) throws IOException;
048}