View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.client;
20  
21  import org.apache.hadoop.hbase.classification.InterfaceAudience;
22  import org.apache.hadoop.hbase.classification.InterfaceStability;
23  import org.apache.hadoop.conf.Configuration;
24  
25  import java.io.IOException;
26  
27  
28  /**
29   * Defines methods to create new HTableInterface.
30   *
31   * @since 0.21.0
32   */
33  @InterfaceAudience.Public
34  @InterfaceStability.Stable
35  public interface HTableInterfaceFactory {
36  
37    /**
38     * Creates a new HTableInterface.
39     *
40     * @param config HBaseConfiguration instance.
41     * @param tableName name of the HBase table.
42     * @return HTableInterface instance.
43     */
44    HTableInterface createHTableInterface(Configuration config, byte[] tableName);
45  
46  
47    /**
48     * Release the HTable resource represented by the table.
49     * @param table
50     */
51    void releaseHTableInterface(final HTableInterface table) throws IOException;
52  }