org.ldaptive.provider.opendj

Class OpenDJConnection.OpenDJSearchIterator

java.lang.Object

org.ldaptive.provider.opendj.OpenDJConnection.AbstractOpenDJSearch

org.ldaptive.provider.opendj.OpenDJConnection.OpenDJSearchIterator

All Implemented Interfaces:

SearchIterator

Enclosing class:

OpenDJConnection

protected class OpenDJConnection.OpenDJSearchIterator
extends OpenDJConnection.AbstractOpenDJSearch
implements SearchIterator

Search iterator for opendj search results.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	OpenDJConnection.OpenDJSearchIterator.SearchResultIterator Search results handler for storing entries returned by a search operation.

Field Summary

Fields

Modifier and Type	Field and Description
private Response<Void>	response Response data.
private OpenDJConnection.OpenDJSearchIterator.SearchResultIterator	resultIterator Search result iterator.

Fields inherited from class org.ldaptive.provider.opendj.OpenDJConnection.AbstractOpenDJSearch

request, util

Constructor Summary

Constructors

Constructor and Description
OpenDJSearchIterator(SearchRequest sr) Creates a new opendj search iterator.

Method Summary

Modifier and Type	Method and Description
void	close() Close any resources associated with this iterator.
Response<Void>	getResponse() Returns the response data associated with this search or null if this iterator has more ldap entries to return.
boolean	hasNext() Returns true if the iteration has more elements.
void	initialize() Initializes this opendj search iterator.
SearchItem	next() Returns the next element in the iteration.
protected OpenDJConnection.OpenDJSearchIterator.SearchResultIterator	search(org.forgerock.opendj.ldap.Connection conn, SearchRequest sr) Executes an ldap search.

Methods inherited from class org.ldaptive.provider.opendj.OpenDJConnection.AbstractOpenDJSearch

getDereferencePolicy, getSearchRequest, getSearchScope, ignoreSearchException, processIntermediateResponse, processSearchResultEntry, processSearchResultReference

Methods inherited from class java.lang.Object

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

Field Detail

response

private Response<Void> response

Response data.

resultIterator

private OpenDJConnection.OpenDJSearchIterator.SearchResultIterator resultIterator

Search result iterator.

Constructor Detail

OpenDJSearchIterator

public OpenDJSearchIterator(SearchRequest sr)

Creates a new opendj search iterator.

Parameters:

sr - search request

Method Detail

initialize

public void initialize()
                throws LdapException

Initializes this opendj search iterator.

Throws:

LdapException - if an error occurs

search

protected OpenDJConnection.OpenDJSearchIterator.SearchResultIterator search(org.forgerock.opendj.ldap.Connection conn,
                                                                            SearchRequest sr)
                                                                     throws LdapException

Executes an ldap search.

Parameters:

conn - to search with

sr - to read properties from

Returns:

ldap search results

Throws:

LdapException - if an error occurs

hasNext

public boolean hasNext()
                throws LdapException

Description copied from interface: SearchIterator

Returns true if the iteration has more elements.

Specified by:

hasNext in interface SearchIterator

Returns:

true if the iterator has more elements

Throws:

LdapException - if an error occurs

next

public SearchItem next()
                throws LdapException

Description copied from interface: SearchIterator

Returns the next element in the iteration.

Specified by:

next in interface SearchIterator

Returns:

the next element in the iteration

Throws:

LdapException - if an error occurs

getResponse

public Response<Void> getResponse()

Description copied from interface: SearchIterator

Returns the response data associated with this search or null if this iterator has more ldap entries to return.

Specified by:

getResponse in interface SearchIterator

Returns:

response data

close

public void close()
           throws LdapException

Description copied from interface: SearchIterator

Close any resources associated with this iterator.

Specified by:

close in interface SearchIterator

Throws:

LdapException - if an error occurs