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.io.IOException;
021import java.util.List;
022import org.apache.hadoop.hbase.HBaseInterfaceAudience;
023import org.apache.hadoop.hbase.TableName;
024import org.apache.yetus.audience.InterfaceAudience;
025import org.apache.yetus.audience.InterfaceStability;
026
027/**
028 * Provides read-only access to the Regions presently online on the current RegionServer
029 */
030@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
031@InterfaceStability.Evolving
032public interface OnlineRegions {
033
034  /**
035   * Return {@link Region} instance. Only works if caller is in same context, in same JVM. Region is
036   * not serializable.
037   * @return Region for the passed encoded <code>encodedRegionName</code> or null if named region is
038   *         not member of the online regions.
039   */
040  Region getRegion(String encodedRegionName);
041
042  /**
043   * Get all online regions of a table in this RS.
044   * @return List of Region
045   * @throws java.io.IOException
046   */
047  List<? extends Region> getRegions(TableName tableName) throws IOException;
048
049  /**
050   * Get all online regions in this RS.
051   * @return List of online Region
052   */
053  List<? extends Region> getRegions();
054}