Class DeprecatedUserProfileFilter

  • All Implemented Interfaces:
    Filter

    @Deprecated
    public class DeprecatedUserProfileFilter
    extends Object
    implements Filter
    Deprecated.
    Since 6.5. Prefer to use the UserProfileFilter that does not require a SSO Token.
    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]
              "ssoToken"              : expression            [OPTIONAL - user token - defaults to
                                                                      iPlanetDirectoryPro cookie ]
              "profileAttributes"     : string list           [OPTIONAL - the list of user's profile attributes to
                                                                      request from Access Management. Default retrieves
                                                                      all attributes.
          }
     }
     
     
    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",
              "ssoToken": "${contexts.ssoTokenExpression.value}",
              "profileAttributes": [
                  "username", "dn", "universalid"
              ]
          }
      }
      
     
    • Constructor Detail

      • DeprecatedUserProfileFilter

        public DeprecatedUserProfileFilter​(org.forgerock.openig.tools.am.AmService amService,
                                           Expression<String> ssoTokenExpression,
                                           Set<String> profileAttributes)
        Deprecated.
        Creates a new Access Management profile attributes filter.
        Parameters:
        amService - the Access Management server to query for profile attributes.
        ssoTokenExpression - the expression, that when evaluated, provides the user's sso token value.
        profileAttributes - the profile attributes to request.
    • Method Detail

      • filter

        public Promise<Response,​NeverThrowsException> filter​(Context context,
                                                                   Request request,
                                                                   Handler next)
        Deprecated.
        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.