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.security.visibility;
020
021import java.io.IOException;
022
023import org.apache.yetus.audience.InterfaceAudience;
024import org.apache.hadoop.hbase.Cell;
025
026/**
027 * During the read (ie. get/Scan) the VisibilityController calls this interface for each of the
028 * Cell. Depending on the evaluate() result, a cell can be either included or filtered out from the
029 * read results.
030 */
031@InterfaceAudience.Public
032public interface VisibilityExpEvaluator {
033
034  /**
035   * Evaluates whether the passed cell passes Scan/Get Authorization.
036   * @param cell Cell under evaluation
037   * @return true if this cell can be included in the Result. Else false.
038   */
039  boolean evaluate(Cell cell) throws IOException;
040}