Interface HttpOauth2OpenamAuthorizationMechanismCfg

    • Method Detail

      • addHttpOauth2OpenamAuthorizationMechanismChangeListener

        void addHttpOauth2OpenamAuthorizationMechanismChangeListener​(ConfigurationChangeListener<HttpOauth2OpenamAuthorizationMechanismCfg> listener)
        Register to be notified when this HTTP OAuth2 OpenAM Authorization Mechanism is changed.
        Parameters:
        listener - The HTTP OAuth2 OpenAM Authorization Mechanism configuration change listener.
      • removeHttpOauth2OpenamAuthorizationMechanismChangeListener

        void removeHttpOauth2OpenamAuthorizationMechanismChangeListener​(ConfigurationChangeListener<HttpOauth2OpenamAuthorizationMechanismCfg> listener)
        Deregister an existing HTTP OAuth2 OpenAM Authorization Mechanism configuration change listener.
        Parameters:
        listener - The HTTP OAuth2 OpenAM Authorization Mechanism configuration change listener.
      • getJavaClass

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

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

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

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

        String getKeyManagerProvider()
        Gets the "key-manager-provider" property.

        Specifies the name of the key manager that should be used with this HTTP OAuth2 OpenAM Authorization Mechanism .

        Returns:
        Returns the value of the "key-manager-provider" property.
      • getKeyManagerProviderDn

        Dn getKeyManagerProviderDn()
        Gets the "key-manager-provider" property as a DN.

        Specifies the name of the key manager that should be used with this HTTP OAuth2 OpenAM Authorization Mechanism .

        Returns:
        Returns the DN value of the "key-manager-provider" property.
      • getSslCertNickname

        SortedSet<String> getSslCertNickname()
        Gets the "ssl-cert-nickname" property.

        Specifies the nicknames (also called the aliases) of the keys or key pairs that the HTTP OAuth2 OpenAM Authorization Mechanism should use when performing SSL communication.

        The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the HTTP OAuth2 OpenAM Authorization Mechanism is configured to use SSL.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cert-nickname" property.
      • getSslCipherSuite

        SortedSet<String> getSslCipherSuite()
        Gets the "ssl-cipher-suite" property.

        Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cipher-suite" property.
      • getSslProtocol

        SortedSet<String> getSslProtocol()
        Gets the "ssl-protocol" property.

        Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-protocol" property.
      • getTokenInfoUrl

        String getTokenInfoUrl()
        Gets the "token-info-url" property.

        Defines the OpenAM endpoint URL where the access-token resolution request should be sent.

        Returns:
        Returns the value of the "token-info-url" property.
      • getTrustManagerProvider

        String getTrustManagerProvider()
        Gets the "trust-manager-provider" property.

        Specifies the name of the trust manager that should be used when negotiating SSL connections with the remote authorization server.

        Returns:
        Returns the value of the "trust-manager-provider" property.
      • getTrustManagerProviderDn

        Dn getTrustManagerProviderDn()
        Gets the "trust-manager-provider" property as a DN.

        Specifies the name of the trust manager that should be used when negotiating SSL connections with the remote authorization server.

        Returns:
        Returns the DN value of the "trust-manager-provider" property.