Package org.forgerock.opendj.io

Class LdapReader

java.lang.Object

org.forgerock.opendj.io.LdapReader

public final class LdapReader
extends Object

Reads LDAP messages from an underlying ASN.1 reader.

Methods for creating LdapReaders are provided in the Ldap class.

Method Summary

Modifier and Type	Method	Description
boolean	hasMessageAvailable()	Returns true if the next LDAP message can be read without blocking.
LdapMessage	readLdapMessage()	Reads the next LDAP message from the underlying ASN.1 reader.
LdapMessage	readLdapRequestMessage()	Reads the next LDAP request message from the underlying ASN.1 reader.
LdapMessage	readLdapResponseMessage()	Reads the next LDAP response 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 Detail

hasMessageAvailable

public boolean hasMessageAvailable()
                            throws 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.

readLdapMessage

public LdapMessage readLdapMessage()
                            throws IOException

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

Returns:

A fully decoded LdapMessage.

Throws:

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

IOException - If an unexpected IO error occurred.

readLdapRequestMessage

public LdapMessage readLdapRequestMessage()
                                   throws IOException

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

Returns:

A fully decoded LdapMessage wrapping a Request.

Throws:

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

IOException - If an unexpected IO error occurred.

readLdapResponseMessage

public LdapMessage readLdapResponseMessage()
                                    throws IOException

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

Returns:

A fully decoded LdapMessage wrapping a Response.

Throws:

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

IOException - If an unexpected IO error occurred.