org.ldaptive.provider.jldap

Class JLdapConnection.JLdapSearchIterator

java.lang.Object

org.ldaptive.provider.jldap.JLdapConnection.AbstractJLdapSearch

org.ldaptive.provider.jldap.JLdapConnection.JLdapSearchIterator

All Implemented Interfaces:

SearchIterator

Enclosing class:

JLdapConnection

protected class JLdapConnection.JLdapSearchIterator
extends JLdapConnection.AbstractJLdapSearch
implements SearchIterator

Search iterator for JLdap search results.

Field Summary

Fields

Modifier and Type	Field and Description
private Response<Void>	response Response data.
private JLdapConnection.SearchResultIterator	resultIterator Ldap search result iterator.

Fields inherited from class org.ldaptive.provider.jldap.JLdapConnection.AbstractJLdapSearch

request, util

Constructor Summary

Constructors

Constructor and Description
JLdapSearchIterator(SearchRequest sr) Creates a new jldap 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 jldap search iterator.
SearchItem	next() Returns the next element in the iteration.

Methods inherited from class org.ldaptive.provider.jldap.JLdapConnection.AbstractJLdapSearch

getLDAPSearchConstraints, getSearchScope, ignoreSearchException, processLDAPIntermediateResponse, processLDAPSearchResult, processLDAPSearchResultReference, search

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 JLdapConnection.SearchResultIterator resultIterator

Ldap search result iterator.

Constructor Detail

JLdapSearchIterator

public JLdapSearchIterator(SearchRequest sr)

Creates a new jldap search iterator.

Parameters:

sr - search request

Method Detail

initialize

public void initialize()
                throws LdapException

Initializes this jldap search iterator.

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