Package org.forgerock.openig.filter.oauth2.client.authentication

Class ClientSecretBasicAuthenticationFilterHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretBasicAuthenticationFilterHeaplet

All Implemented Interfaces:

Heaplet

public class ClientSecretBasicAuthenticationFilterHeaplet
extends GenericHeaplet

Heaplet supporting creation of a client-secret-basic authentication Filter.

See Also:

Filters.newUrlEncodedHttpBasicAuthFilter(java.lang.String, org.forgerock.secrets.SecretReference<org.forgerock.secrets.GenericSecret>)

Field Summary

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
ClientSecretBasicAuthenticationFilterHeaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.
protected Filter	createFilter(String clientId, SecretReference<GenericSecret> clientSecretRef)	Create the appropriate client-secret authentication Filter instance.

Methods inherited from class org.forgerock.openig.heap.GenericHeaplet

create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientSecretBasicAuthenticationFilterHeaplet

public ClientSecretBasicAuthenticationFilterHeaplet()

Method Detail

createFilter

protected Filter createFilter(String clientId,
                              SecretReference<GenericSecret> clientSecretRef)

Create the appropriate client-secret authentication Filter instance.

Parameters:

clientId - The authentication client id

clientSecretRef - The authentication client secret SecretReference

Returns:

A client-secret-based authentication Filter

create

public final Object create()
                    throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet create an object. Called by Heaplet.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 the GenericHeaplet.start() method.

Specified by:

create in class GenericHeaplet

Returns:

The created object.

Throws:

HeapException - if an exception occurred during creation of the heap object or any of its dependencies.