Package org.apache.accumulo.core.iterators.user

Class VisibilityFilter

java.lang.Object

org.apache.accumulo.core.iterators.WrappingIterator

org.apache.accumulo.core.iterators.Filter

org.apache.accumulo.core.iterators.user.VisibilityFilter

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>, YieldingKeyValueIterator<Key,Value>

public class VisibilityFilter
extends Filter
implements OptionDescriber

A SortedKeyValueIterator that filters based on ColumnVisibility.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber

OptionDescriber.IteratorOptions

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.commons.collections4.map.LRUMap<ByteSequence,Boolean>	cache
protected VisibilityEvaluator	ve

Fields inherited from class org.apache.accumulo.core.iterators.Filter

NEGATE

Constructor Summary

Constructors

Constructor	Description
VisibilityFilter()

Method Summary

Modifier and Type	Method	Description
boolean	accept(Key k, Value v)
OptionDescriber.IteratorOptions	describeOptions()	Gets an iterator options object that contains information needed to configure this iterator.
static void	filterInvalidLabelsOnly(IteratorSetting setting, boolean featureEnabled)
void	init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env)	Initializes the iterator.
static void	setAuthorizations(IteratorSetting setting, Authorizations auths)

Methods inherited from class org.apache.accumulo.core.iterators.Filter

deepCopy, findTop, next, seek, setNegate, validateOptions

Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator

getSource, getTopKey, getTopValue, hasTop, setSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.accumulo.core.iterators.OptionDescriber

validateOptions

Methods inherited from interface org.apache.accumulo.core.iterators.YieldingKeyValueIterator

enableYielding

Field Detail

ve

protected VisibilityEvaluator ve

cache

protected org.apache.commons.collections4.map.LRUMap<ByteSequence,Boolean> cache

Constructor Detail

VisibilityFilter

public VisibilityFilter()

Method Detail

init

public void init(SortedKeyValueIterator<Key,Value> source,
                 Map<String,String> options,
                 IteratorEnvironment env)
          throws IOException

Description copied from interface: SortedKeyValueIterator

Initializes the iterator. Data should not be read from the source in this method.

Specified by:

init in interface SortedKeyValueIterator<Key,Value>

Overrides:

init in class Filter

Parameters:

source - SortedKeyValueIterator source to read data from.

options - Map map of string option names to option values.

env - IteratorEnvironment environment in which iterator is being run.

Throws:

IOException - unused.

accept

public boolean accept(Key k,
                      Value v)

Specified by:

accept in class Filter

Returns:

true if the key/value pair is accepted by the filter.

describeOptions

public OptionDescriber.IteratorOptions describeOptions()

Description copied from interface: OptionDescriber

Gets an iterator options object that contains information needed to configure this iterator. This object will be used by the accumulo shell to prompt the user to input the appropriate information.

Specified by:

describeOptions in interface OptionDescriber

Overrides:

describeOptions in class Filter

Returns:

an iterator options object

setAuthorizations

public static void setAuthorizations(IteratorSetting setting,
                                     Authorizations auths)

filterInvalidLabelsOnly

public static void filterInvalidLabelsOnly(IteratorSetting setting,
                                           boolean featureEnabled)