APIdia Launch Partner

Top Fields Constructors Methods

com.sun.jndi.ldap

pack-priv final Class LdapRequest

Class Inheritance

extends Object

java.lang.Object
com.sun.jndi.ldap.LdapRequest

Imports

java.io.IOException, java.util.concurrent.BlockingQueue, .LinkedBlockingQueue, .TimeUnit, javax.naming.CommunicationException

Field Summary

Modifier and Type	Field and Description
private volatile boolean	cancelled
private static final BerDecoder	CANCELLED_MARKER
private static final String	CLOSE_MSG
private volatile boolean	completed
private static final BerDecoder	CONN_CLOSED_MARKER
private volatile boolean	connectionClosed
pack-priv final int	msgId
pack-priv LdapRequest	next
private final boolean	pauseAfterReceipt
private final BlockingQueue<BerDecoder>	replies

Constructor Summary

Access	Constructor and Description
pack-priv	LdapRequest(int msgId, boolean pause, int replyQueueCapacity)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	addReplyBer(BerDecoder ber)
pack-priv void	cancel()
pack-priv void	connectionClosed()
pack-priv BerDecoder	Returns: BerDecoder if reply was read successfully getReplyBer(long timeout, infinite if the value is negative millis) Read reply BER
pack-priv boolean	hasSearchCompleted()
pack-priv boolean	Returns: true if an "abandon request" may be sent for this request, false otherwise shouldAbandonRequest() Returns true if an "abandon request" may be sent for this request, false otherwise.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancelled	back to summary
private volatile boolean cancelled

CANCELLED_MARKER	back to summary
private static final BerDecoder CANCELLED_MARKER

CLOSE_MSG	back to summary
private static final String CLOSE_MSG

completed	back to summary
private volatile boolean completed

CONN_CLOSED_MARKER	back to summary
private static final BerDecoder CONN_CLOSED_MARKER

connectionClosed	back to summary
private volatile boolean connectionClosed

msgId	back to summary
pack-priv final int msgId

next	back to summary
pack-priv LdapRequest next

pauseAfterReceipt	back to summary
private final boolean pauseAfterReceipt

replies	back to summary
private final BlockingQueue<BerDecoder> replies

Constructor Detail

LdapRequest	back to summary
pack-priv LdapRequest(int msgId, boolean pause, int replyQueueCapacity)

Method Detail

addReplyBer	back to summary
pack-priv boolean addReplyBer(BerDecoder ber)

cancel	back to summary
pack-priv void cancel()

connectionClosed	back to summary
pack-priv void connectionClosed()

getReplyBer

back to summary

pack-priv BerDecoder getReplyBer(long millis) throws IOException, CommunicationException, InterruptedException

Read reply BER

Parameters

millis:long: timeout, infinite if the value is negative

Returns:BerDecoder

BerDecoder if reply was read successfully

Exceptions

IOException:: request has been closed or timed out. Request needs to be abandoned (i.e. a LDAP_REQ_ABANDON message needs to be sent across)
CommunicationException:: request has been canceled and request does not need to be abandoned (i.e. a LDAP_REQ_ABANDON message need not be sent across)
InterruptedException:: the wait to read a reply has been interrupted

hasSearchCompleted	back to summary
pack-priv boolean hasSearchCompleted()

shouldAbandonRequest

back to summary

pack-priv boolean shouldAbandonRequest()

Returns true if an "abandon request" may be sent for this request, false otherwise.

Returns:boolean: true if an "abandon request" may be sent for this request, false otherwise