Package org.forgerock.openig.openam

Class SingleSignOnFilter

java.lang.Object

org.forgerock.openig.openam.SingleSignOnFilter

All Implemented Interfaces:

org.forgerock.http.Filter

public class SingleSignOnFilter
extends Object
implements org.forgerock.http.Filter

This filter verifies the presence of a SSOToken in the given cookie name. If the request cookie header contains a SSOToken, its validity is verified before the request is forwarded to the next handler.

If the SSOToken is not valid or if cookie header is not present or empty, then the user-agent is redirected to OpenAM login page. Once log in has been successful, the request is forwarded.

 {
    "type": "SingleSignOnFilter",
    "config": {
        "openamUrl"              :    uriExpression      [REQUIRED]
        "cookieName"             :    String             [OPTIONAL - by default is 'iPlanetDirectoryPro']
        "realm"                  :    String             [OPTIONAL - default is '/']
        "amHandler"              :    handler            [OPTIONAL - by default it uses the
                                                                     'ForgeRockClientHandler' provided in heap.]
    }
  }
  
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleSignOnFilter.Heaplet	Creates and initialises an authentication filter in a heap environment.

Method Summary

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<org.forgerock.http.protocol.Response,org.forgerock.util.promise.NeverThrowsException>	filter(org.forgerock.services.context.Context context, org.forgerock.http.protocol.Request request, org.forgerock.http.Handler next)

Methods inherited from class java.lang.Object

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

Method Detail

filter

public org.forgerock.util.promise.Promise<org.forgerock.http.protocol.Response,org.forgerock.util.promise.NeverThrowsException> filter(org.forgerock.services.context.Context context,
                                                                                                                                             org.forgerock.http.protocol.Request request,
                                                                                                                                             org.forgerock.http.Handler next)

Specified by:

filter in interface org.forgerock.http.Filter