Package org.forgerock.openig.uma

Class UmaResourceServerFilter

java.lang.Object

org.forgerock.openig.uma.UmaResourceServerFilter

All Implemented Interfaces:

org.forgerock.http.Filter

public class UmaResourceServerFilter
extends Object
implements org.forgerock.http.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"
         }
       }
     
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UmaResourceServerFilter.Heaplet	Creates and initializes an UMA resource server filter in a heap environment.

Constructor Summary

Constructors

Constructor	Description
UmaResourceServerFilter(UmaSharingService umaService, org.forgerock.http.Handler protectionApiHandler, String realm)	Constructs a new UmaResourceServerFilter.

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

Constructor Detail

UmaResourceServerFilter

public UmaResourceServerFilter(UmaSharingService umaService,
                               org.forgerock.http.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 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