Interface HttpBasicAuthorizationMechanismCfg

  • All Superinterfaces:
    Configuration, HttpAuthorizationMechanismCfg

    public interface HttpBasicAuthorizationMechanismCfg
    extends HttpAuthorizationMechanismCfg
    A server-side interface for querying HTTP Basic Authorization Mechanism settings.

    The HTTP Basic Authorization Mechanism authenticates the end-user using credentials extracted from the HTTP Basic 'Authorization' header.

    • Method Detail

      • addHttpBasicAuthorizationMechanismChangeListener

        void addHttpBasicAuthorizationMechanismChangeListener​(ConfigurationChangeListener<HttpBasicAuthorizationMechanismCfg> listener)
        Register to be notified when this HTTP Basic Authorization Mechanism is changed.
        Parameters:
        listener - The HTTP Basic Authorization Mechanism configuration change listener.
      • removeHttpBasicAuthorizationMechanismChangeListener

        void removeHttpBasicAuthorizationMechanismChangeListener​(ConfigurationChangeListener<HttpBasicAuthorizationMechanismCfg> listener)
        Deregister an existing HTTP Basic Authorization Mechanism configuration change listener.
        Parameters:
        listener - The HTTP Basic Authorization Mechanism configuration change listener.
      • isAltAuthenticationEnabled

        boolean isAltAuthenticationEnabled()
        Gets the "alt-authentication-enabled" property.

        Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.

        Default value: false

        Returns:
        Returns the value of the "alt-authentication-enabled" property.
      • getAltPasswordHeader

        String getAltPasswordHeader()
        Gets the "alt-password-header" property.

        Alternate HTTP headers to get the user's password from.

        Default value is undefined

        Returns:
        Returns the value of the "alt-password-header" property.
      • getAltUsernameHeader

        String getAltUsernameHeader()
        Gets the "alt-username-header" property.

        Alternate HTTP headers to get the user's name from.

        Default value is undefined

        Returns:
        Returns the value of the "alt-username-header" property.
      • getIdentityMapper

        SortedSet<String> getIdentityMapper()
        Gets the "identity-mapper" property.

        Specifies the name of the identity mapper(s) used to get the user's entry corresponding to the user-id provided in the HTTP authentication header.

        Returns:
        Returns an unmodifiable set containing the values of the "identity-mapper" property.
      • getIdentityMapperDns

        SortedSet<Dn> getIdentityMapperDns()
        Gets the "identity-mapper" property as a set of DNs.

        Specifies the name of the identity mapper(s) used to get the user's entry corresponding to the user-id provided in the HTTP authentication header.

        Returns:
        Returns the DN values of the "identity-mapper" property.
      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.

        Default value: org.opends.server.protocols.http.authz.HttpBasicAuthorizationMechanism

        Specified by:
        getJavaClass in interface HttpAuthorizationMechanismCfg
        Returns:
        Returns the value of the "java-class" property.