Package org.forgerock.openig.openam

Class UserProfileFilter

java.lang.Object

org.forgerock.openig.openam.UserProfileFilter

All Implemented Interfaces:

Filter

public class UserProfileFilter
extends Object
implements Filter

This filter requests user profile attributes from Access Management and stores them in the context for later use. Note that only user profile properties that are enabled in Access Management will be available.

 {
      "config": {
          "amService"             : AmService             [REQUIRED]
          "username"              : expression            [REQUIRED]
      }
 }
 
 

The profile attribute values collected will be placed into a UserProfileContext. The full set of available profile attributes are as documented in the UserProfile class.

Example of use:

 {
      "name": "profileFilter",
      "type": "UserProfileFilter",
      "config": {
          "amService": "amService",
          "username": "${contexts.oauth2.accessToken.info.sub}"
      }
  }
  
 

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.

Methods inherited from class java.lang.Object

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

Method Detail

filter

public Promise<Response,NeverThrowsException> filter(Context context,
                                                           Request request,
                                                           Handler next)

Description copied from interface: Filter

Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls 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.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.