com.unboundid.ldap.sdk.unboundidds.controls.NameWithEntryUUIDRequestControl Maven / Gradle / Ivy
/*
* Copyright 2015-2017 UnboundID Corp.
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2017 UnboundID Corp.
*
* 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 com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of the name with entryUUID request
* control. It may be included in an add request to indicate that the server
* should replace the provided RDN with the server-generated entryUUID value.
* It will also cause the server to include a
* {@link com.unboundid.ldap.sdk.controls.PostReadResponseControl} in
* the add result to make the generated DN available to the client. If the
* request already includes a
* {@link com.unboundid.ldap.sdk.controls.PostReadRequestControl}, then the
* attributes included in the post-read response control will be generated from
* that request control. Otherwise, the server will behave as if the request
* had included a post-read request control requesting only the entryUUID
* attribute.
*
*
* NOTE: This class is part of the Commercial Edition of the UnboundID
* LDAP SDK for Java. It is not available for use in applications that
* include only the Standard Edition of the LDAP SDK, and is not supported for
* use in conjunction with non-UnboundID products.
*
*
* This control has an OID of "1.3.6.1.4.1.30221.2.5.44". It is recommended
* that it be used with a criticality of {@code true}. It does not take a
* value.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class NameWithEntryUUIDRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.44) for the name with entryUUID request
* control.
*/
public static final String NAME_WITH_ENTRY_UUID_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.44";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -1083494935823253033L;
/**
* Creates a new name with entryUUID request control. It will be marked
* critical.
*/
public NameWithEntryUUIDRequestControl()
{
this(true);
}
/**
* Creates a new name with entryUUID request control with the specified
* criticality.
*
* @param isCritical Indicates whether this control should be marked
* critical.
*/
public NameWithEntryUUIDRequestControl(final boolean isCritical)
{
super(NAME_WITH_ENTRY_UUID_REQUEST_OID, isCritical, null);
}
/**
* Creates a new name with entryUUID request control which is decoded from the
* provided generic control.
*
* @param control The generic control to be decoded as a name with entryUUID
* request control.
*
* @throws LDAPException If the provided control cannot be decoded as a name
* with entryUUID request control.
*/
public NameWithEntryUUIDRequestControl(final Control control)
throws LDAPException
{
super(control);
if (control.hasValue())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_NAME_WITH_ENTRY_UUID_REQUEST_HAS_VALUE.get());
}
}
/**
* {@inheritDoc}
*/
@Override()
public String getControlName()
{
return INFO_CONTROL_NAME_WITH_ENTRY_UUID_REQUEST.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("NameWithEntryUUIDRequestControl(isCritical=");
buffer.append(isCritical());
buffer.append(')');
}
}