Package org.forgerock.openig.filter.jwt

Class JwtValidationFilter.Heaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.jwt.JwtValidationFilter.Heaplet

All Implemented Interfaces:

Heaplet

Direct Known Subclasses:

IdTokenValidationFilterHeaplet

Enclosing class:

JwtValidationFilter

public static class JwtValidationFilter.Heaplet
extends GenericHeaplet

Creates and initializes a JwtValidationFilter in a heap environment.

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
Heaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.
protected Expression<String>	jwtExpression()	Returns the expression to be used to obtain the JWT token value.
protected Optional<JwtValidatorCustomizer>	jwtValidatorCustomizer()	Returns an instance of a JwtValidatorCustomizer if one has been defined.

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

Heaplet

public Heaplet()

Method Detail

create

public 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.

jwtExpression

protected Expression<String> jwtExpression()

Returns the expression to be used to obtain the JWT token value.

Returns:

the expression to be used to obtain the JWT token value.

jwtValidatorCustomizer

protected Optional<JwtValidatorCustomizer> jwtValidatorCustomizer()
                                                           throws HeapException

Returns an instance of a JwtValidatorCustomizer if one has been defined.

Returns:

an instance of a JwtValidatorCustomizer if one has been defined.

Throws:

HeapException - if there were any issues defining the instance.