Package org.forgerock.openig.filter.oauth2.client

Class ClientRegistrationFilter

java.lang.Object

org.forgerock.openig.filter.oauth2.client.ClientRegistrationFilter

All Implemented Interfaces:

org.forgerock.http.Filter

public class ClientRegistrationFilter
extends Object
implements org.forgerock.http.Filter

The client registration filter is the way to dynamically register an OpenID Connect Relying Party with the End-User's OpenID Provider.

All OpenID metadata must be included in the OAuth2ClientFilter configuration, in the "metadata" attribute. Note that for dynamic client registration, only the "redirect_uris" attribute is mandatory.

Note: When using OpenAM, the "scopes" may be specified to this configuration but it must be defined as: "scopes"(array of string), which differs from the OAuth2 metadata "scope" (a string containing a space separated list of scope values).

See Also:

OpenID Connect Dynamic Client Registration 1.0, OpenID Connect Dynamic Client Registration 1.0 , OAuth 2.0 Dynamic Client Registration Protocol

Constructor Summary

Constructors

Constructor	Description
ClientRegistrationFilter(org.forgerock.openig.filter.oauth2.client.ClientRegistrationRepository repository, org.forgerock.http.Handler registrationHandler, org.forgerock.json.JsonValue config)	Creates a new dynamic registration filter.

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

ClientRegistrationFilter

public ClientRegistrationFilter(org.forgerock.openig.filter.oauth2.client.ClientRegistrationRepository repository,
                                org.forgerock.http.Handler registrationHandler,
                                org.forgerock.json.JsonValue config)

Creates a new dynamic registration filter.

Parameters:

repository - The ClientRegistrationRepository holding the registrations values.

registrationHandler - The handler to perform the dynamic registration to the Authorization Server(AS).

config - Can contain any client metadata attributes that the client chooses to specify for itself during the registration. Must contains the 'redirect_uris' attributes.

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