com.unboundid.ldap.sdk.unboundidds.controls.SuppressOperationalAttributeUpdateRequestControl 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 2012-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2018 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.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Iterator;
import java.util.Set;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1Enumerated;
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.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 can be used to
* indicate that the server should suppress the update to one or more
* operational attributes for the associated request.
*
*
* 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 request control has an OID of 1.3.6.1.4.1.30221.2.5.27, and the
* criticality may be either {@code true} or {@code false}. The control must
* have a value with the following encoding:
*
* SuppressOperationalAttributeUpdateRequestValue ::= SEQUENCE {
* suppressTypes [0] SEQUENCE OF ENUMERATED {
* last-access-time (0),
* last-login-time (1),
* last-login-ip (2),
* lastmod (3),
* ... },
* ... }
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SuppressOperationalAttributeUpdateRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.27) for the suppress operational attribute
* update request control.
*/
public static final String SUPPRESS_OP_ATTR_UPDATE_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.27";
/**
* The BER type to use for the set of suppress types.
*/
private static final byte TYPE_SUPPRESS_TYPES = (byte) 0x80;
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 4603958484615351672L;
// The set of suppress types to include in the control.
private final Set suppressTypes;
/**
* Creates a new instance of this control that will suppress updates to the
* specified kinds of operational attributes. It will not be critical.
*
* @param suppressTypes The set of suppress types to include in the control.
* It must not be {@code null} or empty.
*/
public SuppressOperationalAttributeUpdateRequestControl(
final SuppressType... suppressTypes)
{
this(false, suppressTypes);
}
/**
* Creates a new instance of this control that will suppress updates to the
* specified kinds of operational attributes. It will not be critical.
*
* @param suppressTypes The set of suppress types to include in the control.
* It must not be {@code null} or empty.
*/
public SuppressOperationalAttributeUpdateRequestControl(
final Collection suppressTypes)
{
this(false, suppressTypes);
}
/**
* Creates a new instance of this control that will suppress updates to the
* specified kinds of operational attributes.
*
* @param isCritical Indicates whether the control should be considered
* critical.
* @param suppressTypes The set of suppress types to include in the control.
* It must not be {@code null} or empty.
*/
public SuppressOperationalAttributeUpdateRequestControl(
final boolean isCritical, final SuppressType... suppressTypes)
{
this(isCritical, Arrays.asList(suppressTypes));
}
/**
* Creates a new instance of this control that will suppress updates to the
* specified kinds of operational attributes.
*
* @param isCritical Indicates whether the control should be considered
* critical.
* @param suppressTypes The set of suppress types to include in the control.
* It must not be {@code null} or empty.
*/
public SuppressOperationalAttributeUpdateRequestControl(
final boolean isCritical,
final Collection suppressTypes)
{
super(SUPPRESS_OP_ATTR_UPDATE_REQUEST_OID, isCritical,
encodeValue(suppressTypes));
Validator.ensureFalse(suppressTypes.isEmpty());
final EnumSet s = EnumSet.noneOf(SuppressType.class);
for (final SuppressType t : suppressTypes)
{
s.add(t);
}
this.suppressTypes = Collections.unmodifiableSet(s);
}
/**
* Decodes the provided generic control as a suppress operational attribute
* update request control.
*
* @param control The generic control to be decoded as a suppress
* operational attribute update request control.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the provided control.
*/
public SuppressOperationalAttributeUpdateRequestControl(final Control control)
throws LDAPException
{
super(control);
final ASN1OctetString value = control.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SUPPRESS_OP_ATTR_UPDATE_REQUEST_MISSING_VALUE.get());
}
try
{
final ASN1Sequence valueSequence =
ASN1Sequence.decodeAsSequence(value.getValue());
final ASN1Sequence suppressTypesSequence =
ASN1Sequence.decodeAsSequence(valueSequence.elements()[0]);
final EnumSet s = EnumSet.noneOf(SuppressType.class);
for (final ASN1Element e : suppressTypesSequence.elements())
{
final ASN1Enumerated ae = ASN1Enumerated.decodeAsEnumerated(e);
final SuppressType t = SuppressType.valueOf(ae.intValue());
if (t == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SUPPRESS_OP_ATTR_UNRECOGNIZED_SUPPRESS_TYPE.get(
ae.intValue()));
}
else
{
s.add(t);
}
}
suppressTypes = Collections.unmodifiableSet(s);
}
catch (final LDAPException le)
{
Debug.debugException(le);
throw le;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SUPPRESS_OP_ATTR_UPDATE_REQUEST_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 suppressTypes The set of suppress types to include in the control.
* It must not be {@code null} or empty.
*
* @return The ASN.1 octet string containing the encoded value.
*/
private static ASN1OctetString encodeValue(
final Collection suppressTypes)
{
final ArrayList suppressTypeElements =
new ArrayList<>(suppressTypes.size());
for (final SuppressType t : suppressTypes)
{
suppressTypeElements.add(new ASN1Enumerated(t.intValue()));
}
final ASN1Sequence valueSequence = new ASN1Sequence(
new ASN1Sequence(TYPE_SUPPRESS_TYPES, suppressTypeElements));
return new ASN1OctetString(valueSequence.encode());
}
/**
* Retrieves the set of suppress types for this control.
*
* @return The set of suppress types for this control.
*/
public Set getSuppressTypes()
{
return suppressTypes;
}
/**
* {@inheritDoc}
*/
@Override()
public String getControlName()
{
return INFO_CONTROL_NAME_SUPPRESS_OP_ATTR_UPDATE_REQUEST.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("SuppressOperationalAttributeUpdateRequestControl(" +
"isCritical=");
buffer.append(isCritical());
buffer.append(", suppressTypes={");
final Iterator iterator = suppressTypes.iterator();
while (iterator.hasNext())
{
buffer.append(iterator.next().name());
if (iterator.hasNext())
{
buffer.append(',');
}
}
buffer.append("})");
}
}