View Javadoc

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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.security.visibility;
19  
20  import java.util.List;
21  
22  import org.apache.hadoop.hbase.classification.InterfaceAudience;
23  import org.apache.hadoop.hbase.classification.InterfaceStability;
24  import org.apache.hadoop.conf.Configurable;
25  import org.apache.hadoop.hbase.security.User;
26  
27  /**
28   * This would be the interface which would be used add labels to the RPC context
29   * and this would be stored against the UGI.
30   *
31   */
32  @InterfaceAudience.Public
33  @InterfaceStability.Evolving
34  public interface ScanLabelGenerator extends Configurable {
35  
36    /**
37     * Helps to get a list of lables associated with an UGI
38     * @param user
39     * @param authorizations
40     * @return The labels 
41     */
42    public List<String> getLabels(User user, Authorizations authorizations);
43  }