Class 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 a PostReadResponseControl in the add result to make the generated DN available to the client. If the request already includes a PostReadRequestControl, 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 of true. It does not take a value.
    See Also:
    Serialized Form
    • Constructor Detail

      • 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 class Control
        Returns:
        The user-friendly name for this control, or the OID if no user-friendly name is available.
      • 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.