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
20 package org.apache.hadoop.hbase.coprocessor;
21
22 import java.util.concurrent.ConcurrentMap;
23
24 import org.apache.hadoop.hbase.classification.InterfaceAudience;
25 import org.apache.hadoop.hbase.classification.InterfaceStability;
26 import org.apache.hadoop.hbase.CoprocessorEnvironment;
27 import org.apache.hadoop.hbase.HBaseInterfaceAudience;
28 import org.apache.hadoop.hbase.HRegionInfo;
29 import org.apache.hadoop.hbase.regionserver.Region;
30 import org.apache.hadoop.hbase.regionserver.RegionServerServices;
31
32 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
33 @InterfaceStability.Evolving
34 public interface RegionCoprocessorEnvironment extends CoprocessorEnvironment {
35 /** @return the region associated with this coprocessor */
36 Region getRegion();
37
38 /** @return region information for the region this coprocessor is running on */
39 HRegionInfo getRegionInfo();
40
41 /** @return reference to the region server services */
42 RegionServerServices getRegionServerServices();
43
44 /** @return shared data between all instances of this coprocessor */
45 ConcurrentMap<String, Object> getSharedData();
46 }