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.net.InetSocketAddress;
021import java.util.List;
022import org.apache.yetus.audience.InterfaceAudience;
023
024import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.ServerName;
025
026/**
027 * Abstraction that allows different modules in RegionServer to update/get the favored nodes
028 * information for regions.
029 */
030@InterfaceAudience.Private
031public interface FavoredNodesForRegion {
032  /**
033   * Used to update the favored nodes mapping when required.
034   */
035  void updateRegionFavoredNodesMapping(String encodedRegionName, List<ServerName> favoredNodes);
036
037  /**
038   * Get the favored nodes mapping for this region. Used when the HDFS create API is invoked to pass
039   * in favored nodes hints for new region files.
040   * @return array containing the favored nodes' InetSocketAddresses
041   */
042  InetSocketAddress[] getFavoredNodesForRegion(String encodedRegionName);
043}