Class ClientCredentialsOAuth2ClientFilterHeaplet

  • All Implemented Interfaces:
    Heaplet

    public class ClientCredentialsOAuth2ClientFilterHeaplet
    extends GenericHeaplet
    Creates and initializes a Filter supporting the transformation of client credentials to an access_token. This filter also supports refresh of the access_token as required. The configured client credentials are used to obtain the access_token, which is then added into the request's Authorization header.

    The ClientCredentialsOAuth2ClientFilterHeaplet has the following configuration:

     {
          "type": "ClientCredentialsOAuth2ClientFilter",
          "config": {
            <inherited configuration settings from BearerTokenOAuth2ClientFilterHeaplet>
            "clientSecretId"      : secret-id         [Deprecated since 7.2 - see (1).]
            "secretsProvider"     : secrets provider  [Deprecated since 7.2 - see (1).]
            "handler"             : handler           [Deprecated since 7.2 - see (2).]
          }
     }
     
     
    1. clientSecretId and secretsProvider are deprecated and supplied for backward compatibility only. If used, then both must be provided to obtain the client secret which authenticates using client_secret_basic. Please prefer adding a client authentication filter to your handler configuration instead. See client-secret based authentication filter heaplets ClientSecretBasicAuthenticationFilterHeaplet and ClientSecretPostAuthenticationFilterHeaplet
    2. handler has been deprecated and supplied for backward compatibility only. Please prefer to use endpointHandler instead.
    See Also:
    RFC 6749 - Client Credentials Grant
    • Constructor Detail

      • ClientCredentialsOAuth2ClientFilterHeaplet

        public ClientCredentialsOAuth2ClientFilterHeaplet()