org.ldaptive.provider.jldap

Class JLdapConnection.SearchResultIterator

java.lang.Object

org.ldaptive.provider.jldap.JLdapConnection.SearchResultIterator

Enclosing class:

JLdapConnection

protected static class JLdapConnection.SearchResultIterator
extends Object

Iterates over an ldap search queue.

Field Summary

Fields

Modifier and Type	Field and Description
private com.novell.ldap.LDAPMessage	message Last response message received from the queue.
private com.novell.ldap.LDAPSearchQueue	queue Queue to iterate over.
private com.novell.ldap.LDAPResponse	response Response available after all messages have been received.

Constructor Summary

Constructors

Constructor and Description
SearchResultIterator(com.novell.ldap.LDAPSearchQueue q) Create a new ldap result iterator.

Method Summary

Modifier and Type	Method and Description
com.novell.ldap.LDAPSearchQueue	getLDAPSearchQueue() Returns the search queue used by this iterator.
com.novell.ldap.LDAPResponse	getResponse() Returns the search response.
boolean	hasNext() Returns whether the queue has another message to read.
com.novell.ldap.LDAPMessage	next() Returns the next message in the queue.

Methods inherited from class java.lang.Object

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

Field Detail

queue

private final com.novell.ldap.LDAPSearchQueue queue

Queue to iterate over.

message

private com.novell.ldap.LDAPMessage message

Last response message received from the queue.

response

private com.novell.ldap.LDAPResponse response

Response available after all messages have been received.

Constructor Detail

SearchResultIterator

public SearchResultIterator(com.novell.ldap.LDAPSearchQueue q)

Create a new ldap result iterator.

Parameters:

q - ldap search queue

Method Detail

getLDAPSearchQueue

public com.novell.ldap.LDAPSearchQueue getLDAPSearchQueue()

Returns the search queue used by this iterator.

Returns:

ldap search queue

hasNext

public boolean hasNext()
                throws com.novell.ldap.LDAPException

Returns whether the queue has another message to read.

Returns:

whether the queue has another message to read

Throws:

com.novell.ldap.LDAPException - if an error occurs reading the response

next

public com.novell.ldap.LDAPMessage next()

Returns the next message in the queue.

Returns:

ldap message

getResponse

public com.novell.ldap.LDAPResponse getResponse()

Returns the search response. Available after all messages have been read from the queue.

Returns:

ldap search response