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": {
            "clientId"            : expression        [REQUIRED - the 'client ID'. ]
            "clientSecretId"      : expression        [REQUIRED - secret ID used to obtain the 'client secret'. ]
            "secretsProvider"     : secrets provider  [REQUIRED - secrets provider used to obtain "clientSecretId". ]
            "tokenEndpoint"       : expression        [REQUIRED - endpoint to use to obtain access_token. ]
            "scopes"              : [ expressions ]   [OPTIONAL - specific scopes add to the request. Default is empty. ]
            "handler"             : handler           [OPTIONAL - handler to use to access the token endpoint - default to
                                                                  ClientHandler.]
          }
     }
     
     
    • Constructor Detail

      • ClientCredentialsOAuth2ClientFilterHeaplet

        public ClientCredentialsOAuth2ClientFilterHeaplet()
    • Method Detail