Class AuthorizationIdentityResponseControl

  • All Implemented Interfaces:
    DecodeableControl, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class AuthorizationIdentityResponseControl
    extends Control
    implements DecodeableControl
    This class provides an implementation of the authorization identity bind response control as defined in RFC 3829. It may be used to provide the primary authorization identity associated with the client connection after processing of the associated bind operation has completed.

    The authorization identity value returned may be empty if the resulting authorization identity is that of the anonymous user. Otherwise, it should be an "authzId" value as described in section 5.2.1.8 of RFC 4513. That is, it should be either "dn:" followed by the distinguished name of the target user, or "u:" followed by the username.

    Note that the authorization identity response control should only be included in a bind response message if the corresponding request included the AuthorizationIdentityRequestControl, and only if the bind was successful.
    See Also:
    Serialized Form
    • Constructor Detail

      • AuthorizationIdentityResponseControl

        public AuthorizationIdentityResponseControl​(@NotNull
                                                    java.lang.String authorizationID)
        Creates a new authorization identity response control with the provided authorization ID.
        Parameters:
        authorizationID - The authorization identity associated with the client connection. It must not be null, although it may be a zero-length string to indicate that the authorization identity is the anonymous user.
      • AuthorizationIdentityResponseControl

        public AuthorizationIdentityResponseControl​(@NotNull
                                                    java.lang.String oid,
                                                    boolean isCritical,
                                                    @Nullable
                                                    ASN1OctetString value)
                                             throws LDAPException
        Creates a new authorization identity response control with the provided information.
        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.
        Throws:
        LDAPException - If the provided control cannot be decoded as an authorization identity response control.
    • Method Detail

      • get

        @Nullable
        public static AuthorizationIdentityResponseControl get​(@NotNull
                                                               BindResult result)
                                                        throws LDAPException
        Extracts an authorization identity response control from the provided result.
        Parameters:
        result - The result from which to retrieve the authorization identity response control.
        Returns:
        The authorization identity response control contained in the provided result, or null if the result did not contain an authorization identity response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the authorization identity response control contained in the provided result.
      • getAuthorizationID

        @NotNull
        public java.lang.String getAuthorizationID()
        Retrieves the authorization ID string for this authorization identity response control. It may be a zero-length string if the associated authorization identity is that of the anonymous user.
        Returns:
        The authorization ID string for this authorization identity response control.
      • 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.