org.forgerock.authz.modules.oauth2

Class OAuth2Authorization

java.lang.Object

org.forgerock.authz.modules.oauth2.OAuth2Authorization

public final class OAuth2Authorization
extends Object

Utility class providing convenience methods for creating OAuth2CrestAuthorizationModules.

Since:

1.5.0

Method Summary

Modifier and Type	Method and Description
static OAuth2CrestAuthorizationModule	forCrest(HttpClientHandler httpClientHandler, String tokenInfoEndpoint, String userInfoEndpoint, Set<String> requiredScopes) Creates a new OAuth2CrestAuthorizationModule with the provided configuration parameters.
static OAuth2CrestAuthorizationModule	forCrest(HttpClientHandler httpClientHandler, String tokenInfoEndpoint, String userInfoEndpoint, Set<String> requiredScopes, boolean cacheEnabled, int cacheSize) Creates a new OAuth2CrestAuthorizationModule with the provided configuration parameters.
static OAuth2CrestAuthorizationModule	forCrest(OAuth2AccessTokenValidator accessTokenValidator, Set<String> requiredScopes, boolean cacheEnabled, int cacheSize) Creates a new OAuth2CrestAuthorizationModule with the provided configuration parameters.

Methods inherited from class java.lang.Object

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

Method Detail

forCrest

public static OAuth2CrestAuthorizationModule forCrest(OAuth2AccessTokenValidator accessTokenValidator,
                                                      Set<String> requiredScopes,
                                                      boolean cacheEnabled,
                                                      int cacheSize)

Creates a new OAuth2CrestAuthorizationModule with the provided configuration parameters.

Parameters:

accessTokenValidator - A OAuth2AccessTokenValidator instance.

requiredScopes - The required OAuth2 scopes for the request to be authorized.

cacheEnabled - true if the cache should be used.

cacheSize - The size of the cache. Only used if cacheEnabled is set to true.

Returns:

A new OAuth2CrestAuthorizationModule instance.

forCrest

public static OAuth2CrestAuthorizationModule forCrest(HttpClientHandler httpClientHandler,
                                                      String tokenInfoEndpoint,
                                                      String userInfoEndpoint,
                                                      Set<String> requiredScopes,
                                                      boolean cacheEnabled,
                                                      int cacheSize)

Creates a new OAuth2CrestAuthorizationModule with the provided configuration parameters.

Parameters:

httpClientHandler - The Handler to use to make HTTP requests.

tokenInfoEndpoint - The URI for the OAuth2 token info endpoint.

userInfoEndpoint - The URI for the OAuth2 user info endpoint.

requiredScopes - The required OAuth2 scopes for the request to be authorized.

cacheEnabled - true if the cache should be used.

cacheSize - The size of the cache. Only used if cacheEnabled is set to true.

Returns:

A new OAuth2CrestAuthorizationModule instance.

forCrest

public static OAuth2CrestAuthorizationModule forCrest(HttpClientHandler httpClientHandler,
                                                      String tokenInfoEndpoint,
                                                      String userInfoEndpoint,
                                                      Set<String> requiredScopes)

Creates a new OAuth2CrestAuthorizationModule with the provided configuration parameters.

Disables the cache.

Parameters:

httpClientHandler - The Handler to use to make HTTP requests.

tokenInfoEndpoint - The URI for the OAuth2 token info endpoint.

userInfoEndpoint - The URI for the OAuth2 user info endpoint.

requiredScopes - The required OAuth2 scopes for the request to be authorized.

Returns:

A new OAuth2CrestAuthorizationModule instance.