Index

A B C E F G H I N O R T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AccessTokenException - Exception in org.forgerock.http.oauth2

Represents an exception whilst retrieving an OAuth2 access token.

AccessTokenException(String) - Constructor for exception org.forgerock.http.oauth2.AccessTokenException

Builds an AccessTokenException with a given message.

AccessTokenException(String, Exception) - Constructor for exception org.forgerock.http.oauth2.AccessTokenException

Builds an AccessTokenException with a given message and cause.

AccessTokenInfo - Class in org.forgerock.http.oauth2

Represents an OAuth2 Access Token.

AccessTokenInfo(JsonValue, String, Set<String>, long) - Constructor for class org.forgerock.http.oauth2.AccessTokenInfo

Build an AccessTokenInfo with the provided information.

AccessTokenResolver - Interface in org.forgerock.http.oauth2

Resolves a given token against a dedicated OAuth2 Identity Provider (OpenAM, Google, Facebook, ...).

asJsonValue() - Method in class org.forgerock.http.oauth2.AccessTokenInfo

Returns the raw JSON as a JsonValue.

B

bestEffortResourceServerError(Status, OAuth2Error) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Returns an OAuth 2.0 resource server error whose values are determined on a best-effort basis from the provided incomplete error and HTTP status code.

C

CachingAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver

A CachingAccessTokenResolver is a delegating AccessTokenResolver that uses a write-through cache to enable fast AccessTokenInfo resolution.

CachingAccessTokenResolver(TimeService, AccessTokenResolver, PerItemEvictionStrategyCache<String, Promise<AccessTokenInfo, AccessTokenException>>) - Constructor for class org.forgerock.http.oauth2.resolver.CachingAccessTokenResolver

Builds a CachingAccessTokenResolver delegating to the given AccessTokenResolver using the given (pre-configured) cache.

E

E_ACCESS_DENIED - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The resource owner or authorization server denied the request.

E_INSUFFICIENT_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The request requires higher privileges than provided by the access token.

E_INVALID_CLIENT - Static variable in class org.forgerock.http.oauth2.OAuth2Error

Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).

E_INVALID_GRANT - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.

E_INVALID_REQUEST - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed.

E_INVALID_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.

E_INVALID_TOKEN - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The access token provided is expired, revoked, malformed, or invalid for other reasons.

E_SERVER_ERROR - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The authorization server encountered an unexpected condition that prevented it from fulfilling the request.

E_TEMPORARILY_UNAVAILABLE - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

E_UNAUTHORIZED_CLIENT - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The authenticated client is not authorized to use this authorization grant type.

E_UNSUPPORTED_GRANT_TYPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The authorization grant type is not supported by the authorization server.

E_UNSUPPORTED_RESPONSE_TYPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The authorization server does not support obtaining an authorization code using this method.

equals(Object) - Method in class org.forgerock.http.oauth2.OAuth2Error

F

F_ERROR - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The name of the field which communicates the error code.

F_ERROR_DESCRIPTION - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The name of the field which communicates the error description.

F_ERROR_URI - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The name of the field which communicates the error uri.

F_REALM - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The name of the field which communicates the realm.

F_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The name of the field which communicates the scope.

filter(Context, Request, Handler) - Method in class org.forgerock.http.oauth2.ResourceServerFilter

G

getAccessToken() - Method in class org.forgerock.http.oauth2.OAuth2Context

Returns the access token associated with this OAuth2 context.

getBearerAccessToken(String) - Static method in class org.forgerock.http.oauth2.OAuth2

Extracts the bearer token from the request's authorization header.

getError() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the error code specifying the cause of the failure.

getErrorDescription() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.

getErrorUri() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

getExpiresAt() - Method in class org.forgerock.http.oauth2.AccessTokenInfo

Returns the time (expressed as a timestamp in milliseconds since epoch) when this token will be expired.

getInfo() - Method in class org.forgerock.http.oauth2.AccessTokenInfo

Returns the raw JSON as a map.

getRealm() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the scope of protection required to access the protected resource.

