Package org.forgerock.openig.filter.oauth2

Class TokenIntrospectionAccessTokenResolverHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.oauth2.TokenIntrospectionAccessTokenResolverHeaplet

All Implemented Interfaces:

Heaplet

public class TokenIntrospectionAccessTokenResolverHeaplet
extends GenericHeaplet

Creates and initializes an TokenIntrospectionAccessTokenResolver in a heap environment. It validates the token against the token introspection endpoint URL provided in the configuration.

 
 {
         "name": "OAuth 2.0 Authorization Server",
         "type": "TokenIntrospectionAccessTokenResolver",
         "config": {
           "endpoint": "https://as.example.com/oauth2/introspect",
           "providerHandler": "ForgeRockClientHandler",
         }
 }
 
 

providerHandler is a name reference to another handler available in the heap. It will be used to perform access token introspection against the endpoint URL. It is usually a reference to some ClientHandler and more specifically the ForgeRockClientHandler.

Or if using the new AmService reference:

 
 {
         "name": "OAuth 2.0 Authorization Server",
         "type": "TokenIntrospectionAccessTokenResolver",
         "config": {
           "amService": "AmService",
           "providerHandler": "ForgeRockClientHandler",
         }
 }
 
 

In this example, the access token introspection endpoint will be extrapolated from the OAuth2 endpoint provided by the amService and will be used in preference to any endpoint value set.

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
TokenIntrospectionAccessTokenResolverHeaplet()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenIntrospectionAccessTokenResolverHeaplet

public TokenIntrospectionAccessTokenResolverHeaplet()

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.