Class ClientCredentialsOAuth2ClientFilterHeaplet
- java.lang.Object
-
- org.forgerock.openig.heap.GenericHeaplet
-
- org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterHeaplet
-
- All Implemented Interfaces:
Heaplet
public class ClientCredentialsOAuth2ClientFilterHeaplet extends GenericHeaplet
Creates and initializes aFilter
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 Summary
Constructors Constructor Description ClientCredentialsOAuth2ClientFilterHeaplet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
create()
Called to request the heaplet create an object.-
Methods inherited from class org.forgerock.openig.heap.GenericHeaplet
create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start
-
-
-
-
Method Detail
-
create
public Object create() throws HeapException
Description copied from class:GenericHeaplet
Called to request the heaplet create an object. Called byHeaplet.create(Name, JsonValue, Heap)
after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by theGenericHeaplet.start()
method.- Specified by:
create
in classGenericHeaplet
- Returns:
- The created object.
- Throws:
HeapException
- if an exception occurred during creation of the heap object or any of its dependencies.
-
-