hbase-client/src/main/java/org/apache/hadoop/hbase/CoprocessorEnvironment.java

   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,
  13  * software distributed under the License is distributed on an
  14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15  * KIND, either express or implied.  See the License for the
  16  * specific language governing permissions and limitations
  17  * under the License.
  18  */
  19
  20 package org.apache.hadoop.hbase;
  21
  22 import org.apache.hadoop.conf.Configuration;
  23 import org.apache.yetus.audience.InterfaceAudience;
  24 import org.apache.yetus.audience.InterfaceStability;
  25
  26 /**
  27  * Coprocessor environment state.
  28  */
  29 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
  30 @InterfaceStability.Evolving
  31 public interface CoprocessorEnvironment<C extends Coprocessor> {
  32
  33   /** @return the Coprocessor interface version */
  34   int getVersion();
  35
  36   /** @return the HBase version as a string (e.g. "0.21.0") */
  37   String getHBaseVersion();
  38
  39   /** @return the loaded coprocessor instance */
  40   C getInstance();
  41
  42   /** @return the priority assigned to the loaded coprocessor */
  43   int getPriority();
  44
  45   /** @return the load sequence number */
  46   int getLoadSequence();
  47
  48   /**
  49    * @return a Read-only Configuration; throws {@link UnsupportedOperationException} if you try
  50    *   to set a configuration.
  51    */
  52   Configuration getConfiguration();
  53
  54   /**
  55    * @return the classloader for the loaded coprocessor instance
  56    */
  57   ClassLoader getClassLoader();
  58 }