Package org.forgerock.opendj.io

Class LDAPWriter<W extends ASN1Writer>

java.lang.Object

org.forgerock.opendj.io.LDAPWriter<W>

Type Parameters:

W - The type of ASN.1 writer used for encoding elements.

public final class LDAPWriter<W extends ASN1Writer>
extends Object

Writes LDAP messages to an underlying ASN.1 writer.

Methods for creating LDAPWriters are provided in the LDAP class.

Method Summary

Modifier and Type	Method	Description
W	getASN1Writer()	Returns the ASN.1 writer to which LDAP messages will be written.
int	getProtocolVersion()	Returns the protocol version supported by this LDAPWriter.
void	writeAbandonRequest(int messageID, AbandonRequest request)	Writes the provided abandon request.
void	writeAddRequest(int messageID, AddRequest request)	Writes the provided add request.
void	writeAddResult(int messageID, Result result)	Writes the provided add result.
void	writeBindRequest(int messageID, int version, GenericBindRequest request)	Writes the provided bind request.
void	writeBindResult(int messageID, BindResult result)	Writes the provided bind result.
void	writeCompareRequest(int messageID, CompareRequest request)	Writes the provided compare request.
void	writeCompareResult(int messageID, CompareResult result)	Writes the provided compare result.
void	writeControl(Control control)	Writes the provided control.
void	writeDeleteRequest(int messageID, DeleteRequest request)	Writes the provided delete request.
void	writeDeleteResult(int messageID, Result result)	Writes the provided delete result.
void	writeExtendedRequest(int messageID, ExtendedRequest<?> request)	Writes the provided extended request.
void	writeExtendedResult(int messageID, ExtendedResult result)	Writes the provided extended result.
void	writeIntermediateResponse(int messageID, IntermediateResponse response)	Writes the provided intermediate response.
void	writeModifyDNRequest(int messageID, ModifyDNRequest request)	Writes the provided modify DN request.
void	writeModifyDNResult(int messageID, Result result)	Writes the provided modify DN result.
void	writeModifyRequest(int messageID, ModifyRequest request)	Writes the provided modify request.
void	writeModifyResult(int messageID, Result result)	Writes the provided extended result.
void	writeSearchRequest(int messageID, SearchRequest request)	Writes the provided search request.
void	writeSearchResult(int messageID, Result result)	Writes the provided search result.
void	writeSearchResultEntry(int messageID, SearchResultEntry entry)	Writes the provided search result entry.
void	writeSearchResultReference(int messageID, SearchResultReference reference)	Writes the provided search result reference.
void	writeUnbindRequest(int messageID, UnbindRequest request)	Writes the provided unbind request.
void	writeUnrecognizedMessage(int messageID, byte messageTag, ByteString messageBytes)	Writes a message with the provided id, tag and content bytes.

Methods inherited from class java.lang.Object

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

Method Details

getProtocolVersion

public int getProtocolVersion()

Returns the protocol version supported by this LDAPWriter.

Returns:

The protocol version supported by this LDAPWriter

getASN1Writer

public W getASN1Writer()

Returns the ASN.1 writer to which LDAP messages will be written.

Returns:

The ASN.1 writer to which LDAP messages will be written.

writeAbandonRequest

public void writeAbandonRequest(int messageID,
 AbandonRequest request)
                         throws IOException

Writes the provided abandon request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeAddRequest

public void writeAddRequest(int messageID,
 AddRequest request)
                     throws IOException

Writes the provided add request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeAddResult

public void writeAddResult(int messageID,
 Result result)
                    throws IOException

Writes the provided add result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeBindRequest

public void writeBindRequest(int messageID,
 int version,
 GenericBindRequest request)
                      throws IOException

Writes the provided bind request.

Parameters:

messageID - The LDAP message ID.

version - The requested LDAP protocol version.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeBindResult

public void writeBindResult(int messageID,
 BindResult result)
                     throws IOException

Writes the provided bind result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeCompareRequest

public void writeCompareRequest(int messageID,
 CompareRequest request)
                         throws IOException

Writes the provided compare request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeCompareResult

public void writeCompareResult(int messageID,
 CompareResult result)
                        throws IOException

Writes the provided compare result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeControl

public void writeControl(Control control)
                  throws IOException

Writes the provided control.

Parameters:

control - The control.

Throws:

IOException - If an unexpected IO error occurred.

writeDeleteRequest

public void writeDeleteRequest(int messageID,
 DeleteRequest request)
                        throws IOException

Writes the provided delete request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeDeleteResult

public void writeDeleteResult(int messageID,
 Result result)
                       throws IOException

Writes the provided delete result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeExtendedRequest

public void writeExtendedRequest(int messageID,
 ExtendedRequest<?> request)
                          throws IOException

Writes the provided extended request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeExtendedResult

public void writeExtendedResult(int messageID,
 ExtendedResult result)
                         throws IOException

Writes the provided extended result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeIntermediateResponse

public void writeIntermediateResponse(int messageID,
 IntermediateResponse response)
                               throws IOException

Writes the provided intermediate response.

Parameters:

messageID - The LDAP message ID.

response - The response.

Throws:

IOException - If an unexpected IO error occurred.

writeModifyDNRequest

public void writeModifyDNRequest(int messageID,
 ModifyDNRequest request)
                          throws IOException

Writes the provided modify DN request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeModifyDNResult

public void writeModifyDNResult(int messageID,
 Result result)
                         throws IOException

Writes the provided modify DN result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeModifyRequest

public void writeModifyRequest(int messageID,
 ModifyRequest request)
                        throws IOException

Writes the provided modify request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeModifyResult

public void writeModifyResult(int messageID,
 Result result)
                       throws IOException

Writes the provided extended result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeSearchRequest

public void writeSearchRequest(int messageID,
 SearchRequest request)
                        throws IOException

Writes the provided search request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeSearchResult

public void writeSearchResult(int messageID,
 Result result)
                       throws IOException

Writes the provided search result.

Parameters:

messageID - The LDAP message ID.

result - The result.

Throws:

IOException - If an unexpected IO error occurred.

writeSearchResultEntry

public void writeSearchResultEntry(int messageID,
 SearchResultEntry entry)
                            throws IOException

Writes the provided search result entry.

Parameters:

messageID - The LDAP message ID.

entry - The entry.

Throws:

IOException - If an unexpected IO error occurred.

writeSearchResultReference

public void writeSearchResultReference(int messageID,
 SearchResultReference reference)
                                throws IOException

Writes the provided search result reference.

Parameters:

messageID - The LDAP message ID.

reference - The reference.

Throws:

IOException - If an unexpected IO error occurred.

writeUnbindRequest

public void writeUnbindRequest(int messageID,
 UnbindRequest request)
                        throws IOException

Writes the provided unbind request.

Parameters:

messageID - The LDAP message ID.

request - The request.

Throws:

IOException - If an unexpected IO error occurred.

writeUnrecognizedMessage

public void writeUnrecognizedMessage(int messageID,
 byte messageTag,
 ByteString messageBytes)
                              throws IOException

Writes a message with the provided id, tag and content bytes.

Parameters:

messageID - The LDAP message ID.

messageTag - The LDAP message type.

messageBytes - The contents of the LDAP message.

Throws:

IOException - If an unexpected IO error occurred.