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 2008-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2024 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) 2008-2024 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 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.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 a request control which may be used to request the server
* ID of the server that actually processed the associated request. It may be
* used for requests sent directly to a Directory Server, but it is more useful
* when the request will pass through a Directory Proxy Server instance because
* the corresponding {@link GetServerIDResponseControl} will provide the server
* ID of the backend server used to process the request. This server ID may be
* used in a {@link RouteToServerRequestControl} instance to request that
* subsequent operations be processed by the same server. See the documentation
* for the {@code RouteToServerRequestControl} for an example that demonstrates
* this.
*
*
* 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 control does not have a value. The criticality may be either
* {@code true} or {@code false}.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class GetServerIDRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.14) for the get server ID request control.
*/
@NotNull public static final String GET_SERVER_ID_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.14";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -6015835755174298354L;
/**
* Creates a new get server ID request control. It will not be marked
* critical.
*/
public GetServerIDRequestControl()
{
this(false);
}
/**
* Creates a new get server ID request control with the specified
* criticality.
*
* @param isCritical Indicates whether this control should be marked
* critical.
*/
public GetServerIDRequestControl(final boolean isCritical)
{
super(GET_SERVER_ID_REQUEST_OID, isCritical, null);
}
/**
* Creates a new get server ID request control which is decoded from the
* provided generic control.
*
* @param control The generic control to be decoded as a get server ID
* request control.
*
* @throws LDAPException If the provided control cannot be decoded as a get
* server ID request control.
*/
public GetServerIDRequestControl(@NotNull final Control control)
throws LDAPException
{
super(control);
if (control.hasValue())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_SERVER_ID_REQUEST_HAS_VALUE.get());
}
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_GET_SERVER_ID_REQUEST.get();
}
/**
* Retrieves a representation of this get server ID request control as a JSON
* object. The JSON object uses the following fields (note that since this
* control does not have a value, neither the {@code value-base64} nor
* {@code value-json} fields may be present):
*
*
* {@code oid} -- A mandatory string field whose value is the object
* identifier for this control. For the get server ID request control,
* the OID is "1.3.6.1.4.1.30221.2.5.14".
*
*
* {@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.
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
GET_SERVER_ID_REQUEST_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_GET_SERVER_ID_REQUEST.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()));
}
/**
* Attempts to decode the provided object as a JSON representation of a get
* server ID 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 get server ID request control that was decoded from the
* provided JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid get server ID request control.
*/
@NotNull()
public static GetServerIDRequestControl decodeJSONControl(
@NotNull final JSONObject controlObject,
final boolean strict)
throws LDAPException
{
final JSONControlDecodeHelper jsonControl = new JSONControlDecodeHelper(
controlObject, strict, false, false);
return new GetServerIDRequestControl(
jsonControl.getCriticality());
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("GetServerIDRequestControl(isCritical=");
buffer.append(isCritical());
buffer.append(')');
}
}
