org.apache.directory.server.core.filtering
Interface EntryFilter

All Known Implementing Classes:
SubentryInterceptor.HideEntriesFilter, SubentryInterceptor.HideSubentriesFilter

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.

Version:
$Rev$
Author:
Apache Directory Project

Method Summary
 boolean accept(SearchingOperationContext operation, ClonedServerEntry result)
          Filters the contents of search entries on the way out the door to client callers.
 

Method Detail

accept

boolean accept(SearchingOperationContext operation,
               ClonedServerEntry result)
               throws java.lang.Exception
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:
java.lang.Exception - if there are failures during evaluation


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.