Package org.forgerock.openig.handler.saml

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.

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
AbstractSamlFederationHeaplet()

Method Summary

Modifier and Type	Method	Description
protected abstract void	completeSamlConfig(JsonValue config, String logoutUri, org.forgerock.openig.handler.saml.SamlConfig.Builder builder)	Permit to complement the SamlConfig SamlConfig.Builder.
Object	create()	Called to request the heaplet create an object.
protected abstract Object	create(SamlConfig samlConfig)	Create the final Heap Object.
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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSamlFederationHeaplet

public AbstractSamlFederationHeaplet()

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.

completeSamlConfig

protected abstract void completeSamlConfig(JsonValue config,
                                           String logoutUri,
                                           org.forgerock.openig.handler.saml.SamlConfig.Builder builder)
                                    throws HeapException

Permit to complement the SamlConfig SamlConfig.Builder.

Parameters:

config - the Heaplet configuration

logoutUri - the logout URI

builder - the SamlConfig builder to complement

Throws:

HeapException - in case of any error.

create

protected abstract Object create(SamlConfig samlConfig)

Create the final Heap Object.

Parameters:

samlConfig - the Saml configuration to base this object on.

Returns:

the final heap object to return.

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 interface Heaplet

Overrides:

destroy in class GenericHeaplet

defaultFailureHandler

protected Promise<Response,NeverThrowsException> defaultFailureHandler(Context context,
                                                                             Request request)

The default failure handler to use should none be provided in the configuration.

Parameters:

context - The Context.

request - The Request

Returns:

The default failure handler