Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2007-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2007-2024 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) 2007-2024 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.controls;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1Exception;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.DecodeableControl;
import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.LDAPResult;
import com.unboundid.ldap.sdk.ReadOnlyEntry;
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.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.controls.ControlMessages.*;
/**
* This class provides an implementation of the LDAP pre-read response control
* as defined in RFC 4527. It
* may be used to return a copy of the target entry immediately before
* processing a delete, modify, or modify DN operation.
*
* If the corresponding delete, modify, or modify DN request included the
* {@link PreReadRequestControl} and the operation was successful, then the
* response for that operation should include the pre-read response control with
* a read-only copy of the entry as it appeared immediately before processing
* the request. If the operation was not successful, then the pre-read response
* control will not be returned.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class PreReadResponseControl
extends Control
implements DecodeableControl
{
/**
* The OID (1.3.6.1.1.13.1) for the pre-read response control.
*/
@NotNull public static final String PRE_READ_RESPONSE_OID = "1.3.6.1.1.13.1";
/**
* The name of the field used to hold the DN of the entry in the JSON
* representation of this control.
*/
@NotNull private static final String JSON_FIELD_DN = "_dn";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -4719875382095056686L;
// The entry returned in the response control.
@NotNull private final ReadOnlyEntry entry;
/**
* Creates a new empty control instance that is intended to be used only for
* decoding controls via the {@code DecodeableControl} interface.
*/
PreReadResponseControl()
{
entry = null;
}
/**
* Creates a new pre-read response control including the provided entry.
*
* @param entry The entry to include in this pre-read response control. It
* must not be {@code null}.
*/
public PreReadResponseControl(@NotNull final ReadOnlyEntry entry)
{
super(PRE_READ_RESPONSE_OID, false, encodeValue(entry));
this.entry = entry;
}
/**
* Creates a new pre-read response control with the provided information.
*
* @param oid The OID for the control.
* @param isCritical Indicates whether the control should be marked
* critical.
* @param value The encoded value for the control. This may be
* {@code null} if no value was provided.
*
* @throws LDAPException If the provided control cannot be decoded as a
* pre-read response control.
*/
public PreReadResponseControl(@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_PRE_READ_RESPONSE_NO_VALUE.get());
}
final ASN1Sequence entrySequence;
try
{
final ASN1Element entryElement = ASN1Element.decode(value.getValue());
entrySequence = ASN1Sequence.decodeAsSequence(entryElement);
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_VALUE_NOT_SEQUENCE.get(ae),
ae);
}
final ASN1Element[] entryElements = entrySequence.elements();
if (entryElements.length != 2)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_INVALID_ELEMENT_COUNT.get(
entryElements.length));
}
final String dn =
ASN1OctetString.decodeAsOctetString(entryElements[0]).stringValue();
final ASN1Sequence attrSequence;
try
{
attrSequence = ASN1Sequence.decodeAsSequence(entryElements[1]);
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_ATTRIBUTES_NOT_SEQUENCE.get(ae), ae);
}
final ASN1Element[] attrElements = attrSequence.elements();
final Attribute[] attrs = new Attribute[attrElements.length];
for (int i=0; i < attrElements.length; i++)
{
try
{
attrs[i] =
Attribute.decode(ASN1Sequence.decodeAsSequence(attrElements[i]));
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_ATTR_NOT_SEQUENCE.get(ae), ae);
}
}
entry = new ReadOnlyEntry(dn, attrs);
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public PreReadResponseControl decodeControl(@NotNull final String oid,
final boolean isCritical,
@Nullable final ASN1OctetString value)
throws LDAPException
{
return new PreReadResponseControl(oid, isCritical, value);
}
/**
* Extracts a pre-read response control from the provided result.
*
* @param result The result from which to retrieve the pre-read response
* control.
*
* @return The pre-read response control contained in the provided result, or
* {@code null} if the result did not contain a pre-read response
* control.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the pre-read response control contained in
* the provided result.
*/
@Nullable()
public static PreReadResponseControl get(@NotNull final LDAPResult result)
throws LDAPException
{
final Control c = result.getResponseControl(PRE_READ_RESPONSE_OID);
if (c == null)
{
return null;
}
if (c instanceof PreReadResponseControl)
{
return (PreReadResponseControl) c;
}
else
{
return new PreReadResponseControl(c.getOID(), c.isCritical(),
c.getValue());
}
}
/**
* Encodes the provided information into an octet string that can be used as
* the value for this control.
*
* @param entry The entry to include in this pre-read response control. It
* must not be {@code null}.
*
* @return An ASN.1 octet string that can be used as the value for this
* control.
*/
@NotNull()
private static ASN1OctetString encodeValue(@NotNull final ReadOnlyEntry entry)
{
Validator.ensureNotNull(entry);
final Collection attrs = entry.getAttributes();
final ArrayList attrElements = new ArrayList<>(attrs.size());
for (final Attribute a : attrs)
{
attrElements.add(a.encode());
}
final ASN1Element[] entryElements =
{
new ASN1OctetString(entry.getDN()),
new ASN1Sequence(attrElements)
};
return new ASN1OctetString(new ASN1Sequence(entryElements).encode());
}
/**
* Retrieves a read-only copy of the entry returned by this post-read response
* control.
*
* @return A read-only copy of the entry returned by this post-read response
* control.
*/
@NotNull()
public ReadOnlyEntry getEntry()
{
return entry;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_PRE_READ_RESPONSE.get();
}
/**
* Retrieves a representation of this pre-read 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 pre-read response control, the
* OID is "1.3.6.1.1.13.1".
*
*
* {@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 pre-read
* 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 pre-read 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, it must include a
* "{@code _dn}" field whose value is the DN of the entry, and all other
* fields will have a name that is the name of an LDAP attribute in the
* entry and a value that is an array containing the string
* representations of the values for that attribute.
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
final Map valueFields = new LinkedHashMap<>();
valueFields.put(JSON_FIELD_DN, new JSONString(entry.getDN()));
for (final Attribute a : entry.getAttributes())
{
final List attrValueValues = new ArrayList<>(a.size());
for (final String value : a.getValues())
{
attrValueValues.add(new JSONString(value));
}
valueFields.put(a.getName(), new JSONArray(attrValueValues));
}
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
PRE_READ_RESPONSE_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_PRE_READ_RESPONSE.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_VALUE_JSON,
new JSONObject(valueFields)));
}
/**
* Attempts to decode the provided object as a JSON representation of a
* pre-read 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 pre-read response control that was decoded from the provided
* JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid pre-read response control.
*/
@NotNull()
public static PreReadResponseControl 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 PreReadResponseControl(jsonControl.getOID(),
jsonControl.getCriticality(), rawValue);
}
final JSONObject valueObject = jsonControl.getValueObject();
String dn = null;
final List attributes =
new ArrayList<>(valueObject.getFields().size());
for (final Map.Entry e :
valueObject.getFields().entrySet())
{
final String fieldName = e.getKey();
final JSONValue fieldValue = e.getValue();
if (fieldName.equals(JSON_FIELD_DN))
{
if (fieldValue instanceof JSONString)
{
dn = ((JSONString) fieldValue).stringValue();
}
else
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_JSON_DN_NOT_STRING.get(
controlObject.toSingleLineString(), JSON_FIELD_DN));
}
}
else
{
if (fieldValue instanceof JSONArray)
{
final List attrValueValues =
((JSONArray) fieldValue).getValues();
final List attributeValues =
new ArrayList<>(attrValueValues.size());
for (final JSONValue v : attrValueValues)
{
if (v instanceof JSONString)
{
attributeValues.add(((JSONString) v).stringValue());
}
else
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_JSON_ATTR_VALUE_NOT_STRING.get(
controlObject.toSingleLineString(), fieldName));
}
}
attributes.add(new Attribute(fieldName, attributeValues));
}
else
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_JSON_ATTR_VALUE_NOT_ARRAY.get(
controlObject.toSingleLineString(), fieldName));
}
}
}
if (dn == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_PRE_READ_RESPONSE_JSON_MISSING_DN.get(
controlObject.toSingleLineString(), JSON_FIELD_DN));
}
return new PreReadResponseControl(new ReadOnlyEntry(dn, attributes));
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("PreReadResponseControl(entry=");
entry.toString(buffer);
buffer.append(", isCritical=");
buffer.append(isCritical());
buffer.append(')');
}
}
