org.forgerock.authz.modules.oauth2

Class OAuth2CrestAuthorizationModule

java.lang.Object

org.forgerock.authz.modules.oauth2.OAuth2CrestAuthorizationModule

All Implemented Interfaces:

CrestAuthorizationModule

public class OAuth2CrestAuthorizationModule
extends Object
implements CrestAuthorizationModule

An implementation of a CrestAuthorizationModule which uses a OAuth2 Access Token from the Authorization header from the request.

Since:

1.5.0

Method Summary

Modifier and Type	Method and Description
Promise<AuthorizationResult,ResourceException>	authorizeAction(Context context, ActionRequest request) Authorizes a received REST action request using the OAuth2 Access Token present in the request header.
Promise<AuthorizationResult,ResourceException>	authorizeCreate(Context context, CreateRequest request) Authorizes a received REST create request using the OAuth2 Access Token present in the request header.
Promise<AuthorizationResult,ResourceException>	authorizeDelete(Context context, DeleteRequest request) Authorizes a received REST delete request using the OAuth2 Access Token present in the request header.
Promise<AuthorizationResult,ResourceException>	authorizePatch(Context context, PatchRequest request) Authorizes a received REST patch request using the OAuth2 Access Token present in the request header.
Promise<AuthorizationResult,ResourceException>	authorizeQuery(Context context, QueryRequest request) Authorizes a received REST query request using the OAuth2 Access Token present in the request header.
Promise<AuthorizationResult,ResourceException>	authorizeRead(Context context, ReadRequest request) Authorizes a received REST read request using the OAuth2 Access Token present in the request header.
Promise<AuthorizationResult,ResourceException>	authorizeUpdate(Context context, UpdateRequest request) Authorizes a received REST update request using the OAuth2 Access Token present in the request header.
String	getName() Returns the name of the authorization module.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Description copied from interface: CrestAuthorizationModule

Returns the name of the authorization module.

Specified by:

getName in interface CrestAuthorizationModule

Returns:

The module name.

authorizeCreate

public Promise<AuthorizationResult,ResourceException> authorizeCreate(Context context,
                                                                      CreateRequest request)

Authorizes a received REST create request using the OAuth2 Access Token present in the request header.

Specified by:

authorizeCreate in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The CreateRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.

authorizeRead

public Promise<AuthorizationResult,ResourceException> authorizeRead(Context context,
                                                                    ReadRequest request)

Authorizes a received REST read request using the OAuth2 Access Token present in the request header.

Specified by:

authorizeRead in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The ReadRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.

authorizeUpdate

public Promise<AuthorizationResult,ResourceException> authorizeUpdate(Context context,
                                                                      UpdateRequest request)

Authorizes a received REST update request using the OAuth2 Access Token present in the request header.

Specified by:

authorizeUpdate in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The UpdateRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.

authorizeDelete

public Promise<AuthorizationResult,ResourceException> authorizeDelete(Context context,
                                                                      DeleteRequest request)

Authorizes a received REST delete request using the OAuth2 Access Token present in the request header.

Specified by:

authorizeDelete in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The DeleteRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.

authorizePatch

public Promise<AuthorizationResult,ResourceException> authorizePatch(Context context,
                                                                     PatchRequest request)

Authorizes a received REST patch request using the OAuth2 Access Token present in the request header.

Specified by:

authorizePatch in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The PatchRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.

authorizeAction

public Promise<AuthorizationResult,ResourceException> authorizeAction(Context context,
                                                                      ActionRequest request)

Authorizes a received REST action request using the OAuth2 Access Token present in the request header.

Specified by:

authorizeAction in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The ActionRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.

authorizeQuery

public Promise<AuthorizationResult,ResourceException> authorizeQuery(Context context,
                                                                     QueryRequest request)

Authorizes a received REST query request using the OAuth2 Access Token present in the request header.

Specified by:

authorizeQuery in interface CrestAuthorizationModule

Parameters:

context - The Context representing the context of the request.

request - The QueryRequest to authorize.

Returns:

A Promise representing the result of the method call. The result of the Promise, when the method completes successfully, will be an AuthorizationResult containing the result of the authorization, or will be an ResourceException detailing the cause of the failure.