Class GetAuthorizationEntryRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class GetAuthorizationEntryRequestControl
    extends Control
    This class provides an implementation of an LDAP control that can be included in a bind request to request that the Directory Server return the authentication and authorization entries for the user that authenticated.
    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 may be absent, but if it is present then will be encoded as follows:
       GetAuthorizationEntryRequest ::= SEQUENCE {
            includeAuthNEntry     [0] BOOLEAN DEFAULT TRUE,
            includeAuthZEntry     [1] BOOLEAN DEFAULT TRUE,
            attributes            [2] AttributeSelection OPTIONAL }
     


    Example

    The following example demonstrates the process for processing a bind operation using the get authorization entry request control to return all user attributes in both the authentication and authorization entries:
     ReadOnlyEntry authNEntry = null;
     ReadOnlyEntry authZEntry = null;
    
     BindRequest bindRequest = new SimpleBindRequest(
          "uid=john.doe,ou=People,dc=example,dc=com", "password",
          new GetAuthorizationEntryRequestControl());
    
     BindResult bindResult = connection.bind(bindRequest);
     GetAuthorizationEntryResponseControl c =
          GetAuthorizationEntryResponseControl.get(bindResult);
     if (c != null)
     {
       authNEntry = c.getAuthNEntry();
       authZEntry = c.getAuthZEntry();
     }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • GetAuthorizationEntryRequestControl

        public GetAuthorizationEntryRequestControl()
        Creates a new get authorization entry request control that will request all user attributes in both the authentication and authorization entries. It will not be marked critical.
      • GetAuthorizationEntryRequestControl

        public GetAuthorizationEntryRequestControl​(boolean includeAuthNEntry,
                                                   boolean includeAuthZEntry,
                                                   java.lang.String... attributes)
        Creates a new get authorization entry request control with the provided information.
        Parameters:
        includeAuthNEntry - Indicates whether to include the authentication entry in the response.
        includeAuthZEntry - Indicates whether to include the authorization entry in the response.
        attributes - The attributes to include in the entries in the response. It may be empty or null to request all user attributes.
      • GetAuthorizationEntryRequestControl

        public GetAuthorizationEntryRequestControl​(boolean includeAuthNEntry,
                                                   boolean includeAuthZEntry,
                                                   java.util.List<java.lang.String> attributes)
        Creates a new get authorization entry request control with the provided information.
        Parameters:
        includeAuthNEntry - Indicates whether to include the authentication entry in the response.
        includeAuthZEntry - Indicates whether to include the authorization entry in the response.
        attributes - The attributes to include in the entries in the response. It may be empty or null to request all user attributes.
      • GetAuthorizationEntryRequestControl

        public GetAuthorizationEntryRequestControl​(boolean isCritical,
                                                   boolean includeAuthNEntry,
                                                   boolean includeAuthZEntry,
                                                   java.lang.String... attributes)
        Creates a new get authorization entry request control with the provided information.
        Parameters:
        isCritical - Indicates whether the control should be marked critical.
        includeAuthNEntry - Indicates whether to include the authentication entry in the response.
        includeAuthZEntry - Indicates whether to include the authorization entry in the response.
        attributes - The attributes to include in the entries in the response. It may be empty or null to request all user attributes.
      • GetAuthorizationEntryRequestControl

        public GetAuthorizationEntryRequestControl​(boolean isCritical,
                                                   boolean includeAuthNEntry,
                                                   boolean includeAuthZEntry,
                                                   java.util.List<java.lang.String> attributes)
        Creates a new get authorization entry request control with the provided information.
        Parameters:
        isCritical - Indicates whether the control should be marked critical.
        includeAuthNEntry - Indicates whether to include the authentication entry in the response.
        includeAuthZEntry - Indicates whether to include the authorization entry in the response.
        attributes - The attributes to include in the entries in the response. It may be empty or null to request all user attributes.
      • GetAuthorizationEntryRequestControl

        public GetAuthorizationEntryRequestControl​(Control control)
                                            throws LDAPException
        Creates a new get authorization entry request control which is decoded from the provided generic control.
        Parameters:
        control - The generic control to decode as a get authorization entry request control.
        Throws:
        LDAPException - If the provided control cannot be decoded as a get authorization entry request control.
    • Method Detail

      • includeAuthNEntry

        public boolean includeAuthNEntry()
        Indicates whether the entry for the authenticated user should be included in the response control.
        Returns:
        true if the entry for the authenticated user should be included in the response control, or false if not.
      • includeAuthZEntry

        public boolean includeAuthZEntry()
        Indicates whether the entry for the authorized user should be included in the response control.
        Returns:
        true if the entry for the authorized user should be included in the response control, or false if not.
      • getAttributes

        public java.util.List<java.lang.String> getAttributes()
        Retrieves the attributes that will be requested for the authentication and/or authorization entries.
        Returns:
        The attributes that will be requested for the authentication and/or authorization entries, or an empty list if all user attributes should be included.
      • getControlName

        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​(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.