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.coprocessor;
019
020import java.util.Map;
021import org.apache.hadoop.hbase.HBaseInterfaceAudience;
022import org.apache.hadoop.hbase.security.User;
023import org.apache.yetus.audience.InterfaceAudience;
024import org.apache.yetus.audience.InterfaceStability;
025
026/**
027 * RPC Call parameters for coprocessor context.
028 */
029@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
030@InterfaceStability.Evolving
031public interface ObserverRpcCallContext {
032  /**
033   * Returns the active user for the coprocessor call.
034   * @return the {@link User}, it must not be {@code null}.
035   */
036  User getUser();
037
038  /**
039   * Returns the connection attributes for the coprocessor call. These parameters are passed by the
040   * client through {@code ConnectionHeader} protobuf.
041   * @return the attributes, it must not be {@code null}.
042   */
043  Map<String, byte[]> getAttributes();
044}