Package org.forgerock.openig.fapi
Class FapiGenericHeaplet
java.lang.Object
org.forgerock.openig.heap.GenericHeaplet
org.forgerock.openig.fapi.FapiGenericHeaplet
- All Implemented Interfaces:
Heaplet
- Direct Known Subclasses:
FapiAuthorizeFilterChainHeaplet
,FapiDcrFilterChainHeaplet
,FapiParFilterChainHeaplet
,FapiPassThroughFilterChainHeaplet
,FapiResourceFilterChainHeaplet
,FapiResourceUnprotectedFilterChainHeaplet
,FapiTokenFilterChainHeaplet
,FapiWellKnownFilterChainHeaplet
This abstract class is used to define common filters required on all Fapi requests.
Filters chain that validates requests to make sure that they will produce OAuth2.0 clients that are compliant with the following FAPI specifications:
- Financial-grade API Security Profile 1.0 - Part 1: Baseline
- Financial-grade API Security Profile 1.0 - Part 2: Advanced
This filter is intended to front filter(s) rejecting requests that would result in an OAuth2 client being created which did not conform to the FAPI spec.
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FapiGenericHeaplet
(boolean replaceForwardedHost) Default constructor forFapiGenericHeaplet
. -
Method Summary
Methods inherited from class org.forgerock.openig.heap.GenericHeaplet
create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getType, initialBindings, meterRegistryHolder, start
-
Field Details
-
CONFIG_FORWARDED_HOST
Configuration name for forwarded host.- See Also:
-
-
Constructor Details
-
FapiGenericHeaplet
protected FapiGenericHeaplet(boolean replaceForwardedHost) Default constructor forFapiGenericHeaplet
.- Parameters:
replaceForwardedHost
- define if the headerX-Forwarded-Host
must be replaced by the configurable valueCONFIG_FORWARDED_HOST
-
-
Method Details
-
create
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.
-
createFilterChain
- Returns:
List
ofFilter
- Throws:
HeapException
-