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