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.client;
019
020import java.util.Map;
021import java.util.Optional;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * CoprocessorDescriptor contains the details about how to build a coprocessor. This class is a pojo
026 * so there are no checks for the details carried by this class. Use
027 * {@link CoprocessorDescriptorBuilder} to instantiate a CoprocessorDescriptor
028 */
029@InterfaceAudience.Public
030public interface CoprocessorDescriptor {
031  /** Returns the name of the class or interface represented by this object. */
032  String getClassName();
033
034  /**
035   * Returns Path of the jar file. If it's null, the class will be loaded from default classloader.
036   */
037  Optional<String> getJarPath();
038
039  /** Returns The order to execute this coprocessor */
040  int getPriority();
041
042  /** Returns Arbitrary key-value parameter pairs passed into the coprocessor. */
043  Map<String, String> getProperties();
044}