org.apache.directory.server.core.api.filtering

Interface EntryFilteringCursor

All Superinterfaces:

org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>, java.lang.Iterable<org.apache.directory.api.ldap.model.entry.Entry>

All Known Implementing Classes:

CursorList, EntryFilteringCursorImpl, SortedEntryCursor

public interface EntryFilteringCursor
extends org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

A wrapper on top of a Cursor used to filter entries we get from the backend.

Method Summary

Modifier and Type	Method and Description
boolean	addEntryFilter(EntryFilter filter) Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list.
java.util.List<EntryFilter>	getEntryFilters() Gets an unmodifiable list of EntryFilters applied.
SearchOperationContext	getOperationContext()

Methods inherited from interface org.apache.directory.api.ldap.model.cursor.Cursor

after, afterLast, available, before, beforeFirst, close, close, first, get, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, last, next, previous, setClosureMonitor, toString

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

addEntryFilter

boolean addEntryFilter(EntryFilter filter)

Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. EntryFilters are applied in the order of addition.

Parameters:

filter - a filter to apply to the entries

Returns:

the result of List.add(Object)

getEntryFilters

java.util.List<EntryFilter> getEntryFilters()

Gets an unmodifiable list of EntryFilters applied.

Returns:

an unmodifiable list of EntryFilters applied

getOperationContext

SearchOperationContext getOperationContext()

Returns:

the operationContext