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

Interface EntryFilter

public interface EntryFilter

An entry filter is used to modify search results while they are being returned from Cursors over ServerEntry objects. These filters are used in conjunction with a FilteringCursor. Multiple filters can be applied one after the other and hence they are stack-able and applied in order.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
boolean	accept(SearchOperationContext operation, org.apache.directory.api.ldap.model.entry.Entry result) Filters the contents of search entries on the way out the door to client callers.
String	toString(String tabs) The pretty-printer for this class

Method Detail

accept

boolean accept(SearchOperationContext operation,
               org.apache.directory.api.ldap.model.entry.Entry result)
        throws org.apache.directory.api.ldap.model.exception.LdapException

Filters the contents of search entries on the way out the door to client callers. These filters can and do produce side-effects on the entry results if need be. These entries, their attributes and values should be cloned when alterations are made to avoid altering cached entries.

Parameters:

result - the result to accept or reject possibly modifying it

controls - search controls associated with the invocation

Returns:

true if the entry is to be returned, false if it is rejected

Throws:

Exception - if there are failures during evaluation

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

toString

String toString(String tabs)

The pretty-printer for this class

Parameters:

tabs - The tabs to add before each line

Returns:

The pretty-printed instance