Class UmaResourceServerFilter

java.lang.Object
org.forgerock.openig.uma.UmaResourceServerFilter
All Implemented Interfaces:
Filter

public class UmaResourceServerFilter extends Object implements Filter
An UmaResourceServerFilter implements a PEP (Policy Enforcement Point) and is responsible to ensure the incoming requests (from requesting parties) all have a valid RPT (Request Party Token) with the required set of scopes.
     {
         "type": "UmaFilter",
         "config": {
           "protectionApiHandler": "HttpsClient",
           "umaService": "UmaService"
         }
       }
     
 
  • Constructor Details

    • UmaResourceServerFilter

      public UmaResourceServerFilter(UmaSharingService umaService, Handler protectionApiHandler, String realm)
      Constructs a new UmaResourceServerFilter.
      Parameters:
      umaService - core service to use
      protectionApiHandler - protectionApiHandler to use when interacting with introspection and permission request endpoints
      realm - UMA realm name (can be null)
  • Method Details

    • 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.