Package org.opends.server.controls

Class LDAPAssertionRequestControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.LDAPAssertionRequestControl

public class LDAPAssertionRequestControl
extends Control

This class implements the LDAP assertion request control as defined in RFC 4528. This control makes it possible to conditionally perform an operation if a given assertion is true. In particular, the associated operation should only be processed if the target entry matches the filter contained in this control.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
LDAPAssertionRequestControl(boolean isCritical, LDAPFilter rawFilter)	Creates a new instance of this LDAP assertion request control with the provided information.

Method Summary

Modifier and Type	Method	Description
LDAPFilter	getRawFilter()	Retrieves the raw, unparsed filter from the request control.
SearchFilter	getSearchFilter()	Retrieves the processed search filter for this control.
void	toString(StringBuilder buffer)	Appends a string representation of this 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<LDAPAssertionRequestControl> DECODER

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

Constructor Detail

LDAPAssertionRequestControl

public LDAPAssertionRequestControl(boolean isCritical,
                                   LDAPFilter rawFilter)

Creates a new instance of this LDAP assertion request control with the provided information.

Parameters:

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

rawFilter - The unparsed LDAP search filter contained in the request from the client.

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.

getRawFilter

public LDAPFilter getRawFilter()

Retrieves the raw, unparsed filter from the request control.

Returns:

The raw, unparsed filter from the request control.

getSearchFilter

public SearchFilter getSearchFilter()
                             throws DirectoryException

Retrieves the processed search filter for this control.

Returns:

The processed search filter for this control.

Throws:

DirectoryException - If a problem occurs while attempting to process the search filter.

toString

public void toString(StringBuilder buffer)

Description copied from class: Control

Appends a string representation of this control to the provided buffer.

Overrides:

toString in class Control

Parameters:

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