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.replication.regionserver;
019
020import java.util.Optional;
021import java.util.function.BiPredicate;
022import org.apache.hadoop.hbase.TableName;
023import org.apache.hadoop.hbase.replication.SyncReplicationState;
024import org.apache.hadoop.hbase.util.Pair;
025import org.apache.yetus.audience.InterfaceAudience;
026
027/**
028 * Get the information for a sync replication peer.
029 */
030@InterfaceAudience.Private
031public interface SyncReplicationPeerInfoProvider {
032
033  /**
034   * Return the peer id and remote WAL directory if the table is synchronously replicated and the
035   * state is {@link SyncReplicationState#ACTIVE}.
036   */
037  Optional<Pair<String, String>> getPeerIdAndRemoteWALDir(TableName table);
038
039  /**
040   * Check whether the given table is contained in a sync replication peer which can pass the state
041   * checker.
042   * <p>
043   * Will call the checker with current sync replication state and new sync replication state.
044   */
045  boolean checkState(TableName table,
046    BiPredicate<SyncReplicationState, SyncReplicationState> checker);
047}