Class VisibilityLabelFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.security.visibility.VisibilityLabelFilter
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
Modifier and TypeFieldDescriptionprivate final ByteRange
private int
private final ByteRange
private int
private final VisibilityExpEvaluator
-
Constructor Summary
ConstructorDescriptionVisibilityLabelFilter
(VisibilityExpEvaluator expEvaluator, Map<ByteRange, Integer> cfVsMaxVersions) -
Method Summary
Modifier and TypeMethodDescriptionboolean
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
-
Field Details
-
expEvaluator
-
cfVsMaxVersions
-
curFamily
-
curQualifier
-
curFamilyMaxVersions
-
curQualMetVersions
-
-
Constructor Details
-
VisibilityLabelFilter
public VisibilityLabelFilter(VisibilityExpEvaluator expEvaluator, Map<ByteRange, Integer> cfVsMaxVersions)
-
-
Method Details
-
filterRowKey
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 toFilter.filterCell(Cell)
below. IfFilter.filterAllRemaining()
returns true, thenFilter.filterRowKey(Cell)
should also return true. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterRowKey
in classFilterBase
- 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
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 returnsReturnCode.NEXT_ROW
, it should returnReturnCode.NEXT_ROW
untilFilter.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 anIOException
.- Overrides:
filterCell
in classFilter
- 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:
-
reset
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 anIOException
.- Overrides:
reset
in classFilterBase
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
equals
-
hashCode
-