public class SessionInfoFilter extends Object implements Filter
{
"config": {
"amService" : AmService [REQUIRED]
"ssoToken" : expression [OPTIONAL - user token - defaults to iPlanetDirectoryPro cookie ]
}
}
This heaplet adds an InsertSsoTokenHeaderFilter to set the SSO token header
of this given user (REST API calls must present the session token, aka SSO
Token, in an HTTP header as proof of authentication).
The "session info" is saved in a SessionInfoContext
.
Example of use:
{
"name": "SessionInfo",
"type": "SessionInfoFilter",
"config": {
"amService": "amService",
"ssoToken": "${request.cookies['iPlanetDirectoryPro'][0].value}",
}
}
Modifier and Type | Class and Description |
---|---|
static class |
SessionInfoFilter.Heaplet
Creates and initialises a session info filter in a heap environment.
|
Constructor and Description |
---|
SessionInfoFilter(SessionService sessionService,
Expression<String> ssoToken)
Creates a new OpenAM session info filter.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
filter(Context context,
Request request,
Handler next)
Filters the request and/or response of an exchange.
|
public SessionInfoFilter(SessionService sessionService, Expression<String> ssoToken)
sessionService
- The sessionService
to use to retrieve session info.ssoToken
- The SSO Token for the subject making the request.public Promise<Response,NeverThrowsException> filter(Context context, Request request, Handler next)
Filter
next.handle(context, request)
.
This method may elect not to pass the request to the next filter or
handler, and instead handle the request itself. It can achieve this by
merely avoiding a call to next.handle(context, request)
and creating its own response object. The filter is also at liberty to
replace a response with another of its own by intercepting the response
returned by the next handler.
Copyright 2011-2017 ForgeRock AS.