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-2019 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2008-2019 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 com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.ldap.sdk.Filter;
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.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.sdk.controls.ControlMessages.*;
/**
* This class provides an implementation of the LDAP assertion request control
* as defined in RFC 4528. It
* may be used in conjunction with an add, compare, delete, modify, modify DN,
* or search operation. The assertion control includes a search filter, and the
* associated operation should only be allowed to continue if the target entry
* matches the provided filter. If the filter does not match the target entry,
* then the operation should fail with an
* {@link ResultCode#ASSERTION_FAILED} result.
*
* The behavior of the assertion request control makes it ideal for atomic
* "check and set" types of operations, particularly when modifying an entry.
* For example, it can be used to ensure that when changing the value of an
* attribute, the current value has not been modified since it was last
* retrieved.
*
*
Example
* The following example demonstrates the use of the assertion request control.
* It shows an attempt to modify an entry's "accountBalance" attribute to set
* the value to "543.21" only if the current value is "1234.56":
*
* Modification mod = new Modification(ModificationType.REPLACE,
* "accountBalance", "543.21");
* ModifyRequest modifyRequest =
* new ModifyRequest("uid=john.doe,ou=People,dc=example,dc=com", mod);
* modifyRequest.addControl(
* new AssertionRequestControl("(accountBalance=1234.56)"));
*
* LDAPResult modifyResult;
* try
* {
* modifyResult = connection.modify(modifyRequest);
* // If we've gotten here, then the modification was successful.
* }
* catch (LDAPException le)
* {
* modifyResult = le.toLDAPResult();
* ResultCode resultCode = le.getResultCode();
* String errorMessageFromServer = le.getDiagnosticMessage();
* if (resultCode == ResultCode.ASSERTION_FAILED)
* {
* // The modification failed because the account balance value wasn't
* // what we thought it was.
* }
* else
* {
* // The modification failed for some other reason.
* }
* }
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class AssertionRequestControl
extends Control
{
/**
* The OID (1.3.6.1.1.12) for the assertion request control.
*/
public static final String ASSERTION_REQUEST_OID = "1.3.6.1.1.12";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 6592634203410511095L;
// The search filter for this assertion request control.
private final Filter filter;
/**
* Creates a new assertion request control with the provided filter. It will
* be marked as critical.
*
* @param filter The string representation of the filter for this assertion
* control. It must not be {@code null}.
*
* @throws LDAPException If the provided filter string cannot be decoded as
* a search filter.
*/
public AssertionRequestControl(final String filter)
throws LDAPException
{
this(Filter.create(filter), true);
}
/**
* Creates a new assertion request control with the provided filter. It will
* be marked as critical.
*
* @param filter The filter for this assertion control. It must not be
* {@code null}.
*/
public AssertionRequestControl(final Filter filter)
{
this(filter, true);
}
/**
* Creates a new assertion request control with the provided filter. It will
* be marked as critical.
*
* @param filter The string representation of the filter for this
* assertion control. It must not be {@code null}.
* @param isCritical Indicates whether this control should be marked
* critical.
*
* @throws LDAPException If the provided filter string cannot be decoded as
* a search filter.
*/
public AssertionRequestControl(final String filter, final boolean isCritical)
throws LDAPException
{
this(Filter.create(filter), isCritical);
}
/**
* Creates a new assertion request control with the provided filter. It will
* be marked as critical.
*
* @param filter The filter for this assertion control. It must not be
* {@code null}.
* @param isCritical Indicates whether this control should be marked
* critical.
*/
public AssertionRequestControl(final Filter filter, final boolean isCritical)
{
super(ASSERTION_REQUEST_OID, isCritical, encodeValue(filter));
this.filter = filter;
}
/**
* Creates a new assertion request control which is decoded from the provided
* generic control.
*
* @param control The generic control to be decoded as an assertion request
* control.
*
* @throws LDAPException If the provided control cannot be decoded as an
* assertion request control.
*/
public AssertionRequestControl(final Control control)
throws LDAPException
{
super(control);
final ASN1OctetString value = control.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSERT_NO_VALUE.get());
}
try
{
final ASN1Element valueElement = ASN1Element.decode(value.getValue());
filter = Filter.decode(valueElement);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSERT_CANNOT_DECODE.get(e), e);
}
}
/**
* Generates an assertion request control that may be used to help ensure
* that some or all of the attributes in the specified entry have not changed
* since it was read from the server.
*
* @param sourceEntry The entry from which to take the attributes to include
* in the assertion request control. It must not be
* {@code null} and should have at least one attribute to
* be included in the generated filter.
* @param attributes The names of the attributes to include in the
* assertion request control. If this is empty or
* {@code null}, then all attributes in the provided
* entry will be used.
*
* @return The generated assertion request control.
*/
public static AssertionRequestControl generate(final Entry sourceEntry,
final String... attributes)
{
Validator.ensureNotNull(sourceEntry);
final ArrayList andComponents;
if ((attributes == null) || (attributes.length == 0))
{
final Collection entryAttrs = sourceEntry.getAttributes();
andComponents = new ArrayList<>(entryAttrs.size());
for (final Attribute a : entryAttrs)
{
for (final ASN1OctetString v : a.getRawValues())
{
andComponents.add(Filter.createEqualityFilter(a.getName(),
v.getValue()));
}
}
}
else
{
andComponents = new ArrayList<>(attributes.length);
for (final String name : attributes)
{
final Attribute a = sourceEntry.getAttribute(name);
if (a != null)
{
for (final ASN1OctetString v : a.getRawValues())
{
andComponents.add(Filter.createEqualityFilter(name, v.getValue()));
}
}
}
}
if (andComponents.size() == 1)
{
return new AssertionRequestControl(andComponents.get(0));
}
else
{
return new AssertionRequestControl(Filter.createANDFilter(andComponents));
}
}
/**
* Encodes the provided information into an octet string that can be used as
* the value for this control.
*
* @param filter The filter for this assertion control. It must not be
* {@code null}.
*
* @return An ASN.1 octet string that can be used as the value for this
* control.
*/
private static ASN1OctetString encodeValue(final Filter filter)
{
return new ASN1OctetString(filter.encode().encode());
}
/**
* Retrieves the filter for this assertion control.
*
* @return The filter for this assertion control.
*/
public Filter getFilter()
{
return filter;
}
/**
* {@inheritDoc}
*/
@Override()
public String getControlName()
{
return INFO_CONTROL_NAME_ASSERTION_REQUEST.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("AssertionRequestControl(filter='");
filter.toString(buffer);
buffer.append("', isCritical=");
buffer.append(isCritical());
buffer.append(')');
}
}
