com.unboundid.ldap.sdk.unboundidds.controls.AdministrativeOperationRequestControl 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 2009-2023 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2009-2023 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) 2009-2023 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.List;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.json.JSONField;
import com.unboundid.util.json.JSONObject;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of a Directory Server control that may
* be used to indicate that the associated operation is used for performing some
* administrative operation within the server rather than one that was requested
* by a "normal" client. The server can use this indication to treat the
* operation differently (e.g., exclude it from the processing time histogram,
* or to include additional information about the purpose of the operation in
* the access log).
*
*
* 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.
*
*
* This request control has an OID of 1.3.6.1.4.1.30221.2.5.11 and a criticality
* of false. It may optionally have a value that is simply the bytes that
* comprise the message to include in the control.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class AdministrativeOperationRequestControl
extends Control
{
/**
* The name of the JSON field used to hold the message in the JSON
* representation of this control.
*/
@NotNull private static final String JSON_FIELD_MESSAGE = "message";
/**
* The OID (1.3.6.1.4.1.30221.2.5.11) for the administrative operation request
* control.
*/
@NotNull public static final String ADMINISTRATIVE_OPERATION_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.11";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 4958642483402677725L;
// The informational message to include in the control, if defined.
@Nullable private final String message;
/**
* Creates a new administrative operation request control with no message.
*/
public AdministrativeOperationRequestControl()
{
this((String) null);
}
/**
* Creates a new administrative operation request control with the provided
* informational message.
*
* @param message A message with additional information about the purpose of
* the associated operation. It may be {@code null} if no
* additional message should be provided.
*/
public AdministrativeOperationRequestControl(@Nullable final String message)
{
this(false, message);
}
/**
* Creates a new administrative operation request control with the provided
* informational message.
*
* @param isCritical Indicates whether this control should be considered
* critical.
* @param message A message with additional information about the purpose
* of the associated operation. It may be {@code null} if
* no additional message should be provided.
*/
public AdministrativeOperationRequestControl(final boolean isCritical,
@Nullable final String message)
{
super(ADMINISTRATIVE_OPERATION_REQUEST_OID, isCritical,
encodeValue(message));
this.message = message;
}
/**
* Creates a new administrative operation request control decoded from the
* provided generic control.
*
* @param control The generic control to be decoded as an administrative
* operation request control.
*/
public AdministrativeOperationRequestControl(@NotNull final Control control)
{
super(control);
if (control.hasValue())
{
message = control.getValue().stringValue();
}
else
{
message = null;
}
}
/**
* Generates an appropriately-encoded value for this control with the provided
* message.
*
* @param message A message with additional information about the purpose of
* the associated operation. It may be {@code null} if no
* additional message should be provided.
*
* @return An appropriately-encoded value for this control, or {@code null}
* if no value is needed.
*/
@Nullable()
private static ASN1OctetString encodeValue(@Nullable final String message)
{
if (message == null)
{
return null;
}
else
{
return new ASN1OctetString(message);
}
}
/**
* Retrieves the informational message for this control, if defined.
*
* @return The informational message for this control, or {@code null} if
* none was provided.
*/
@Nullable()
public String getMessage()
{
return message;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_ADMINISTRATIVE_OPERATION_REQUEST.get();
}
/**
* Retrieves a representation of this administrative operation request control
* as a JSON object. The JSON object uses the following fields:
*
* -
* {@code oid} -- A mandatory string field whose value is the object
* identifier for this control. For the administrative operation request
* control, the OID is "1.3.6.1.4.1.30221.2.5.11".
*
* -
* {@code control-name} -- An optional string field whose value is a
* human-readable name for this control. This field is only intended for
* descriptive purposes, and when decoding a control, the {@code oid}
* field should be used to identify the type of control.
*
* -
* {@code criticality} -- A mandatory Boolean field used to indicate
* whether this control is considered critical.
*
* -
* {@code value-base64} -- An optional string field whose value is a
* base64-encoded representation of the raw value for this administrative
* operation request control. At most one of the {@code value-base64} and
* {@code value-json} fields may be present.
*
* -
* {@code value-json} -- An optional JSON object field whose value is a
* user-friendly representation of the value for this administrative
* operation request control. At most one of the {@code value-base64} and
* {@code value-json} fields may be present, and if the {@code value-json}
* field is used, then it will use the following fields:
*
* -
* {@code message} -- An optional string field whose value is a
* message that may be used to describe the purpose of the operation.
*
*
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
final JSONObject valueObject;
if (message == null)
{
valueObject = JSONObject.EMPTY_OBJECT;
}
else
{
valueObject = new JSONObject(new JSONField(JSON_FIELD_MESSAGE, message));
}
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
ADMINISTRATIVE_OPERATION_REQUEST_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_ADMINISTRATIVE_OPERATION_REQUEST.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_VALUE_JSON,
valueObject));
}
/**
* Attempts to decode the provided object as a JSON representation of an
* administrative operation request control.
*
* @param controlObject The JSON object to be decoded. It must not be
* {@code null}.
* @param strict Indicates whether to use strict mode when decoding
* the provided JSON object. If this is {@code true},
* then this method will throw an exception if the
* provided JSON object contains any unrecognized
* fields. If this is {@code false}, then unrecognized
* fields will be ignored.
*
* @return The administrative operation request control that was decoded from
* the provided JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid administrative operation request control.
*/
@NotNull()
public static AdministrativeOperationRequestControl decodeJSONControl(
@NotNull final JSONObject controlObject,
final boolean strict)
throws LDAPException
{
final JSONControlDecodeHelper jsonControl = new JSONControlDecodeHelper(
controlObject, strict, true, false);
final ASN1OctetString rawValue = jsonControl.getRawValue();
if (rawValue != null)
{
return new AdministrativeOperationRequestControl(new Control(
jsonControl.getOID(), jsonControl.getCriticality(), rawValue));
}
final JSONObject valueObject = jsonControl.getValueObject();
if (valueObject == null)
{
return new AdministrativeOperationRequestControl();
}
final String message = valueObject.getFieldAsString(JSON_FIELD_MESSAGE);
if (strict)
{
final List unrecognizedFields =
JSONControlDecodeHelper.getControlObjectUnexpectedFields(
valueObject, JSON_FIELD_MESSAGE);
if (! unrecognizedFields.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ADMIN_OP_REQUEST_JSON_CONTROL_UNRECOGNIZED_FIELD.get(
controlObject.toSingleLineString(),
unrecognizedFields.get(0)));
}
}
return new AdministrativeOperationRequestControl(
jsonControl.getCriticality(), message);
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("AdministrativeOperationRequestControl(");
if (message != null)
{
buffer.append("message='");
buffer.append(message);
buffer.append('\'');
}
buffer.append(')');
}
}