Package org.forgerock.openig.assertion.plugin

Class ScriptableIdentityAssertionPlugin

java.lang.Object

org.forgerock.openig.script.AbstractScriptableHeapObject<IdentityAssertionClaims>

org.forgerock.openig.assertion.plugin.ScriptableIdentityAssertionPlugin

All Implemented Interfaces:

Closeable, AutoCloseable, IdentityAssertionPlugin

public class ScriptableIdentityAssertionPlugin
extends AbstractScriptableHeapObject<IdentityAssertionClaims>
implements IdentityAssertionPlugin

A scriptable IdentityAssertionPlugin. If there is an issue during script processing then it will be wrapped in an IdentityAssertionPluginException.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptableIdentityAssertionPlugin.Heaplet	Creates and initializes a ScriptableIdentityAssertionPlugin in a heap environment.

Nested classes/interfaces inherited from class org.forgerock.openig.script.AbstractScriptableHeapObject

AbstractScriptableHeapObject.AbstractScriptableHeaplet<V>

Method Summary

Modifier and Type	Method	Description
Filter	preProcessingFilter()	Return a Filter to deal with any pre-processing requirements such as challenging the user for credentials by returning a WWW-Authenticate header.
Promise<IdentityAssertionClaims,IdentityAssertionPluginException>	process(Context context, Request request)	Preform some processing and return a set of claims to be returned in the Identity Assertion JWT.

Methods inherited from class org.forgerock.openig.script.AbstractScriptableHeapObject

close, runScript, runScriptAsync, setArgs, setClientHandler

Methods inherited from class java.lang.Object

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

Method Details

preProcessingFilter

public Filter preProcessingFilter()

Description copied from interface: IdentityAssertionPlugin

Return a Filter to deal with any pre-processing requirements such as challenging the user for credentials by returning a WWW-Authenticate header. The default implementation simply calls the next Handler without doing any processing. This filter is only triggered after the Identity Request JWT has been validated.

Specified by:

preProcessingFilter in interface IdentityAssertionPlugin

Returns:

a Filter to deal with any pre-processing requirements.

process

public Promise<IdentityAssertionClaims,IdentityAssertionPluginException> process(Context context,
 Request request)

Description copied from interface: IdentityAssertionPlugin

Preform some processing and return a set of claims to be returned in the Identity Assertion JWT. The processing may include some form of local authentication and/or authorization.

Specified by:

process in interface IdentityAssertionPlugin

Parameters:

context - The context.

request - The request.

Returns:

An IdentityAssertionClaims promise that represents claims to be returned in the Assertion JWT.