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 2012-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2012-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) 2012-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.unboundidds.controls;
import java.util.ArrayList;
import java.util.List;
import com.unboundid.asn1.ASN1Boolean;
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.JSONControlDecodeHelper;
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.json.JSONField;
import com.unboundid.util.json.JSONObject;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides a request control which may be included in a search
* request to indicate that soft-deleted entries may be included in the results,
* or it may be included in a compare or modify request to indicate that the
* operation should operate against the target entry even if it is a
* soft-deleted entry.
*
*
* 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 criticality for this control may be either {@code TRUE} or {@code FALSE},
* but this will only impact how the delete request is to be handled by servers
* which do not support this control. A criticality of {@code TRUE} will cause
* any server which does not support this control to reject the request, while
* a criticality of {@code FALSE} should cause the request to be processed as if
* the control had not been included.
*
* The control may optionally have a value. If a value is provided, then it
* must be the encoded representation of the following ASN.1 element:
*
* See the documentation for the {@link SoftDeleteRequestControl} class for an
* example demonstrating the use of this control.
*
* @see SoftDeleteResponseControl
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SoftDeletedEntryAccessRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.24) for the soft-deleted entry access
* request control.
*/
@NotNull public static final String SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.24";
/**
* The BER type for the include non-soft-deleted entries element.
*/
private static final byte TYPE_INCLUDE_NON_SOFT_DELETED_ENTRIES = (byte) 0x80;
/**
* The BER type for the return entries in undeleted form element.
*/
private static final byte TYPE_RETURN_ENTRIES_IN_UNDELETED_FORM = (byte) 0x81;
/**
* The name of the field used to hold the include-non-soft-deleted-entries
* flag in the JSON representation of this control.
*/
@NotNull private static final String
JSON_FIELD_INCLUDE_NON_SOFT_DELETED_ENTRIES =
"include-non-soft-deleted-entries";
/**
* The name of the field used to hold the return-entries-in-undeleted-form
* flag in the JSON representation of this control.
*/
@NotNull private static final String
JSON_FIELD_RETURN_ENTRIES_IN_UNDELETED_FORM =
"return-entries-in-undeleted-form";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -3633807543861389512L;
// Indicates whether to include non-soft-deleted entries in search results.
private final boolean includeNonSoftDeletedEntries;
// Indicates whether to return soft-deleted entries in the form they appeared
// before they were deleted.
private final boolean returnEntriesInUndeletedForm;
/**
* Creates a new soft-deleted entry access request control with the default
* settings for all elements. It will not be marked critical.
*/
public SoftDeletedEntryAccessRequestControl()
{
this(false, true, false);
}
/**
* Creates a new soft delete request control with the provided information.
*
* @param isCritical Indicates whether this control should
* be marked critical. This will only
* have an effect on the way the
* associated delete operation is
* handled by servers which do NOT
* support the soft-deleted entry access
* request control. For such servers, a
* control that is critical will cause
* associated request to be rejected,
* while a control that is not critical
* will be processed as if the control
* was not included in the request.
* @param includeNonSoftDeletedEntries Indicates whether search results
* should include non-soft-deleted
* entries if they match the criteria
* for the associated search request.
* @param returnEntriesInUndeletedForm Indicates whether soft-deleted
* entries returned in search results
* should be returned in the form in
* which they would appear if they were
* undeleted. Note that if soft-deleted
* entries should be returned in their
* undeleted form, then it may be
* possible for multiple entries to be
* returned with the same DN (if
* multiple soft-deleted entries with
* the same original DN match the
* criteria, or if at least one
* soft-deleted entry and one normal
* entry with the same DN both match the
* search criteria).
*/
public SoftDeletedEntryAccessRequestControl(final boolean isCritical,
final boolean includeNonSoftDeletedEntries,
final boolean returnEntriesInUndeletedForm)
{
super(SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID, isCritical,
encodeValue(includeNonSoftDeletedEntries,
returnEntriesInUndeletedForm));
this.includeNonSoftDeletedEntries = includeNonSoftDeletedEntries;
this.returnEntriesInUndeletedForm = returnEntriesInUndeletedForm;
}
/**
* Creates a new soft-deleted entry access request control which is decoded
* from the provided generic control.
*
* @param control The generic control to be decoded as a soft-deleted entry
* access request control.
*
* @throws LDAPException If the provided control cannot be decoded as a
* soft-deleted entry access request control.
*/
public SoftDeletedEntryAccessRequestControl(@NotNull final Control control)
throws LDAPException
{
super(control);
boolean includeNonSoftDeleted = true;
boolean returnAsUndeleted = false;
if (control.hasValue())
{
try
{
final ASN1Sequence valueSequence =
ASN1Sequence.decodeAsSequence(control.getValue().getValue());
for (final ASN1Element e : valueSequence.elements())
{
switch (e.getType())
{
case TYPE_INCLUDE_NON_SOFT_DELETED_ENTRIES:
includeNonSoftDeleted =
ASN1Boolean.decodeAsBoolean(e).booleanValue();
break;
case TYPE_RETURN_ENTRIES_IN_UNDELETED_FORM:
returnAsUndeleted = ASN1Boolean.decodeAsBoolean(e).booleanValue();
break;
default:
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SOFT_DELETED_ACCESS_REQUEST_UNSUPPORTED_ELEMENT_TYPE.get(
StaticUtils.toHex(e.getType())));
}
}
}
catch (final LDAPException le)
{
Debug.debugException(le);
throw le;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SOFT_DELETED_ACCESS_REQUEST_CANNOT_DECODE_VALUE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
includeNonSoftDeletedEntries = includeNonSoftDeleted;
returnEntriesInUndeletedForm = returnAsUndeleted;
}
/**
* Encodes the provided information into an ASN.1 octet string suitable for
* use as the value of a soft-deleted entry access request control.
*
* @param includeNonSoftDeletedEntries Indicates whether search results
* should include non-soft-deleted
* entries if they match the criteria
* for the associated search request.
* @param returnEntriesInUndeletedForm Indicates whether soft-deleted
* entries returned in search results
* should be returned in the form in
* which they would appear if they were
* undeleted. Note that if soft-deleted
* entries should be returned in their
* undeleted form, then it may be
* possible for multiple entries to be
* returned with the same DN (if
* multiple soft-deleted entries with
* the same original DN match the
* criteria, or if at least one
* soft-deleted entry and one normal
* entry with the same DN both match the
* search criteria).
*
* @return An ASN.1 octet string with an encoding suitable for use as the
* value of a soft-deleted entry access request control, or
* {@code null} if no value is needed for the control.
*/
@Nullable()
private static ASN1OctetString encodeValue(
final boolean includeNonSoftDeletedEntries,
final boolean returnEntriesInUndeletedForm)
{
if (includeNonSoftDeletedEntries && (! returnEntriesInUndeletedForm))
{
return null;
}
final ArrayList elements = new ArrayList<>(2);
if (! includeNonSoftDeletedEntries)
{
elements.add(new ASN1Boolean(TYPE_INCLUDE_NON_SOFT_DELETED_ENTRIES,
false));
}
if (returnEntriesInUndeletedForm)
{
elements.add(new ASN1Boolean(TYPE_RETURN_ENTRIES_IN_UNDELETED_FORM,
true));
}
return new ASN1OctetString(new ASN1Sequence(elements).encode());
}
/**
* Indicates whether search results should include non-soft-deleted entries
* if they match the criteria for the associated search request.
*
* @return {@code true} if the server should return any "normal"
* non-soft-deleted entries that match the search criteria, or
* {@code false} if the server should only return soft-deleted
* entries that match the search criteria.
*/
public boolean includeNonSoftDeletedEntries()
{
return includeNonSoftDeletedEntries;
}
/**
* Indicates whether soft-deleted entries returned in search results should be
* returned in the form in which they would appear if they were undeleted.
* Note that if soft-deleted entries should be returned in their undeleted
* form, then it may be possible for multiple entries to be returned with the
* same DN (if multiple soft-deleted entries with the same original DN match
* the criteria, or if at least one soft-deleted entry and one normal entry
* with the same DN both match the search criteria).
*
* @return {@code false} if soft-deleted entries should be returned in their
* current form as soft-deleted entries, or {@code true} if they
* should be returned in the form in which they would appear if they
* were undeleted (e.g., using the original DN for the entry and
* without all the additional meta-attributes added during the
* soft delete process).
*/
public boolean returnEntriesInUndeletedForm()
{
return returnEntriesInUndeletedForm;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_SOFT_DELETED_ACCESS_REQUEST.get();
}
/**
* Retrieves a representation of this soft-deleted entry access request
* 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 soft-deleted entry access request
* control, the OID is "1.3.6.1.4.1.30221.2.5.24".
*
*
* {@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 soft-deleted
* entry access request 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 soft-deleted entry
* access request 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 include-non-soft-deleted-entries} -- A mandatory Boolean
* field that indicates whether the server should also return any
* non-soft-deleted entries in the search results.
*
*
* {@code return-entries-in-undeleted-form} -- A mandatory Boolean
* field that indicates whether soft-deleted entries should be
* returned in the form in which they appeared before they were
* soft-deleted.
*
*
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_SOFT_DELETED_ACCESS_REQUEST.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_VALUE_JSON,
new JSONObject(
new JSONField(JSON_FIELD_INCLUDE_NON_SOFT_DELETED_ENTRIES,
includeNonSoftDeletedEntries),
new JSONField(JSON_FIELD_RETURN_ENTRIES_IN_UNDELETED_FORM,
returnEntriesInUndeletedForm))));
}
/**
* Attempts to decode the provided object as a JSON representation of a
* soft-deleted entry access request 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 soft-deleted entry access request that was decoded from
* the provided JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid soft-deleted entry access request.
*/
@NotNull()
public static SoftDeletedEntryAccessRequestControl 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 SoftDeletedEntryAccessRequestControl(new Control(
jsonControl.getOID(), jsonControl.getCriticality(), rawValue));
}
final JSONObject valueObject = jsonControl.getValueObject();
final Boolean includeNonSoftDeletedEntries = valueObject.getFieldAsBoolean(
JSON_FIELD_INCLUDE_NON_SOFT_DELETED_ENTRIES);
if (includeNonSoftDeletedEntries == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SOFT_DELETED_ACCESS_REQUEST_JSON_MISSING_FIELD.get(
controlObject.toSingleLineString(),
JSON_FIELD_INCLUDE_NON_SOFT_DELETED_ENTRIES));
}
final Boolean returnEntriesInUndeletedForm = valueObject.getFieldAsBoolean(
JSON_FIELD_RETURN_ENTRIES_IN_UNDELETED_FORM);
if (returnEntriesInUndeletedForm == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SOFT_DELETED_ACCESS_REQUEST_JSON_MISSING_FIELD.get(
controlObject.toSingleLineString(),
JSON_FIELD_RETURN_ENTRIES_IN_UNDELETED_FORM));
}
if (strict)
{
final List unrecognizedFields =
JSONControlDecodeHelper.getControlObjectUnexpectedFields(
valueObject, JSON_FIELD_INCLUDE_NON_SOFT_DELETED_ENTRIES,
JSON_FIELD_RETURN_ENTRIES_IN_UNDELETED_FORM);
if (! unrecognizedFields.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SOFT_DELETED_ACCESS_REQUEST_JSON_UNRECOGNIZED_FIELD.get(
controlObject.toSingleLineString(),
unrecognizedFields.get(0)));
}
}
return new SoftDeletedEntryAccessRequestControl(
jsonControl.getCriticality(), includeNonSoftDeletedEntries,
returnEntriesInUndeletedForm);
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("SoftDeletedEntryAccessRequestControl(isCritical=");
buffer.append(isCritical());
buffer.append(", includeNonSoftDeletedEntries=");
buffer.append(includeNonSoftDeletedEntries);
buffer.append(", returnEntriesInUndeletedForm=");
buffer.append(returnEntriesInUndeletedForm);
buffer.append(')');
}
}
