001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase;
019
020import org.apache.hadoop.conf.Configuration;
021import org.apache.yetus.audience.InterfaceAudience;
022import org.apache.yetus.audience.InterfaceStability;
023
024/**
025 * Coprocessor environment state.
026 */
027@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
028@InterfaceStability.Evolving
029public interface CoprocessorEnvironment<C extends Coprocessor> {
030
031  /** Returns the Coprocessor interface version */
032  int getVersion();
033
034  /** Returns the HBase version as a string (e.g. "0.21.0") */
035  String getHBaseVersion();
036
037  /** Returns the loaded coprocessor instance */
038  C getInstance();
039
040  /** Returns the priority assigned to the loaded coprocessor */
041  int getPriority();
042
043  /** Returns the load sequence number */
044  int getLoadSequence();
045
046  /**
047   * Returns a Read-only Configuration; throws {@link UnsupportedOperationException} if you try to
048   * set a configuration.
049   */
050  Configuration getConfiguration();
051
052  /** Returns the classloader for the loaded coprocessor instance */
053  ClassLoader getClassLoader();
054}