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

Class EntryFilteringCursorImpl

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

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

All Implemented Interfaces:

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

public class EntryFilteringCursorImpl
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
implements EntryFilteringCursor

A Cursor which uses a list of filters to selectively return entries and/or modify the contents of entries. Uses lazy pre-fetching on positioning operations which means adding filters after creation will not miss candidate entries.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<EntryFilter>	filters the list of filters to be applied
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG the logger used by this class
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private SearchOperationContext	operationContext the parameters associated with the search operation
private org.apache.directory.api.ldap.model.entry.Entry	prefetched the first accepted search result that is pre fetched
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The SchemaManager
private org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	wrapped the underlying wrapped search results Cursor

Constructor Summary

Constructors

Constructor and Description
EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped, SearchOperationContext operationContext, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a new entry filtering Cursor over an existing Cursor using a no filter initially: more can be added later after creation.
EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped, SearchOperationContext operationContext, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, EntryFilter filter) Creates a new entry filtering Cursor over an existing Cursor using a single filter initially: more can be added later after creation.
EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped, SearchOperationContext operationContext, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, java.util.List<EntryFilter> filters) Creates a new entry filtering Cursor over an existing Cursor using a list of filters initially: more can be added later after creation.

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.
void	after(org.apache.directory.api.ldap.model.entry.Entry element)
void	afterLast()
boolean	available()
void	before(org.apache.directory.api.ldap.model.entry.Entry element)
void	beforeFirst()
void	close()
void	close(java.lang.Exception reason)
boolean	first()
org.apache.directory.api.ldap.model.entry.Entry	get()
java.util.List<EntryFilter>	getEntryFilters() Gets an unmodifiable list of EntryFilters applied.
SearchOperationContext	getOperationContext()
boolean	isAbandoned()
boolean	isClosed()
boolean	last()
boolean	next()
boolean	previous()
boolean	removeEntryFilter(EntryFilter filter)
void	setAbandoned(boolean abandoned)
void	setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)
java.lang.String	toString()
java.lang.String	toString(java.lang.String tabs)

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isFirst, isLast, iterator

Methods inherited from class java.lang.Object

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

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

isAfterLast, isBeforeFirst, isFirst, isLast

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

LOG

private static final org.slf4j.Logger LOG

the logger used by this class

LOG_CURSOR

private static final org.slf4j.Logger LOG_CURSOR

A dedicated log for cursors

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

wrapped

private final org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped

the underlying wrapped search results Cursor

operationContext

private final SearchOperationContext operationContext

the parameters associated with the search operation

schemaManager

private final org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The SchemaManager

filters

private final java.util.List<EntryFilter> filters

the list of filters to be applied

prefetched

private org.apache.directory.api.ldap.model.entry.Entry prefetched

the first accepted search result that is pre fetched

Constructor Detail

EntryFilteringCursorImpl

public EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped,
                                SearchOperationContext operationContext,
                                org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                EntryFilter filter)

Creates a new entry filtering Cursor over an existing Cursor using a single filter initially: more can be added later after creation.

Parameters:

wrapped - the underlying wrapped Cursor whose entries are filtered

searchControls - the controls of search that created this Cursor

invocation - the search operation invocation creating this Cursor

filter - a single filter to be used

EntryFilteringCursorImpl

public EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped,
                                SearchOperationContext operationContext,
                                org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Creates a new entry filtering Cursor over an existing Cursor using a no filter initially: more can be added later after creation.

Parameters:

wrapped - the underlying wrapped Cursor whose entries are filtered

searchControls - the controls of search that created this Cursor

invocation - the search operation invocation creating this Cursor

filter - a single filter to be used

EntryFilteringCursorImpl

public EntryFilteringCursorImpl(org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> wrapped,
                                SearchOperationContext operationContext,
                                org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                java.util.List<EntryFilter> filters)

Creates a new entry filtering Cursor over an existing Cursor using a list of filters initially: more can be added later after creation.

Parameters:

wrapped - the underlying wrapped Cursor whose entries are filtered

operationContext - the operation context that created this Cursor

invocation - the search operation invocation creating this Cursor

filters - a list of filters to be used

Method Detail

isAbandoned

public boolean isAbandoned()

setAbandoned

public void setAbandoned(boolean abandoned)

addEntryFilter

public boolean addEntryFilter(EntryFilter filter)

Description copied from interface: EntryFilteringCursor

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

Specified by:

addEntryFilter in interface EntryFilteringCursor

Parameters:

filter - a filter to apply to the entries

Returns:

the result of List.add(Object)

removeEntryFilter

public boolean removeEntryFilter(EntryFilter filter)

getEntryFilters

public java.util.List<EntryFilter> getEntryFilters()

Gets an unmodifiable list of EntryFilters applied.

Specified by:

getEntryFilters in interface EntryFilteringCursor

Returns:

an unmodifiable list of EntryFilters applied

getOperationContext

public SearchOperationContext getOperationContext()

Specified by:

getOperationContext in interface EntryFilteringCursor

Returns:

the operationContext

after

public void after(org.apache.directory.api.ldap.model.entry.Entry element)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

after in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

afterLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

available

public boolean available()

Specified by:

available in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

before

public void before(org.apache.directory.api.ldap.model.entry.Entry element)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

before in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

beforeFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

close

public void close(java.lang.Exception reason)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

setClosureMonitor

public final void setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

Specified by:

setClosureMonitor in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

setClosureMonitor in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

first in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

get

public org.apache.directory.api.ldap.model.entry.Entry get()
                                                    throws org.apache.directory.api.ldap.model.cursor.InvalidCursorPositionException

Specified by:

get in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.cursor.InvalidCursorPositionException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isClosed in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

last in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

next in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

previous in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

toString

public java.lang.String toString(java.lang.String tabs)

Specified by:

toString in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

toString in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

See Also:

Object.toString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()