org.ietf.ldap
Class LDAPSearchQueue

java.lang.Object
  org.ietf.ldap.LDAPSearchQueue

All Implemented Interfaces:

LDAPMessageQueue

public class LDAPSearchQueue

extends java.lang.Object

implements LDAPMessageQueue

A mechanism for queuing asynchronous search results and references received from a server.

See Also:

com.novell.ldap.LDAPSearchQueue

Field Summary

private LDAPSearchQueue

queue

Constructor Summary

(package private)

LDAPSearchQueue(LDAPSearchQueue queue) Constructs a response queue from a com.novell.ldap.LDAPSearchQueue

Method Summary

int[]	getMessageIDs() Returns the message IDs for all outstanding requests.
LDAPMessage	getResponse() Blocks until a response is available, or until all operations associated with the object have completed or been canceled, and returns the response.
LDAPMessage	getResponse(int msgid) Blocks until a response is available for a particular message id, or until all operations associated with the object have completed or been canceled, and returns the response.
(package private) LDAPSearchQueue	getWrappedObject() Returns a com.novell.ldap.LDAPSearchQueue object
boolean	isComplete(int msgid) Reports true if all results have been received for a particular message id.
boolean	isResponseReceived() Reports whether a response has been received from the server and not yet retrieved with getResponse.
boolean	isResponseReceived(int msgid) Reports whether a response has been received from the server and not yet retrieved with getResponse.
void	merge(LDAPMessageQueue queue2) Merges two response queues by moving the contents from another queue to this one.

Methods inherited from class java.lang.Object

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

Field Detail

queue

private LDAPSearchQueue queue

Constructor Detail

LDAPSearchQueue

LDAPSearchQueue(LDAPSearchQueue queue)

Constructs a response queue from a com.novell.ldap.LDAPSearchQueue

Method Detail

getWrappedObject

LDAPSearchQueue getWrappedObject()

Returns a com.novell.ldap.LDAPSearchQueue object

getMessageIDs

public int[] getMessageIDs()

Returns the message IDs for all outstanding requests.

Specified by:

getMessageIDs in interface LDAPMessageQueue

See Also:

com.novell.ldap.LDAPSearchQueue.getMessageIDs()

isResponseReceived

public boolean isResponseReceived()

Reports whether a response has been received from the server and not yet retrieved with getResponse.

Specified by:

isResponseReceived in interface LDAPMessageQueue

See Also:

com.novell.ldap.LDAPSearchQueue.isResponseReceived()

isResponseReceived

public boolean isResponseReceived(int msgid)

Reports whether a response has been received from the server and not yet retrieved with getResponse.

Specified by:

isResponseReceived in interface LDAPMessageQueue

See Also:

com.novell.ldap.LDAPSearchQueue.isResponseReceived(int)

merge

public void merge(LDAPMessageQueue queue2)

Merges two response queues by moving the contents from another queue to this one.

Specified by:

merge in interface LDAPMessageQueue

See Also:

com.novell.ldap.LDAPSearchQueue.merge( LDAPResponsequeue)

isComplete

public boolean isComplete(int msgid)

Reports true if all results have been received for a particular message id.

See Also:

com.novell.ldap.LDAPSearchQueue.isComplete(int)

getResponse

public LDAPMessage getResponse()
                        throws LDAPException

Blocks until a response is available, or until all operations associated with the object have completed or been canceled, and returns the response.

Specified by:

getResponse in interface LDAPMessageQueue

Throws:

LDAPException

See Also:

com.novell.ldap.LDAPSearchQueue.getResponse()

getResponse

public LDAPMessage getResponse(int msgid)
                        throws LDAPException

Blocks until a response is available for a particular message id, or until all operations associated with the object have completed or been canceled, and returns the response.

Specified by:

getResponse in interface LDAPMessageQueue

Throws:

LDAPException

See Also:

com.novell.ldap.LDAPSearchQueue.getResponse(int)