com.unboundid.ldap.sdk.unboundidds.controls.GetBackendSetIDResponseControl 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 2014-2022 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2014-2022 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) 2014-2022 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.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.asn1.ASN1Set;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.DecodeableControl;
import com.unboundid.ldap.sdk.ExtendedResult;
import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.LDAPResult;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.SearchResultEntry;
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 com.unboundid.util.json.JSONArray;
import com.unboundid.util.json.JSONField;
import com.unboundid.util.json.JSONObject;
import com.unboundid.util.json.JSONString;
import com.unboundid.util.json.JSONValue;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides a response control that may be used to provide the
* backend set ID(s) for any relevant backend sets accessed during the course
* of processing an operation. It may be returned in response to a request
* containing either the get backend set ID request control or the route to
* backend set request control. For add, simple bind, compare, delete,
* modify, and modify DN operations, the LDAP result message for the operation
* may contain zero or one get backend set ID response control. For extended
* operations, the extended result message may contain zero, one, or multiple
* get backend set ID response controls. For search operations, each search
* result entry may contain zero or one get backend set ID response control,
* while the search result done message will not contain any such control. See
* the {@link GetBackendSetIDRequestControl} class documentation for a more
* complete description of the usage for these controls.
*
*
* 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 get backend set ID response control has an OID of
* "1.3.6.1.4.1.30221.2.5.34", a criticality of false, and a value with the
* following encoding:
*
* GET_BACKEND_SET_ID_RESPONSE_VALUE ::= SEQUENCE {
* entryBalancingRequestProcessorID OCTET STRING,
* backendSetIDs SET SIZE (1..MAX) OF OCTET STRING,
* ... }
*
*
* @see GetBackendSetIDRequestControl
* @see RouteToBackendSetRequestControl
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class GetBackendSetIDResponseControl
extends Control
implements DecodeableControl
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.34) for the get backend set ID response
* control.
*/
@NotNull public static final String GET_BACKEND_SET_ID_RESPONSE_OID =
"1.3.6.1.4.1.30221.2.5.34";
/**
* The name of the field used to specify backend set IDs in the JSON
* representation of this control.
*/
@NotNull private static final String JSON_FIELD_BACKEND_SET_IDS =
"backend-set-ids";
/**
* The name of the field used to specify the ID of the entry-balancing request
* processor in the JSON representation of this control.
*/
@NotNull private static final String JSON_FIELD_REQUEST_PROCESSOR_ID =
"request-processor-id";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 117359364981309726L;
// The backend set IDs for backend sets used during processing.
@NotNull private final Set backendSetIDs;
// The identifier for the entry-balancing request processor with which the
// backend set IDs are associated.
@NotNull private final String entryBalancingRequestProcessorID;
/**
* Creates a new empty control instance that is intended to be used only for
* decoding controls via the {@code DecodeableControl} interface.
*/
GetBackendSetIDResponseControl()
{
entryBalancingRequestProcessorID = null;
backendSetIDs = null;
}
/**
* Creates a new get backend set ID response control with the provided
* information.
*
* @param entryBalancingRequestProcessorID The identifier for the
* entry-balancing request processor
* with which the backend set IDs
* are associated. It must not be
* {@code null}.
* @param backendSetID The backend set ID for the
* backend set used during
* processing. It must not be
* {@code null}.
*/
public GetBackendSetIDResponseControl(
@NotNull final String entryBalancingRequestProcessorID,
@NotNull final String backendSetID)
{
this(entryBalancingRequestProcessorID,
Collections.singletonList(backendSetID));
}
/**
* Creates a new get backend set ID response control with the provided
* information.
*
* @param entryBalancingRequestProcessorID The identifier for the
* entry-balancing request processor
* with which the backend set IDs
* are associated. It must not be
* {@code null}.
* @param backendSetIDs The backend set IDs for backend
* sets used during processing. It
* must not be {@code null} or
* empty.
*/
public GetBackendSetIDResponseControl(
@NotNull final String entryBalancingRequestProcessorID,
@NotNull final Collection backendSetIDs)
{
super(GET_BACKEND_SET_ID_RESPONSE_OID, false,
encodeValue(entryBalancingRequestProcessorID, backendSetIDs));
this.entryBalancingRequestProcessorID = entryBalancingRequestProcessorID;
this.backendSetIDs =
Collections.unmodifiableSet(new LinkedHashSet<>(backendSetIDs));
}
/**
* Creates a new get backend set ID response control decoded from the given
* generic control contents.
*
* @param oid The OID for the control.
* @param isCritical Indicates whether this control should be marked
* critical.
* @param value The encoded value for the control.
*
* @throws LDAPException If a problem occurs while attempting to decode the
* generic control as a get backend set ID response
* control.
*/
public GetBackendSetIDResponseControl(@NotNull final String oid,
final boolean isCritical,
@Nullable final ASN1OctetString value)
throws LDAPException
{
super(oid, isCritical, value);
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_BACKEND_SET_ID_RESPONSE_MISSING_VALUE.get());
}
try
{
final ASN1Element[] elements =
ASN1Sequence.decodeAsSequence(value.getValue()).elements();
entryBalancingRequestProcessorID =
ASN1OctetString.decodeAsOctetString(elements[0]).stringValue();
final ASN1Element[] backendSetIDElements =
ASN1Set.decodeAsSet(elements[1]).elements();
final LinkedHashSet setIDs = new LinkedHashSet<>(
StaticUtils.computeMapCapacity(backendSetIDElements.length));
for (final ASN1Element e : backendSetIDElements)
{
setIDs.add(ASN1OctetString.decodeAsOctetString(e).stringValue());
}
backendSetIDs = Collections.unmodifiableSet(setIDs);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_BACKEND_SET_ID_RESPONSE_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Encodes the provided information into an octet string suitable for use as
* the value of this control.
*
* @param entryBalancingRequestProcessorID The identifier for the
* entry-balancing request processor
* with which the backend set IDs
* are associated. It must not be
* {@code null}.
* @param backendSetIDs The backend set IDs for backend
* sets used during processing. It
* must not be {@code null} or
* empty.
*
* @return The encoded representation of the control value.
*/
@NotNull()
private static ASN1OctetString encodeValue(
@NotNull final String entryBalancingRequestProcessorID,
@NotNull final Collection backendSetIDs)
{
Validator.ensureNotNull(entryBalancingRequestProcessorID);
Validator.ensureNotNull(backendSetIDs);
Validator.ensureFalse(backendSetIDs.isEmpty());
final ArrayList backendSetIDElements =
new ArrayList<>(backendSetIDs.size());
for (final String s : backendSetIDs)
{
backendSetIDElements.add(new ASN1OctetString(s));
}
final ASN1Sequence valueSequence = new ASN1Sequence(
new ASN1OctetString(entryBalancingRequestProcessorID),
new ASN1Set(backendSetIDElements));
return new ASN1OctetString(valueSequence.encode());
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public GetBackendSetIDResponseControl decodeControl(@NotNull final String oid,
final boolean isCritical,
@Nullable final ASN1OctetString value)
throws LDAPException
{
return new GetBackendSetIDResponseControl(oid, isCritical, value);
}
/**
* Retrieves the identifier for the entry-balancing request processor with
* which the backend sets IDs are associated.
*
* @return The identifier for the entry-balancing request processor with
* which the backend set IDs are associated.
*/
@NotNull()
public String getEntryBalancingRequestProcessorID()
{
return entryBalancingRequestProcessorID;
}
/**
* Retrieves the backend set IDs for the backend sets used during processing.
*
* @return The backend set IDs for the backend sets used during processing.
*/
@NotNull()
public Set getBackendSetIDs()
{
return backendSetIDs;
}
/**
* Extracts a get backend set ID response control from the provided result.
*
* @param result The result from which to retrieve the get backend set ID
* response control.
*
* @return The get backend set ID response control contained in the provided
* result, or {@code null} if the result did not contain a get
* backend set ID response control.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the get backend set ID response control
* contained in the provided result.
*/
@Nullable()
public static GetBackendSetIDResponseControl get(
@NotNull final LDAPResult result)
throws LDAPException
{
final Control c =
result.getResponseControl(GET_BACKEND_SET_ID_RESPONSE_OID);
if (c == null)
{
return null;
}
if (c instanceof GetBackendSetIDResponseControl)
{
return (GetBackendSetIDResponseControl) c;
}
else
{
return new GetBackendSetIDResponseControl(c.getOID(), c.isCritical(),
c.getValue());
}
}
/**
* Extracts a get backend set ID response control from the provided search
* result entry.
*
* @param entry The entry from which to retrieve the get backend set ID
* response control.
*
* @return The get backend set ID response control contained in the provided
* entry, or {@code null} if the entry did not contain a get backend
* set ID response control.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the get backend set ID response control
* contained in the provided result.
*/
@Nullable()
public static GetBackendSetIDResponseControl get(
@NotNull final SearchResultEntry entry)
throws LDAPException
{
final Control c = entry.getControl(GET_BACKEND_SET_ID_RESPONSE_OID);
if (c == null)
{
return null;
}
if (c instanceof GetBackendSetIDResponseControl)
{
return (GetBackendSetIDResponseControl) c;
}
else
{
return new GetBackendSetIDResponseControl(c.getOID(), c.isCritical(),
c.getValue());
}
}
/**
* Extracts any get backend set ID response controls from the provided
* extended result.
*
* @param result The extended result from which to retrieve the get backend
* set ID response control(s).
*
* @return A list of get backend set ID response controls contained in the
* provided extended result, or an empty list if the result did not
* contain a get any backend set ID response controls.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the any backend set ID response control
* contained in the provided result.
*/
@NotNull()
public static List get(
@NotNull final ExtendedResult result)
throws LDAPException
{
final Control[] controls = result.getResponseControls();
if (controls.length == 0)
{
return Collections.emptyList();
}
final ArrayList decodedControls =
new ArrayList<>(controls.length);
for (final Control c : controls)
{
if (c instanceof GetBackendSetIDResponseControl)
{
decodedControls.add((GetBackendSetIDResponseControl) c);
}
else if (c.getOID().equals(GET_BACKEND_SET_ID_RESPONSE_OID))
{
decodedControls.add(new GetBackendSetIDResponseControl(c.getOID(),
c.isCritical(), c.getValue()));
}
}
return Collections.unmodifiableList(decodedControls);
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_GET_BACKEND_SET_ID_RESPONSE.get();
}
/**
* Retrieves a representation of this get backend set ID response control as a
* JSON object. The JSON object uses the following fields:
*
* -
* {@code oid} -- A mandatory string field whose value is the object
* identifier for this control. For the get backend set ID response
* control, the OID is "1.3.6.1.4.1.30221.2.5.34".
*
* -
* {@code 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 {@code oid}
* field should be used to identify the type of control.
*
* -
* {@code criticality} -- A mandatory Boolean field used to indicate
* whether this control is considered critical.
*
* -
* {@code value-base64} -- An optional string field whose value is a
* base64-encoded representation of the raw value for this get backend set
* ID response control. Exactly one of the {@code value-base64} and
* {@code value-json} fields must be present.
*
* -
* {@code value-json} -- An optional JSON object field whose value is a
* user-friendly representation of the value for this get backend set ID
* response control. Exactly one of the {@code value-base64} and
* {@code value-json} fields must be present, and if the
* {@code value-json} field is used, then it will use the following
* fields:
*
* -
* {@code request-processor-id} -- A string field whose value is the
* name of the entry-balancing request processor with which the
* control is associated.
*
* -
* {@code backend-set-ids} -- An array field whose values are the
* string identifiers for the backend sets in which processing was
* performed for the associated entry.
*
*
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
final List backendSetIDValues = new ArrayList<>();
for (final String backendSetID : backendSetIDs)
{
backendSetIDValues.add(new JSONString(backendSetID));
}
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
GET_BACKEND_SET_ID_RESPONSE_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_GET_BACKEND_SET_ID_RESPONSE.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_VALUE_JSON,
new JSONObject(
new JSONField("request-processor-id",
entryBalancingRequestProcessorID),
new JSONField("backend-set-ids",
new JSONArray(backendSetIDValues)))));
}
/**
* Attempts to decode the provided object as a JSON representation of a get
* backend set ID response control.
*
* @param controlObject The JSON object to be decoded. It must not be
* {@code null}.
* @param strict Indicates whether to use strict mode when decoding
* the provided JSON object. If this is {@code true},
* then this method will throw an exception if the
* provided JSON object contains any unrecognized
* fields. If this is {@code false}, then unrecognized
* fields will be ignored.
*
* @return The get backend set ID response control that was decoded from
* the provided JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid get backend set ID response control.
*/
@NotNull()
public static GetBackendSetIDResponseControl decodeJSONControl(
@NotNull final JSONObject controlObject,
final boolean strict)
throws LDAPException
{
final JSONControlDecodeHelper jsonControl = new JSONControlDecodeHelper(
controlObject, strict, true, true);
final ASN1OctetString rawValue = jsonControl.getRawValue();
if (rawValue != null)
{
return new GetBackendSetIDResponseControl(jsonControl.getOID(),
jsonControl.getCriticality(), rawValue);
}
final JSONObject valueObject = jsonControl.getValueObject();
final String requestProcessorID =
valueObject.getFieldAsString(JSON_FIELD_REQUEST_PROCESSOR_ID);
if (requestProcessorID == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_BACKEND_SET_ID_RESPONSE_JSON_MISSING_FIELD.get(
controlObject.toSingleLineString(),
JSON_FIELD_REQUEST_PROCESSOR_ID));
}
final List backendSetIDValues =
valueObject.getFieldAsArray(JSON_FIELD_BACKEND_SET_IDS);
if (backendSetIDValues == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_BACKEND_SET_ID_RESPONSE_JSON_MISSING_FIELD.get(
controlObject.toSingleLineString(),
JSON_FIELD_BACKEND_SET_IDS));
}
final List backendSetIDs =
new ArrayList<>(backendSetIDValues.size());
for (final JSONValue v : backendSetIDValues)
{
if (v instanceof JSONString)
{
backendSetIDs.add(((JSONString) v).stringValue());
}
else
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_BACKEND_SET_ID_RESPONSE_JSON_BACKEND_SET_ID_NOT_STRING.get(
controlObject.getFields(), JSON_FIELD_BACKEND_SET_IDS));
}
}
if (strict)
{
final List unrecognizedFields =
JSONControlDecodeHelper.getControlObjectUnexpectedFields(
valueObject, JSON_FIELD_REQUEST_PROCESSOR_ID,
JSON_FIELD_BACKEND_SET_IDS);
if (! unrecognizedFields.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_BACKEND_SET_ID_RESPONSE_JSON_UNRECOGNIZED_FIELD.get(
controlObject.toSingleLineString(),
unrecognizedFields.get(0)));
}
}
return new GetBackendSetIDResponseControl(requestProcessorID,
backendSetIDs);
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("GetBackendSetIDResponseControl(" +
"entryBalancingRequestProcessorID='");
buffer.append(entryBalancingRequestProcessorID);
buffer.append("', backendSetIDs={");
final Iterator iterator = backendSetIDs.iterator();
while (iterator.hasNext())
{
buffer.append('\'');
buffer.append(iterator.next());
buffer.append('\'');
if (iterator.hasNext())
{
buffer.append(", ");
}
}
buffer.append("})");
}
}