com.unboundid.ldap.sdk.unboundidds.controls

Class GetServerIDResponseControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.GetServerIDResponseControl

All Implemented Interfaces:

DecodeableControl, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetServerIDResponseControl
extends Control
implements DecodeableControl

This class provides a response control that may be used to provide the server ID of the Directory Server instance that processed the associated request. For search operations, each entry and reference returned will include the server ID of the server that provided that entry or reference. For all other types of operations, it will be in the LDAPResult (or appropriate subclass) returned for that operation.

NOTE: This class, and other classes within the 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 has an OID of 1.3.6.1.4.1.30221.2.5.15 and a criticality of false. This control must have a value, which will simply be the string representation of the server ID of the associated server.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_SERVER_ID_RESPONSE_OID The OID (1.3.6.1.4.1.30221.2.5.15) for the get server ID response control.

Constructor Summary

Constructors

Constructor and Description
GetServerIDResponseControl(java.lang.String serverID) Creates a new get server ID response control with the provided server ID.
GetServerIDResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) Creates a new get server ID response control decoded from the given generic control contents.

Method Summary

Modifier and Type	Method and Description
GetServerIDResponseControl	decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) Creates a new instance of this decodeable control from the provided information.
static GetServerIDResponseControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a get server ID response control.
static GetServerIDResponseControl	get(LDAPResult result) Extracts a get server ID response control from the provided result.
static GetServerIDResponseControl	get(SearchResultEntry entry) Extracts a get server ID response control from the provided search result entry.
static GetServerIDResponseControl	get(SearchResultReference ref) Extracts a get server ID response control from the provided search result reference.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
java.lang.String	getServerID() Retrieves the server ID of the server that actually processed the associated request.
JSONObject	toJSONControl() Retrieves a representation of this get server ID response control as a JSON object.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP control to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.Control

decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GET_SERVER_ID_RESPONSE_OID

@NotNull
public static final java.lang.String GET_SERVER_ID_RESPONSE_OID

The OID (1.3.6.1.4.1.30221.2.5.15) for the get server ID response control.

See Also:

Constant Field Values

Constructor Detail

GetServerIDResponseControl

public GetServerIDResponseControl(@NotNull
                                  java.lang.String serverID)

Creates a new get server ID response control with the provided server ID.

Parameters:

serverID - The server ID of the server that processed the associated request. It must not be null.

GetServerIDResponseControl

public GetServerIDResponseControl(@NotNull
                                  java.lang.String oid,
                                  boolean isCritical,
                                  @Nullable
                                  ASN1OctetString value)
                           throws LDAPException

Creates a new get server ID response control decoded from the given generic control contents.

Parameters:

oid - The OID for the control.

isCritical - Indicates whether this control should be marked critical.

value - The value for the control. It may be null if the control to decode does not have a value.

Throws:

LDAPException - If a problem occurs while attempting to decode the generic control as a get server ID response control.

Method Detail

decodeControl

@NotNull
public GetServerIDResponseControl decodeControl(@NotNull
                                                         java.lang.String oid,
                                                         boolean isCritical,
                                                         @Nullable
                                                         ASN1OctetString value)
                                                  throws LDAPException

Creates a new instance of this decodeable control from the provided information.

Specified by:

decodeControl in interface DecodeableControl

Parameters:

oid - The OID for the control.

isCritical - Indicates whether the control should be marked critical.

value - The encoded value for the control. This may be null if no value was provided.

Returns:

The decoded representation of this control.

Throws:

LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

get

@Nullable
public static GetServerIDResponseControl get(@NotNull
                                                       LDAPResult result)
                                                throws LDAPException

Extracts a get server ID response control from the provided result.

Parameters:

result - The result from which to retrieve the get server ID response control.

Returns:

The get server ID response control contained in the provided result, or null if the result did not contain a get server ID response control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the get server ID response control contained in the provided result.

get

@Nullable
public static GetServerIDResponseControl get(@NotNull
                                                       SearchResultEntry entry)
                                                throws LDAPException

Extracts a get server ID response control from the provided search result entry.

Parameters:

entry - The search result entry from which to retrieve the get server ID response control.

Returns:

The get server ID response control contained in the provided search result entry, or null if the entry did not contain a get server ID response control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the get server ID response control contained in the provided entry.

get

@Nullable
public static GetServerIDResponseControl get(@NotNull
                                                       SearchResultReference ref)
                                                throws LDAPException

Extracts a get server ID response control from the provided search result reference.

Parameters:

ref - The search result reference from which to retrieve the get server ID response control.

Returns:

The get server ID response control contained in the provided search result reference, or null if the reference did not contain a get server ID response control.

Throws:

LDAPException - If a problem is encountered while attempting to decode the get server ID response control contained in the provided reference.

getServerID

@NotNull
public java.lang.String getServerID()

Retrieves the server ID of the server that actually processed the associated request.

Returns:

The server ID of the server that actually processed the associated request.

getControlName

@NotNull
public java.lang.String getControlName()

Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:

getControlName in class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this get server ID response control as a JSON object. The JSON object uses the following fields:

• oid -- A mandatory string field whose value is the object identifier for this control. For the get server ID response control, the OID is "1.3.6.1.4.1.30221.2.5.15".
• 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 oid field should be used to identify the type of control.
• criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
• value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this get server ID response control. Exactly one of the value-base64 and value-json fields must be present.
• value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this get server ID response control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
  • server-id -- A string field whose value is the server ID for the server that processed the operation or returned the entry.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static GetServerIDResponseControl decodeJSONControl(@NotNull
                                                                    JSONObject controlObject,
                                                                    boolean strict)
                                                             throws LDAPException

Attempts to decode the provided object as a JSON representation of a get server ID response control.

Parameters:

controlObject - The JSON object to be decoded. It must not be null.

strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.

Returns:

The get server ID response 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 response control.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this LDAP control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which to append the string representation of this buffer.