1 /**
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 package org.apache.hadoop.hbase.security.visibility;
20
21 import java.io.IOException;
22
23 import org.apache.hadoop.hbase.classification.InterfaceAudience;
24 import org.apache.hadoop.hbase.classification.InterfaceStability;
25 import org.apache.hadoop.hbase.Cell;
26
27 /**
28 * During the read (ie. get/Scan) the VisibilityController calls this interface for each of the
29 * Cell. Depending on the evaluate() result, a cell can be either included or filtered out from the
30 * read results.
31 */
32 @InterfaceAudience.Public
33 @InterfaceStability.Evolving
34 public interface VisibilityExpEvaluator {
35
36 /**
37 * Evaluates whether the passed cell passes Scan/Get Authorization.
38 * @param cell Cell under evaluation
39 * @return true if this cell can be included in the Result. Else false.
40 */
41 boolean evaluate(Cell cell) throws IOException;
42 }