Package org.apache.hadoop.hbase.security.visibility

Class VisibilityLabelFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.security.visibility.VisibilityLabelFilter

@Private
class VisibilityLabelFilter
extends FilterBase

This Filter checks the visibility expression with each KV against visibility labels associated with the scan. Based on the check the KV is included in the scan result or gets filtered out.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ByteRange,Integer>	cfVsMaxVersions
private final ByteRange	curFamily
private int	curFamilyMaxVersions
private final ByteRange	curQualifier
private int	curQualMetVersions
private final VisibilityExpEvaluator	expEvaluator

Fields inherited from class org.apache.hadoop.hbase.filter.Filter

reversed

Constructor Summary

Constructors

Constructor	Description
VisibilityLabelFilter(VisibilityExpEvaluator expEvaluator, Map<ByteRange,Integer> cfVsMaxVersions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Filter.ReturnCode	filterCell(Cell cell)	A way to filter based on the column family, column qualifier and/or the column value.
boolean	filterRowKey(Cell cell)	Filters a row based on the row key.
int	hashCode()
void	reset()	Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase

createFilterFromArguments, filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, toByteArray, toString, transformCell

Methods inherited from class org.apache.hadoop.hbase.filter.Filter

filterKeyValue, isReversed, parseFrom, setReversed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

expEvaluator

private final VisibilityExpEvaluator expEvaluator

cfVsMaxVersions

private final Map<ByteRange,Integer> cfVsMaxVersions

curFamily

private final ByteRange curFamily

curQualifier

private final ByteRange curQualifier

curFamilyMaxVersions

private int curFamilyMaxVersions

curQualMetVersions

private int curQualMetVersions

Constructor Details

VisibilityLabelFilter

public VisibilityLabelFilter(VisibilityExpEvaluator expEvaluator,
 Map<ByteRange,Integer> cfVsMaxVersions)

Method Details

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws IOException

Description copied from class: Filter

Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed to Filter.filterCell(Cell) below. If Filter.filterAllRemaining() returns true, then Filter.filterRowKey(Cell) should also return true. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

filterRowKey in class FilterBase

Parameters:

cell - The first cell coming in the new row

Returns:

true, remove entire row, false, include the row (maybe).

Throws:

IOException - in case an I/O or an filter specific failure needs to be signaled.

filterCell

public Filter.ReturnCode filterCell(Cell cell)
                             throws IOException

Description copied from class: Filter

A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterCell needs to be consistent with it. filterCell can assume that filterRowKey has already been called for the row. If your filter returns ReturnCode.NEXT_ROW, it should return ReturnCode.NEXT_ROW until Filter.reset() is called just in case the caller calls for the next row. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

filterCell in class Filter

Parameters:

cell - the Cell in question

Returns:

code as described below

Throws:

IOException - in case an I/O or an filter specific failure needs to be signaled.

See Also:

• Filter.ReturnCode

reset

public void reset()
           throws IOException

Description copied from class: FilterBase

Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

reset in class FilterBase

Throws:

IOException - in case an I/O or an filter specific failure needs to be signaled.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object