Package org.opends.server.controls

Class LDAPPreReadResponseControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.LDAPPreReadResponseControl

public class LDAPPreReadResponseControl
extends Control

This class implements the pre-read response control as defined in RFC 4527. This control holds the search result entry representing the state of the entry immediately before a modify, delete, or modify DN operation.

Field Summary

Fields

Modifier and Type	Field	Description
static ControlDecoder<LDAPPreReadResponseControl>	DECODER	The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor	Description
LDAPPreReadResponseControl(boolean isCritical, SearchResultEntry searchEntry)	Creates a new instance of this LDAP pre-read response control with the provided information.
LDAPPreReadResponseControl(SearchResultEntry searchEntry)	Creates a new instance of this LDAP pre-read response control with the provided information.

Method Summary

Modifier and Type	Method	Description
SearchResultEntry	getSearchEntry()	Retrieves the search result entry associated with this pre-read response control.
void	toString(StringBuilder buffer)	Appends a string representation of this LDAP pre-read response control to the provided buffer.
void	writeValue(ASN1Writer writer)	Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

DECODER

public static final ControlDecoder<LDAPPreReadResponseControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

LDAPPreReadResponseControl

public LDAPPreReadResponseControl(SearchResultEntry searchEntry)

Creates a new instance of this LDAP pre-read response control with the provided information.

Parameters:

searchEntry - The search result entry to include in the response control.

LDAPPreReadResponseControl

public LDAPPreReadResponseControl(boolean isCritical,
                                  SearchResultEntry searchEntry)

Creates a new instance of this LDAP pre-read response control with the provided information.

Parameters:

isCritical - Indicates whether support for this control should be considered a critical part of the server processing.

searchEntry - The search result entry to include in the response control.

Method Detail

writeValue

public void writeValue(ASN1Writer writer)
                throws IOException

Description copied from class: Control

Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 writer to use.

Throws:

IOException - If a problem occurs while writing to the stream.

getSearchEntry

public SearchResultEntry getSearchEntry()

Retrieves the search result entry associated with this pre-read response control.

Returns:

The search result entry associated with this pre-read response control.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this LDAP pre-read response control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which the information should be appended.