Package org.forgerock.opendj.io

Class LDAPReader<R extends ASN1Reader>

java.lang.Object

org.forgerock.opendj.io.LDAPReader<R>

Type Parameters:

R - The type of ASN.1 reader used for decoding elements.

public final class LDAPReader<R extends ASN1Reader>
extends Object

Reads LDAP messages from an underlying ASN.1 reader.

Method Summary

Modifier and Type	Method	Description
R	getASN1Reader()	Returns the ASN.1 reader from which LDAP messages will be read.
boolean	hasMessageAvailable()	Returns true if the next LDAP message can be read without blocking.
void	readMessage(LDAPMessageHandler handler)	Reads the next LDAP message from the underlying ASN.1 reader.

Methods inherited from class java.lang.Object

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

Method Details

getASN1Reader

public R getASN1Reader()

Returns the ASN.1 reader from which LDAP messages will be read.

Returns:

The ASN.1 reader from which LDAP messages will be read.

hasMessageAvailable

public boolean hasMessageAvailable()
                            throws DecodeException,
IOException

Returns true if the next LDAP message can be read without blocking.

Returns:

true if the next LDAP message can be read without blocking or false otherwise.

Throws:

DecodeException - If the available data was not a valid LDAP message.

IOException - If an unexpected IO error occurred.

readMessage

public void readMessage(LDAPMessageHandler handler)
                 throws DecodeException,
IOException

Reads the next LDAP message from the underlying ASN.1 reader.

Parameters:

handler - The message handler which will handle the decoded LDAP message.

Throws:

DecodeException - If the available data was not a valid LDAP message.

IOException - If an unexpected IO error occurred.