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.client;
019
020import java.util.concurrent.CompletableFuture;
021
022import org.apache.hadoop.hbase.HRegionLocation;
023import org.apache.hadoop.hbase.TableName;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * The asynchronous version of RegionLocator.
028 * <p>
029 * Usually the implementations will not throw any exception directly, you need to get the exception
030 * from the returned {@link CompletableFuture}.
031 * @since 2.0.0
032 */
033@InterfaceAudience.Public
034public interface AsyncTableRegionLocator {
035
036  /**
037   * Gets the fully qualified table name instance of the table whose region we want to locate.
038   */
039  TableName getName();
040
041  /**
042   * Finds the region on which the given row is being served. Does not reload the cache.
043   * <p>
044   * Returns the location of the region to which the row belongs.
045   * @param row Row to find.
046   */
047  default CompletableFuture<HRegionLocation> getRegionLocation(byte[] row) {
048    return getRegionLocation(row, false);
049  }
050
051  /**
052   * Finds the region on which the given row is being served.
053   * <p>
054   * Returns the location of the region to which the row belongs.
055   * @param row Row to find.
056   * @param reload true to reload information or false to use cached information
057   */
058  CompletableFuture<HRegionLocation> getRegionLocation(byte[] row, boolean reload);
059}