org.apache.directory.ldap.client.api.listener
Interface SearchListener

All Superinterfaces:
OperationResponseListener

public interface SearchListener
extends OperationResponseListener

A listener used for asynchronous search handling. When wanting to handle searches as a non-blocking operation, simply associate a SearchListener to the search operation : for each entry found, the listener will be called back, and so will it when the search will be done.

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Method Summary
 void entryFound(LdapConnection connection, SearchResultEntry searchResultEntry)
          A callback method for each entry returned by a search operation.
 void referralFound(LdapConnection connection, SearchResultReference searchResultReference)
          A callback method for each referral returned by a search operation.
 void searchDone(LdapConnection connection, SearchResultDone searchResultDone)
          A callback method called when the search is done.
 

Method Detail

entryFound

void entryFound(LdapConnection connection,
                SearchResultEntry searchResultEntry)
                throws LdapException
A callback method for each entry returned by a search operation.

Parameters:
connection - The LdapConnection
searchResultEntry - The found entry
Throws:
LdapException

referralFound

void referralFound(LdapConnection connection,
                   SearchResultReference searchResultReference)
                   throws LdapException
A callback method for each referral returned by a search operation.

Parameters:
connection - The LdapConnection
searchResultReference - The referral message
Throws:
LdapException

searchDone

void searchDone(LdapConnection connection,
                SearchResultDone searchResultDone)
                throws LdapException
A callback method called when the search is done.

Parameters:
connection - The LdapConnection
searchResultDone - The searchResultDone response
Throws:
LdapException


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