Class NameWithEntryUUIDRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.NameWithEntryUUIDRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NameWithEntryUUIDRequestControl extends Control
This class provides an implementation of the name with entryUUID request control. It may be included in an add request to indicate that the server should replace the provided RDN with the server-generated entryUUID value. It will also cause the server to include aPostReadResponseControl
in the add result to make the generated DN available to the client. If the request already includes aPostReadRequestControl
, then the attributes included in the post-read response control will be generated from that request control. Otherwise, the server will behave as if the request had included a post-read request control requesting only the entryUUID attribute.
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.44". It is recommended that it be used with a criticality oftrue
. It does not take a value.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME_WITH_ENTRY_UUID_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.44) for the name with entryUUID request control.
-
Constructor Summary
Constructors Constructor Description NameWithEntryUUIDRequestControl()
Creates a new name with entryUUID request control.NameWithEntryUUIDRequestControl(boolean isCritical)
Creates a new name with entryUUID request control with the specified criticality.NameWithEntryUUIDRequestControl(Control control)
Creates a new name with entryUUID request control which is decoded from the provided generic control.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NameWithEntryUUIDRequestControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of a name with entryUUID request control.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this name with entryUUID request 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
-
-
-
-
Field Detail
-
NAME_WITH_ENTRY_UUID_REQUEST_OID
@NotNull public static final java.lang.String NAME_WITH_ENTRY_UUID_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.44) for the name with entryUUID request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NameWithEntryUUIDRequestControl
public NameWithEntryUUIDRequestControl()
Creates a new name with entryUUID request control. It will be marked critical.
-
NameWithEntryUUIDRequestControl
public NameWithEntryUUIDRequestControl(boolean isCritical)
Creates a new name with entryUUID request control with the specified criticality.- Parameters:
isCritical
- Indicates whether this control should be marked critical.
-
NameWithEntryUUIDRequestControl
public NameWithEntryUUIDRequestControl(@NotNull Control control) throws LDAPException
Creates a new name with entryUUID request control which is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a name with entryUUID request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a name with entryUUID request control.
-
-
Method Detail
-
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 classControl
- 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 name with entryUUID request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither thevalue-base64
norvalue-json
fields may be present):-
oid
-- A mandatory string field whose value is the object identifier for this control. For the name with entryUUID request control, the OID is "1.3.6.1.4.1.30221.2.5.44". -
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, theoid
field should be used to identify the type of control. -
criticality
-- A mandatory Boolean field used to indicate whether this control is considered critical.
- Overrides:
toJSONControl
in classControl
- Returns:
- A JSON object that contains a representation of this control.
-
-
decodeJSONControl
@NotNull public static NameWithEntryUUIDRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
Attempts to decode the provided object as a JSON representation of a name with entryUUID request control.- Parameters:
controlObject
- The JSON object to be decoded. It must not benull
.strict
- Indicates whether to use strict mode when decoding the provided JSON object. If this istrue
, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this isfalse
, then unrecognized fields will be ignored.- Returns:
- The name with entryUUID request control that was decoded from the provided JSON object.
- Throws:
LDAPException
- If the provided JSON object cannot be parsed as a valid name with entryUUID request control.
-
-