@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetServerIDResponseControl extends Control implements DecodeableControl
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.
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 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.
|
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 |
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.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String GET_SERVER_ID_RESPONSE_OID
public GetServerIDResponseControl(@NotNull java.lang.String serverID)
serverID
- The server ID of the server that processed the associated
request. It must not be null
.public GetServerIDResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
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.LDAPException
- If a problem occurs while attempting to decode the
generic control as a get server ID response
control.@NotNull public GetServerIDResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
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.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.@Nullable public static GetServerIDResponseControl get(@NotNull LDAPResult result) throws LDAPException
result
- The result from which to retrieve the get server ID
response control.null
if the result did not contain a get server
ID response control.LDAPException
- If a problem is encountered while attempting to
decode the get server ID response control contained
in the provided result.@Nullable public static GetServerIDResponseControl get(@NotNull SearchResultEntry entry) throws LDAPException
entry
- The search result entry from which to retrieve the get
server ID response control.null
if the entry did not contain
a get server ID response control.LDAPException
- If a problem is encountered while attempting to
decode the get server ID response control contained
in the provided entry.@Nullable public static GetServerIDResponseControl get(@NotNull SearchResultReference ref) throws LDAPException
ref
- The search result reference from which to retrieve the get
server ID response control.null
if the reference did not
contain a get server ID response control.LDAPException
- If a problem is encountered while attempting to
decode the get server ID response control contained
in the provided reference.@NotNull public java.lang.String getServerID()
@NotNull public java.lang.String getControlName()
getControlName
in class Control