com.unboundid.ldap.sdk.unboundidds.controls

Class ExcludeBranchRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.ExcludeBranchRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ExcludeBranchRequestControl
extends Control

This class provides a request control which may be used to request that entries below one or more base DNs be excluded from the results returned to a client while processing a search operation. For example, this may be useful in cases where you want to perform a search below "dc=example,dc=com", but want to exclude all entries below "ou=private,dc=example,dc=com".

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

The criticality for this control may be either true or false. It must have a value with the following encoding:

   ExcludeBranchRequest ::= SEQUENCE {
        baseDNs     [0] SEQUENCE OF LDAPDN,
        ... }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXCLUDE_BRANCH_REQUEST_OID The OID (1.3.6.1.4.1.30221.2.5.17) for the exclude branch request control.

Constructor Summary

Constructors

Constructor and Description
ExcludeBranchRequestControl(boolean isCritical, java.util.Collection<java.lang.String> baseDNs) Creates a new exclude branch request control with the provided information.
ExcludeBranchRequestControl(boolean isCritical, java.lang.String... baseDNs) Creates a new exclude branch request control with the provided information.
ExcludeBranchRequestControl(java.util.Collection<java.lang.String> baseDNs) Creates a new exclude branch request control with the provided set of base DNs.
ExcludeBranchRequestControl(Control control) Creates a new exclude branch request control which is decoded from the provided generic control.
ExcludeBranchRequestControl(java.lang.String... baseDNs) Creates a new exclude branch request control with the provided set of base DNs.

Method Summary

Modifier and Type	Method and Description
static ExcludeBranchRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of an exclude branch request control.
java.util.List<java.lang.String>	getBaseDNs() Retrieves a list of the base DNs for entries to exclude from the search results.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this exclude branch request control as a JSON object.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP control to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.Control

decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXCLUDE_BRANCH_REQUEST_OID

@NotNull
public static final java.lang.String EXCLUDE_BRANCH_REQUEST_OID

The OID (1.3.6.1.4.1.30221.2.5.17) for the exclude branch request control.

See Also:

Constant Field Values

Constructor Detail

ExcludeBranchRequestControl

public ExcludeBranchRequestControl(@NotNull
                                   java.util.Collection<java.lang.String> baseDNs)

Creates a new exclude branch request control with the provided set of base DNs. It will be marked critical.

Parameters:

baseDNs - The base DNs for entries to be excluded from search results. It must not be null or empty.

ExcludeBranchRequestControl

public ExcludeBranchRequestControl(@NotNull
                                   java.lang.String... baseDNs)

Creates a new exclude branch request control with the provided set of base DNs. It will be marked critical.

Parameters:

baseDNs - The base DNs for entries to be excluded from search results. It must not be null or empty.

ExcludeBranchRequestControl

public ExcludeBranchRequestControl(boolean isCritical,
                                   @NotNull
                                   java.lang.String... baseDNs)

Creates a new exclude branch request control with the provided information.

Parameters:

isCritical - Indicates whether the control should be marked critical.

baseDNs - The base DNs for entries to be excluded from search results. It must not be null or empty.

ExcludeBranchRequestControl

public ExcludeBranchRequestControl(boolean isCritical,
                                   @NotNull
                                   java.util.Collection<java.lang.String> baseDNs)

Creates a new exclude branch request control with the provided information.

Parameters:

isCritical - Indicates whether the control should be marked critical.

baseDNs - The base DNs for entries to be excluded from search results. It must not be null or empty.

ExcludeBranchRequestControl

public ExcludeBranchRequestControl(@NotNull
                                   Control control)
                            throws LDAPException

Creates a new exclude branch request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as an exclude branch request control.

Throws:

LDAPException - If the provided control cannot be decoded as an exclude branch request control.

Method Detail

getBaseDNs

@NotNull
public java.util.List<java.lang.String> getBaseDNs()

Retrieves a list of the base DNs for entries to exclude from the search results.

Returns:

A list of the base DNs for entries to exclude from the search results.

getControlName

@NotNull
public java.lang.String getControlName()

Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:

getControlName in class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this exclude branch request control as a JSON object. The JSON object uses the following fields:

• oid -- A mandatory string field whose value is the object identifier for this control. For the exclude branch request control, the OID is "1.3.6.1.4.1.30221.2.5.17".
• control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
• criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
• value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this exclude branch request control. Exactly one of the value-base64 and value-json fields must be present.
• value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this exclude branch request control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
  • base-dns -- A mandatory, non-empty array field whose values must be strings that represent the base DNs of branches to exclude from the search results.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static ExcludeBranchRequestControl decodeJSONControl(@NotNull
                                                                     JSONObject controlObject,
                                                                     boolean strict)
                                                              throws LDAPException

Attempts to decode the provided object as a JSON representation of an exclude branch request control.

Parameters:

controlObject - The JSON object to be decoded. It must not be null.

strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.

Returns:

The exclude branch request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid exclude branch request control.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

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

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which to append the string representation of this buffer.