View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.client;
19  
20  import java.io.IOException;
21  
22  import org.apache.hadoop.hbase.ServerName;
23  import org.apache.hadoop.hbase.classification.InterfaceAudience;
24  import org.apache.hadoop.hbase.RegionLocations;
25  import org.apache.hadoop.hbase.TableName;
26  
27  /**
28   * Implementations hold cluster information such as this cluster's id, location of hbase:meta, etc.
29   * needed by cluster connections.
30   * Internal use only.
31   */
32  @InterfaceAudience.Private
33  interface ConnectionRegistry {
34    /**
35     * @param connection
36     */
37    void init(Connection connection) throws IOException;
38  
39    /**
40     * @return the currently active master, null if none exists.
41     */
42    ServerName getActiveMaster() throws IOException;
43  
44    /**
45     * @return Meta region location
46     * @throws IOException
47     */
48    RegionLocations getMetaRegionLocations() throws IOException;
49  
50    /**
51     * @return Cluster id.
52     */
53    String getClusterId() throws IOException;
54  
55    /**
56     * @param enabled Return true if table is enabled
57     */
58    boolean isTableOnlineState(TableName tableName, boolean enabled) throws IOException;
59  
60    /**
61     * @return Count of 'running' regionservers
62     * @throws IOException
63     */
64    int getCurrentNrHRS() throws IOException;
65  
66    /**
67     * Cleanup state, if any.
68     */
69    void close();
70  }