com.unboundid.ldap.sdk.unboundidds.extensions.IgnoreAttributesChangeSelectionCriteria 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.
The newest version!
/*
* Copyright 2011-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2011-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) 2011-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.extensions;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
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.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.extensions.ExtOpMessages.*;
/**
* This class provides an implementation of a get changelog batch change
* selection criteria value that indicates that the server should not return
* changes which target only the specified attributes. This can be useful for
* ignoring changes to attributes which are changed frequently but not of
* interest to the client. Note that changes returned may include changes to
* these attributes, but only if the change targets other attributes that should
* not be ignored.
*
*
* 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.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class IgnoreAttributesChangeSelectionCriteria
extends ChangelogBatchChangeSelectionCriteria
{
/**
* The inner BER type that should be used for encoded elements that represent
* an ignore attributes get changelog batch selection criteria value.
*/
static final byte TYPE_SELECTION_CRITERIA_IGNORE_ATTRIBUTES = (byte) 0xA3;
// Indicates whether to automatically consider all operational attributes in
// the ignore list.
private final boolean ignoreOperationalAttributes;
// The names of the attributes to ignore.
@NotNull private final List attributeNames;
/**
* Creates a new ignore attributes change selection criteria value with the
* provided information.
*
* @param ignoreOperationalAttributes Indicates whether to automatically
* include all operational attributes in
* the set of attributes to ignore.
* @param attributeNames The names of the attributes to ignore.
* It may be {@code null} or empty only
* if
* {@code ignoreOperationalAttributes}
* is {@code true} and no user attributes
* changes should be ignored.
*/
public IgnoreAttributesChangeSelectionCriteria(
final boolean ignoreOperationalAttributes,
@Nullable final String... attributeNames)
{
this(ignoreOperationalAttributes, StaticUtils.toList(attributeNames));
}
/**
* Creates a new ignore attributes change selection criteria value with the
* provided information.
*
* @param ignoreOperationalAttributes Indicates whether to automatically
* include all operational attributes in
* the set of attributes to ignore.
* @param attributeNames The names of the attributes to ignore.
* It may be {@code null} or empty only
* if
* {@code ignoreOperationalAttributes}
* is {@code true} and no user attributes
* changes should be ignored.
*/
public IgnoreAttributesChangeSelectionCriteria(
final boolean ignoreOperationalAttributes,
@Nullable final Collection attributeNames)
{
if ((attributeNames == null) || attributeNames.isEmpty())
{
Validator.ensureTrue(ignoreOperationalAttributes);
this.attributeNames = Collections.emptyList();
}
else
{
this.attributeNames =
Collections.unmodifiableList(new ArrayList<>(attributeNames));
}
this.ignoreOperationalAttributes = ignoreOperationalAttributes;
}
/**
* Decodes the provided ASN.1 element, which is the inner element of a
* changelog batch change selection criteria element, as an all attributes
* change selection criteria value.
*
* @param innerElement The inner element of a changelog batch change
* selection criteria element to be decoded.
*
* @return The decoded all attributes change selection criteria value.
*
* @throws LDAPException If a problem is encountered while trying to decode
* the provided element as the inner element of an all
* attributes change selection criteria value.
*/
@NotNull()
static IgnoreAttributesChangeSelectionCriteria decodeInnerElement(
@NotNull final ASN1Element innerElement)
throws LDAPException
{
try
{
final ASN1Element[] elements =
ASN1Sequence.decodeAsSequence(innerElement).elements();
final ASN1Element[] attrElements =
ASN1Sequence.decodeAsSequence(elements[0]).elements();
final ArrayList attrNames = new ArrayList<>(attrElements.length);
for (final ASN1Element e : attrElements)
{
attrNames.add(ASN1OctetString.decodeAsOctetString(e).stringValue());
}
return new IgnoreAttributesChangeSelectionCriteria(
ASN1Boolean.decodeAsBoolean(elements[1]).booleanValue(),
attrNames);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_IGNORE_ATTRS_CHANGE_SELECTION_CRITERIA_DECODE_ERROR.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Indicates whether to automatically include all operational attributes in
* the set of attributes to ignore.
*
* @return {@code true} if all operational attributes should automatically be
* included in the set of attributes to ignore, or {@code false} if
* only those operational attributes which are explicitly named
* should be ignored.
*/
public boolean ignoreOperationalAttributes()
{
return ignoreOperationalAttributes;
}
/**
* Retrieves the names of the target attributes for changes that should be
* retrieved.
*
* @return The names of the target attributes for changes that should be
* retrieved.
*/
@NotNull()
public List getAttributeNames()
{
return attributeNames;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public ASN1Element encodeInnerElement()
{
final ArrayList attrNameElements =
new ArrayList<>(attributeNames.size());
for (final String s : attributeNames)
{
attrNameElements.add(new ASN1OctetString(s));
}
return new ASN1Sequence(TYPE_SELECTION_CRITERIA_IGNORE_ATTRIBUTES,
new ASN1Sequence(attrNameElements),
new ASN1Boolean(ignoreOperationalAttributes));
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("IgnoreAttributesChangeSelectionCriteria(attributeNames={");
final Iterator iterator = attributeNames.iterator();
while (iterator.hasNext())
{
buffer.append(iterator.next());
if (iterator.hasNext())
{
buffer.append(',');
}
}
buffer.append("}, ignoreOperationalAttributes=");
buffer.append(ignoreOperationalAttributes);
buffer.append(')');
}
}