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.io.IOException;
021import org.apache.hadoop.conf.Configuration;
022import org.apache.hadoop.hbase.HBaseInterfaceAudience;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * Interface that defines how a region server in peer cluster will get source cluster file system
027 * configurations. User can configure their custom implementation implementing this interface by
028 * setting the value of their custom implementation's fully qualified class name to
029 * hbase.replication.source.fs.conf.provider property in RegionServer configuration. Default is
030 * {@link DefaultSourceFSConfigurationProvider}
031 */
032@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)
033public interface SourceFSConfigurationProvider {
034
035  /**
036   * Returns the source cluster file system configuration for the given source cluster replication
037   * ID.
038   * @param sinkConf             sink cluster configuration
039   * @param replicationClusterId unique ID which identifies the source cluster
040   * @return source cluster file system configuration
041   * @throws IOException for invalid directory or for a bad disk.
042   */
043  public Configuration getConf(Configuration sinkConf, String replicationClusterId)
044    throws IOException;
045
046}