Class AbstractSamlFederationHeaplet
- java.lang.Object
-
- org.forgerock.openig.heap.GenericHeaplet
-
- org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
-
- All Implemented Interfaces:
Heaplet
- Direct Known Subclasses:
SamlFederationFilterHeaplet
,SamlFederationHandlerHeaplet
public abstract class AbstractSamlFederationHeaplet extends GenericHeaplet
The base class for both the filter and handler heaplet implementations.
-
-
Constructor Summary
Constructors Constructor Description AbstractSamlFederationHeaplet()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
completeSamlConfig(JsonValue config, String logoutUri, org.forgerock.openig.handler.saml.SamlConfig.Builder builder)
Object
create()
Called to request the heaplet create an object.protected abstract Object
create(SamlConfig samlConfig)
protected Promise<Response,NeverThrowsException>
defaultFailureHandler(Context context, Request request)
The default failure handler to use should none be provided in the configuration.void
destroy()
Called to indicate that the object created by the heaplet is going to be dereferenced.-
Methods inherited from class org.forgerock.openig.heap.GenericHeaplet
create, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getSecretsProvider, getType, initialBindings, 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.
-
completeSamlConfig
protected abstract void completeSamlConfig(JsonValue config, String logoutUri, org.forgerock.openig.handler.saml.SamlConfig.Builder builder) throws HeapException
- Throws:
HeapException
-
create
protected abstract Object create(SamlConfig samlConfig)
-
destroy
public void destroy()
Description copied from interface:Heaplet
Called to indicate that the object created by the heaplet is going to be dereferenced. This gives the heaplet an opportunity to free any resources that are being held prior to its dereference.- Specified by:
destroy
in interfaceHeaplet
- Overrides:
destroy
in classGenericHeaplet
-
defaultFailureHandler
protected Promise<Response,NeverThrowsException> defaultFailureHandler(Context context, Request request)
The default failure handler to use should none be provided in the configuration.
-
-