org.opends.server.controls
Class LDAPAssertionRequestControl

java.lang.Object
  extended by org.opends.server.types.Control
      extended by 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.


Constructor Summary
LDAPAssertionRequestControl(boolean isCritical, LDAPFilter rawFilter)
          Creates a new instance of this LDAP assertion request control with the provided information.
LDAPAssertionRequestControl(java.lang.String oid, boolean isCritical, LDAPFilter rawFilter)
          Creates a new instance of this LDAP assertion request control with the provided information.
 
Method Summary
static LDAPAssertionRequestControl decodeControl(Control control)
          Creates a new LDAP assertion request control from the contents of the provided control.
 LDAPFilter getRawFilter()
          Retrieves the raw, unparsed filter from the request control.
 SearchFilter getSearchFilter()
          Retrieves the processed search filter for this control.
 void setRawFilter(LDAPFilter rawFilter)
          Sets the raw, unparsed filter from the request control.
 java.lang.String toString()
          Retrieves a string representation of this LDAP assertion request control.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP assertion request control to the provided buffer.
 
Methods inherited from class org.opends.server.types.Control
getOID, getValue, hasValue, isCritical, setCritical, setOID, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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.

LDAPAssertionRequestControl

public LDAPAssertionRequestControl(java.lang.String oid,
                                   boolean isCritical,
                                   LDAPFilter rawFilter)
Creates a new instance of this LDAP assertion request control with the provided information.

Parameters:
oid - The OID to use for this control.
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

decodeControl

public static LDAPAssertionRequestControl decodeControl(Control control)
                                                 throws LDAPException
Creates a new LDAP assertion request control from the contents of the provided control.

Parameters:
control - The generic control containing the information to use to create this LDAP assertion request control.
Returns:
The LDAP assertion control decoded from the provided control.
Throws:
LDAPException - If this control cannot be decoded as a valid LDAP assertion control.

getRawFilter

public LDAPFilter getRawFilter()
Retrieves the raw, unparsed filter from the request control.

Returns:
The raw, unparsed filter from the request control.

setRawFilter

public void setRawFilter(LDAPFilter rawFilter)
Sets the raw, unparsed filter from the request control. This method should only be called by pre-parse plugins.

Parameters:
rawFilter - 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 java.lang.String toString()
Retrieves a string representation of this LDAP assertion request control.

Overrides:
toString in class Control
Returns:
A string representation of this LDAP assertion request control.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP assertion request control to the provided buffer.

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which the information should be appended.