Interface HttpOauth2AuthorizationMechanismCfg

    • Method Detail

      • addHttpOauth2AuthorizationMechanismChangeListener

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

        void removeHttpOauth2AuthorizationMechanismChangeListener​(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
        Deregister an existing HTTP OAuth2 Authorization Mechanism configuration change listener.
        Parameters:
        listener - The HTTP OAuth2 Authorization Mechanism configuration change listener.
      • isAccessTokenCacheEnabled

        boolean isAccessTokenCacheEnabled()
        Gets the "access-token-cache-enabled" property.

        Indicates whether the HTTP OAuth2 Authorization Mechanism is enabled for use.

        Default value: false

        Returns:
        Returns the value of the "access-token-cache-enabled" property.
      • getAccessTokenCacheExpiration

        Long getAccessTokenCacheExpiration()
        Gets the "access-token-cache-expiration" property.

        Token cache expiration

        Default value is undefined

        Returns:
        Returns the value of the "access-token-cache-expiration" property.
      • getAuthzidJsonPointer

        String getAuthzidJsonPointer()
        Gets the "authzid-json-pointer" property.

        Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document.

        Returns:
        Returns the value of the "authzid-json-pointer" property.
      • getIdentityMapper

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

        Specifies the name of the identity mapper(s) to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.

        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) to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.

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

        SortedSet<String> getRequiredScope()
        Gets the "required-scope" property.

        Scopes required to grant access to the service.

        Returns:
        Returns an unmodifiable set containing the values of the "required-scope" property.