/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2010 Sun Microsystems, Inc.
|
*/
|
package org.forgerock.opendj.ldap.controls;
|
|
import static org.forgerock.opendj.ldap.CoreMessages.ERR_SUBTREE_DELETE_CONTROL_BAD_OID;
|
import static org.forgerock.opendj.ldap.CoreMessages.ERR_SUBTREE_DELETE_INVALID_CONTROL_VALUE;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.forgerock.opendj.ldap.DecodeException;
|
import org.forgerock.opendj.ldap.DecodeOptions;
|
|
import com.forgerock.opendj.util.Validator;
|
|
/**
|
* The tree delete request control as defined in draft-armijo-ldap-treedelete.
|
* This control allows a client to delete an entire subtree of a container entry
|
* in a single delete operation.
|
*
|
* <pre>
|
* Connection connection = ...;
|
* String baseDN = ...;
|
*
|
* DeleteRequest request =
|
* Requests.newDeleteRequest(baseDN)
|
* .addControl(SubtreeDeleteRequestControl.newControl(true));
|
* connection.delete(request);
|
* </pre>
|
*
|
* @see <a
|
* href="http://tools.ietf.org/html/draft-armijo-ldap-treedelete">draft-armijo-ldap-treedelete
|
* - Tree Delete Control </a>
|
*/
|
public final class SubtreeDeleteRequestControl implements Control {
|
/**
|
* The OID for the subtree delete request control.
|
*/
|
public static final String OID = "1.2.840.113556.1.4.805";
|
|
private static final SubtreeDeleteRequestControl CRITICAL_INSTANCE =
|
new SubtreeDeleteRequestControl(true);
|
|
private static final SubtreeDeleteRequestControl NONCRITICAL_INSTANCE =
|
new SubtreeDeleteRequestControl(false);
|
|
/**
|
* A decoder which can be used for decoding the sub-tree delete request
|
* control.
|
*/
|
public static final ControlDecoder<SubtreeDeleteRequestControl> DECODER =
|
new ControlDecoder<SubtreeDeleteRequestControl>() {
|
|
public SubtreeDeleteRequestControl decodeControl(final Control control,
|
final DecodeOptions options) throws DecodeException {
|
Validator.ensureNotNull(control);
|
|
if (control instanceof SubtreeDeleteRequestControl) {
|
return (SubtreeDeleteRequestControl) control;
|
}
|
|
if (!control.getOID().equals(OID)) {
|
final LocalizableMessage message =
|
ERR_SUBTREE_DELETE_CONTROL_BAD_OID.get(control.getOID(), OID);
|
throw DecodeException.error(message);
|
}
|
|
if (control.hasValue()) {
|
final LocalizableMessage message =
|
ERR_SUBTREE_DELETE_INVALID_CONTROL_VALUE.get();
|
throw DecodeException.error(message);
|
}
|
|
return control.isCritical() ? CRITICAL_INSTANCE : NONCRITICAL_INSTANCE;
|
}
|
|
public String getOID() {
|
return OID;
|
}
|
};
|
|
/**
|
* Creates a new tree delete request control having the provided
|
* criticality.
|
*
|
* @param isCritical
|
* {@code true} if it is unacceptable to perform the operation
|
* without applying the semantics of this control, or
|
* {@code false} if it can be ignored.
|
* @return The new control.
|
*/
|
public static SubtreeDeleteRequestControl newControl(final boolean isCritical) {
|
return isCritical ? CRITICAL_INSTANCE : NONCRITICAL_INSTANCE;
|
}
|
|
private final boolean isCritical;
|
|
private SubtreeDeleteRequestControl(final boolean isCritical) {
|
this.isCritical = isCritical;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public String getOID() {
|
return OID;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public ByteString getValue() {
|
return null;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean hasValue() {
|
return false;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public boolean isCritical() {
|
return isCritical;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public String toString() {
|
final StringBuilder builder = new StringBuilder();
|
builder.append("SubtreeDeleteRequestControl(oid=");
|
builder.append(getOID());
|
builder.append(", criticality=");
|
builder.append(isCritical());
|
builder.append(")");
|
return builder.toString();
|
}
|
|
}
|
