001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.client;
020
021import java.util.Map;
022import java.util.Optional;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * CoprocessorDescriptor contains the details about how to build a coprocessor.
027 * This class is a pojo so there are no checks for the details carried by this class.
028 * Use {@link CoprocessorDescriptorBuilder} to instantiate a CoprocessorDescriptor
029 */
030@InterfaceAudience.Public
031public interface CoprocessorDescriptor {
032  /**
033   * @return the name of the class or interface represented by this object.
034   */
035  String getClassName();
036
037  /**
038   * @return Path of the jar file. If it's null, the class will be loaded from default classloader.
039   */
040  Optional<String> getJarPath();
041
042  /**
043   * @return The order to execute this coprocessor
044   */
045  int getPriority();
046
047  /**
048   * @return Arbitrary key-value parameter pairs passed into the  coprocessor.
049   */
050  Map<String, String> getProperties();
051}