1 /*
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 package org.apache.hadoop.hbase;
17
18 import org.apache.hadoop.classification.InterfaceAudience;
19 import org.apache.hadoop.classification.InterfaceStability;
20 import org.apache.hadoop.conf.Configuration;
21 import org.apache.hadoop.hbase.client.HTableInterface;
22
23 import java.io.IOException;
24
25 /**
26 * Coprocessor environment state.
27 */
28 @InterfaceAudience.Public
29 @InterfaceStability.Evolving
30 public interface CoprocessorEnvironment {
31
32 /** @return the Coprocessor interface version */
33 int getVersion();
34
35 /** @return the HBase version as a string (e.g. "0.21.0") */
36 String getHBaseVersion();
37
38 /** @return the loaded coprocessor instance */
39 Coprocessor getInstance();
40
41 /** @return the priority assigned to the loaded coprocessor */
42 int getPriority();
43
44 /** @return the load sequence number */
45 int getLoadSequence();
46
47 /** @return the configuration */
48 Configuration getConfiguration();
49
50 /**
51 * @return an interface for accessing the given table
52 * @throws IOException
53 */
54 HTableInterface getTable(TableName tableName) throws IOException;
55 }