Package com.unboundid.ldap.sdk.unboundidds.controls

Class GetAuthorizationEntryResponseControl

  • All Implemented Interfaces:
    DecodeableControl, java.io.Serializable
    @NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetAuthorizationEntryResponseControl
extends Control
implements DecodeableControl
    This class provides an implementation of an LDAP control that may be included in a bind response to provide information about the authenticated and/or authorized user.
    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.

    The value of this control will be encoded as follows: 
       GetAuthorizationEntryResponse ::= SEQUENCE {
     isAuthenticated     [0] BOOLEAN,
     identitiesMatch     [1] BOOLEAN,
     authNEntry          [2] AuthEntry OPTIONAL,
     authZEntry          [3] AuthEntry OPTIONAL }

   AuthEntry ::= SEQUENCE {
     authID         [0] AuthzId OPTIONAL,
     authDN         [1] LDAPDN,
     attributes     [2] PartialAttributeList }


    See the documentation for the GetAuthorizationEntryRequestControl class for more information and an example demonstrating the use of these controls.
    See Also:
    Serialized Form

    • Constructor Detail

      • GetAuthorizationEntryResponseControl

        public GetAuthorizationEntryResponseControl​(boolean isAuthenticated,
                                            boolean identitiesMatch,
                                            @Nullable
                                            java.lang.String authNID,
                                            @Nullable
                                            ReadOnlyEntry authNEntry,
                                            @Nullable
                                            java.lang.String authZID,
                                            @Nullable
                                            ReadOnlyEntry authZEntry)
        Creates a new get authorization entry response control with the provided information.
        Parameters:
        isAuthenticated - Indicates whether the client is authenticated.
        identitiesMatch - Indicates whether the authentication identity is the same as the authorization identity.
        authNID - The string that may be used to reference the authentication identity. It may be null if information about the authentication identity is not to be included, or if the identifier should be derived from the DN.
        authNEntry - The entry for the authentication identity. It may be null if the information about the authentication identity is not to be included.
        authZID - The string that may be used to reference the authorization identity. It may be null if information about the authentication identity is not to be included, if the identifier should be derived from the DN, or if the authentication and authorization identities are the same.
        authZEntry - The entry for the authentication identity. It may be null if the information about the authentication identity is not to be included, or if the authentication and authorization identities are the same.

      • GetAuthorizationEntryResponseControl

        public GetAuthorizationEntryResponseControl​(@NotNull
                                            java.lang.String oid,
                                            boolean isCritical,
                                            @Nullable
                                            ASN1OctetString value)
                                     throws LDAPException
        Creates a new get authorization entry 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 a get authorization entry response control.

    • Method Detail

      • get

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

      • isAuthenticated

        public boolean isAuthenticated()
        Indicates whether the client is authenticated.
        Returns:
        true if the client is authenticated, or false if not.

      • identitiesMatch

        public boolean identitiesMatch()
        Indicates whether the authentication identity and the authorization identity reference the same user.
        Returns:
        true if both the authentication identity and the authorization identity reference the same user, or false if not.

      • getAuthNID

        @Nullable
public java.lang.String getAuthNID()
        Retrieves the identifier that may be used to reference the authentication identity in the directory server, if it is available.
        Returns:
        The identifier that may be used to reference the authentication identity in the directory server, or null if it is not available.

      • getAuthNEntry

        @Nullable
public ReadOnlyEntry getAuthNEntry()
        Retrieves the entry for the user specified as the authentication identity, if it is available.
        Returns:
        The entry for the user specified as the authentication identity, or null if it is not available.

      • getAuthZID

        @Nullable
public java.lang.String getAuthZID()
        Retrieves the identifier that may be used to reference the authorization identity in the directory server, if it is available.
        Returns:
        The identifier that may be used to reference the authorization identity in the directory server, or null if it is not available.

      • getAuthZEntry

        @Nullable
public ReadOnlyEntry getAuthZEntry()
        Retrieves the entry for the user specified as the authorization identity, if it is available.
        Returns:
        The entry for the user specified as the authorization identity, or null if it is not available.

      • 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.