com.unboundid.ldap.sdk.unboundidds.controls.OverrideSearchLimitsRequestControl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2018-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2018-2021 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2018-2021 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.controls;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of a control that may be included in a
* search request to override certain default limits that would normally be in
* place for the operation. The override behavior is specified using one or
* more name-value pairs, with property names being case sensitive.
*
*
* NOTE: This class, and other classes within the
* {@code 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 control has an OID of 1.3.6.1.4.1.30221.2.5.56, a criticality of either
* {@code true} or {@code false}, and a value with the provided encoding:
*
* that contains a mapping of one or
* more case-sensitive property-value pairs. Property names will be treated in
* a case-sensitive manner.
* the following encoding:
*
* OverrideSearchLimitsRequestValue ::= SEQUENCE OF SEQUENCE {
* propertyName OCTET STRING,
* propertyValue OCTET STRING }
*
*/
@NotMutable()
@ThreadSafety(level= ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class OverrideSearchLimitsRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.56) for the override search limits request
* control.
*/
@NotNull public static final String OVERRIDE_SEARCH_LIMITS_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.56";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 3685279915414141978L;
// The set of properties included in this control.
@NotNull private final Map properties;
/**
* Creates a new instance of this override search limits request control with
* the specified property name and value. It will not be critical.
*
* @param propertyName The name of the property to set. It must not be
* {@code null} or empty.
* @param propertyValue The value for the specified property. It must not
* be {@code null} or empty.
*/
public OverrideSearchLimitsRequestControl(@NotNull final String propertyName,
@NotNull final String propertyValue)
{
this(Collections.singletonMap(propertyName, propertyValue), false);
}
/**
* Creates a new instance of this override search limits request control with
* the provided set of properties.
*
* @param properties The map of properties to set in this control. It must
* not be {@code null} or empty, and none of the keys or
* values inside it may be {@code null} or empty.
* @param isCritical Indicates whether the control should be considered
* critical.
*/
public OverrideSearchLimitsRequestControl(
@NotNull final Map properties,
final boolean isCritical)
{
super(OVERRIDE_SEARCH_LIMITS_REQUEST_OID, isCritical,
encodeValue(properties));
this.properties =
Collections.unmodifiableMap(new LinkedHashMap<>(properties));
}
/**
* Creates a new instance of this override search limits request control that
* is decoded from the provided generic control.
*
* @param control The generic control to decode as an override search limits
* request control. It must not be {@code null}.
*
* @throws LDAPException If the provided control cannot be decoded as an
* override search limits request control.
*/
public OverrideSearchLimitsRequestControl(@NotNull final Control control)
throws LDAPException
{
super(control);
final ASN1OctetString value = control.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_OVERRIDE_SEARCH_LIMITS_REQUEST_NO_VALUE.get());
}
final LinkedHashMap propertyMap =
new LinkedHashMap<>(StaticUtils.computeMapCapacity(10));
try
{
for (final ASN1Element valueElement :
ASN1Sequence.decodeAsSequence(value.getValue()).elements())
{
final ASN1Element[] propertyElements =
ASN1Sequence.decodeAsSequence(valueElement).elements();
final String propertyName = ASN1OctetString.decodeAsOctetString(
propertyElements[0]).stringValue();
final String propertyValue = ASN1OctetString.decodeAsOctetString(
propertyElements[1]).stringValue();
if (propertyName.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_OVERRIDE_SEARCH_LIMITS_REQUEST_EMPTY_PROPERTY_NAME.get());
}
if (propertyValue.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_OVERRIDE_SEARCH_LIMITS_REQUEST_EMPTY_PROPERTY_VALUE.get(
propertyName));
}
if (propertyMap.containsKey(propertyName))
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_OVERRIDE_SEARCH_LIMITS_REQUEST_DUPLICATE_PROPERTY_NAME.get(
propertyName));
}
propertyMap.put(propertyName, propertyValue);
}
}
catch (final LDAPException e)
{
Debug.debugException(e);
throw e;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_OVERRIDE_SEARCH_LIMITS_REQUEST_CANNOT_DECODE_VALUE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
if (propertyMap.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_OVERRIDE_SEARCH_LIMITS_REQUEST_CONTROL_NO_PROPERTIES.get());
}
properties = Collections.unmodifiableMap(propertyMap);
}
/**
* Encodes the provided set of properties into an ASN.1 element suitable for
* use as the value of this control.
*
* @param properties The map of properties to set in this control. It must
* not be {@code null} or empty, and none of the keys or
* values inside it may be {@code null} or empty.
*
* @return The ASN.1 octet string containing the encoded value.
*/
@NotNull()
static ASN1OctetString encodeValue(
@NotNull final Map properties)
{
Validator.ensureTrue(((properties != null) && (! properties.isEmpty())),
"OverrideSearchLimitsRequestControl.properties must not be " +
"null or empty");
final ArrayList propertyElements =
new ArrayList<>(properties.size());
for (final Map.Entry e : properties.entrySet())
{
final String propertyName = e.getKey();
final String propertyValue = e.getValue();
Validator.ensureTrue(
((propertyName != null) && (! propertyName.isEmpty())),
"OverrideSearchLimitsRequestControl.properties keys must " +
"not be null or empty");
Validator.ensureTrue(
((propertyValue != null) && (! propertyValue.isEmpty())),
"OverrideSearchLimitsRequestControl.properties values must " +
"not be null or empty");
propertyElements.add(new ASN1Sequence(
new ASN1OctetString(propertyName),
new ASN1OctetString(propertyValue)));
}
return new ASN1OctetString(new ASN1Sequence(propertyElements).encode());
}
/**
* Retrieves a map of the properties included in this request control.
*
* @return A map of the properties included in this request control.
*/
@NotNull()
public Map getProperties()
{
return properties;
}
/**
* Retrieves the value of the specified property.
*
* @param propertyName The name of the property for which to retrieve the
* value. It must not be {@code null} or empty, and it
* will be treated in a case-sensitive manner.
*
* @return The value of the requested property, or {@code null} if the
* property is not set in the control.
*/
@Nullable()
public String getProperty(@NotNull final String propertyName)
{
Validator.ensureTrue(((propertyName != null) && (! propertyName.isEmpty())),
"OverrideSearchLimitsRequestControl.getProperty.propertyName must " +
"not be null or empty.");
return properties.get(propertyName);
}
/**
* Retrieves the value of the specified property as a {@code Boolean}.
*
* @param propertyName The name of the property for which to retrieve the
* value. It must not be {@code null} or empty, and it
* will be treated in a case-sensitive manner.
* @param defaultValue The default value that will be used if the requested
* property is not set or if its value cannot be parsed
* as a {@code Boolean}. It may be {@code null} if the
* default value should be {@code null}.
*
* @return The Boolean value of the requested property, or the provided
* default value if the property is not set or if its value cannot be
* parsed as a {@code Boolean}.
*/
@Nullable()
public Boolean getPropertyAsBoolean(@NotNull final String propertyName,
@Nullable final Boolean defaultValue)
{
final String propertyValue = getProperty(propertyName);
if (propertyValue == null)
{
return defaultValue;
}
switch (StaticUtils.toLowerCase(propertyValue))
{
case "true":
case "t":
case "yes":
case "y":
case "on":
case "1":
return Boolean.TRUE;
case "false":
case "f":
case "no":
case "n":
case "off":
case "0":
return Boolean.FALSE;
default:
return defaultValue;
}
}
/**
* Retrieves the value of the specified property as an {@code Integer}.
*
* @param propertyName The name of the property for which to retrieve the
* value. It must not be {@code null} or empty, and it
* will be treated in a case-sensitive manner.
* @param defaultValue The default value that will be used if the requested
* property is not set or if its value cannot be parsed
* as an {@code Integer}. It may be {@code null} if the
* default value should be {@code null}.
*
* @return The integer value of the requested property, or the provided
* default value if the property is not set or if its value cannot be
* parsed as an {@code Integer}.
*/
@Nullable()
public Integer getPropertyAsInteger(@NotNull final String propertyName,
@Nullable final Integer defaultValue)
{
final String propertyValue = getProperty(propertyName);
if (propertyValue == null)
{
return defaultValue;
}
try
{
return Integer.parseInt(propertyValue);
}
catch (final Exception e)
{
Debug.debugException(e);
return defaultValue;
}
}
/**
* Retrieves the value of the specified property as a {@code Long}.
*
* @param propertyName The name of the property for which to retrieve the
* value. It must not be {@code null} or empty, and it
* will be treated in a case-sensitive manner.
* @param defaultValue The default value that will be used if the requested
* property is not set or if its value cannot be parsed
* as an {@code Long}. It may be {@code null} if the
* default value should be {@code null}.
*
* @return The long value of the requested property, or the provided default
* value if the property is not set or if its value cannot be parsed
* as a {@code Long}.
*/
@Nullable()
public Long getPropertyAsLong(@NotNull final String propertyName,
@Nullable final Long defaultValue)
{
final String propertyValue = getProperty(propertyName);
if (propertyValue == null)
{
return defaultValue;
}
try
{
return Long.parseLong(propertyValue);
}
catch (final Exception e)
{
Debug.debugException(e);
return defaultValue;
}
}
/**
* Retrieves the user-friendly name for this control, if available. If no
* user-friendly name has been defined, then the OID will be returned.
*
* @return The user-friendly name for this control, or the OID if no
* user-friendly name is available.
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_OVERRIDE_SEARCH_LIMITS_REQUEST_CONTROL_NAME.get();
}
/**
* Appends a string representation of this LDAP control to the provided
* buffer.
*
* @param buffer The buffer to which to append the string representation of
* this buffer.
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("OverrideSearchLimitsRequestControl(oid='");
buffer.append(getOID());
buffer.append("', isCritical=");
buffer.append(isCritical());
buffer.append(", properties={");
final Iterator> iterator =
properties.entrySet().iterator();
while (iterator.hasNext())
{
final Map.Entry e = iterator.next();
buffer.append('\'');
buffer.append(e.getKey());
buffer.append("'='");
buffer.append(e.getValue());
buffer.append('\'');
if (iterator.hasNext())
{
buffer.append(", ");
}
}
buffer.append("})");
}
}