getRequiredScopes(Context, Request) - Method in interface org.forgerock.http.oauth2.ResourceAccess

Returns the scopes required to access the resource.

getScope() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the required scope of the access token for accessing the requested resource.

getScopes() - Method in class org.forgerock.http.oauth2.AccessTokenInfo

Returns the scopes associated to this token.

getToken() - Method in class org.forgerock.http.oauth2.AccessTokenInfo

Returns the access token identifier issued from the authorization server.

H

H_BEARER - Static variable in class org.forgerock.http.oauth2.OAuth2Error

The WWW-Authenticate header prefix, 'Bearer'.

hashCode() - Method in class org.forgerock.http.oauth2.OAuth2Error

I

is(String) - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns true if this error includes an error code and it matches the provided error code.

N

NEVER_EXPIRES - Static variable in class org.forgerock.http.oauth2.AccessTokenInfo

Marker for never ending tokens.

newAuthorizationServerError(String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.

newAuthorizationServerError(String, String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.

newResourceServerError(String, List<String>, String, String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Returns an OAuth 2.0 error suitable for inclusion in resource server WWW-Authenticate response headers.

O

OAuth2 - Class in org.forgerock.http.oauth2

OAuth2 utility class.

OAuth2Context - Class in org.forgerock.http.oauth2

An OAuth2Context could be used to store and retrieve an AccessTokenInfo.

OAuth2Context(Context, AccessTokenInfo) - Constructor for class org.forgerock.http.oauth2.OAuth2Context

Creates a new OAuth2 context with the provided AccessTokenInfo.

OAuth2Error - Class in org.forgerock.http.oauth2

Describes an error which occurred during an OAuth 2.0 authorization request or when performing an authorized request.

OpenAmAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver

An OpenAmAccessTokenResolver knows how to resolve a given token identifier against an OpenAm instance.

OpenAmAccessTokenResolver(Handler, TimeService, String) - Constructor for class org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver

Creates a new OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo OpenAm endpoint.

org.forgerock.http.oauth2 - package org.forgerock.http.oauth2

This package provides APIs for OAuth 2.0 services implementations.

org.forgerock.http.oauth2.resolver - package org.forgerock.http.oauth2.resolver

This package defines OpenAM specific logic needed to retrieve an AccessTokenInfo.

R

resolve(Context, String) - Method in interface org.forgerock.http.oauth2.AccessTokenResolver

Resolves a given access token against an authorization server.

resolve(Context, String) - Method in class org.forgerock.http.oauth2.resolver.CachingAccessTokenResolver

resolve(Context, String) - Method in class org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver

ResourceAccess - Interface in org.forgerock.http.oauth2

A ResourceAccess encapsulates the logic of required scope selection.

ResourceServerFilter - Class in org.forgerock.http.oauth2

Validates a Request that contains an OAuth 2.0 access token.

ResourceServerFilter(AccessTokenResolver, TimeService, ResourceAccess, String) - Constructor for class org.forgerock.http.oauth2.ResourceServerFilter

Creates a new OAuth2Filter.

T

toForm() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the form representation of this error suitable for inclusion in an authorization call-back query.

toJsonContent() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the JSON representation of this error formatted as an access token error response.

toString() - Method in class org.forgerock.http.oauth2.OAuth2Error

toWWWAuthenticateHeader() - Method in class org.forgerock.http.oauth2.OAuth2Error

Returns the string representation of this error formatted as a WWW-Authenticate header.

V

valueOf(String) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Parses the provided OAuth2Error.toString() representation as an OAuth 2.0 error.

valueOfForm(Form) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Parses the Form representation of an authorization call-back error as an OAuth 2.0 error.

valueOfJsonContent(Map<String, Object>) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Parses the JSON representation of an access token error response as an OAuth 2.0 error.

valueOfWWWAuthenticateHeader(String) - Static method in class org.forgerock.http.oauth2.OAuth2Error

Parses the provided WWW-Authenticate header content as an OAuth 2.0 error.

A B C E F G H I N O R T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form