Package org.forgerock.openam.rest.authz

Class SSOTokenAuthzModule

java.lang.Object

org.forgerock.openam.rest.authz.SSOTokenAuthzModule

All Implemented Interfaces:

org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

Direct Known Subclasses:

AdminOnlyAuthzModule, AgentOnlyAuthzModule

public abstract class SSOTokenAuthzModule
extends Object
implements org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

Field Summary

Fields

Modifier and Type	Field	Description
protected Debug	debug
protected String	moduleName

Constructor Summary

Constructors

Constructor	Description
SSOTokenAuthzModule(Debug debug)

Method Summary

Modifier and Type	Method	Description
protected org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorize(org.forgerock.services.context.Context context)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizeAction(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizeCreate(org.forgerock.services.context.Context context, org.forgerock.json.resource.CreateRequest request)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizeDelete(org.forgerock.services.context.Context context, org.forgerock.json.resource.DeleteRequest request)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizePatch(org.forgerock.services.context.Context context, org.forgerock.json.resource.PatchRequest request)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizeQuery(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizeRead(org.forgerock.services.context.Context context, org.forgerock.json.resource.ReadRequest request)
org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	authorizeUpdate(org.forgerock.services.context.Context context, org.forgerock.json.resource.UpdateRequest request)
protected abstract org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException>	validateToken(org.forgerock.services.context.Context context, SSOToken token)	Validate the caller's SSO Token.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

getName

Field Detail

debug

protected final Debug debug

moduleName

protected final String moduleName

Constructor Detail

SSOTokenAuthzModule

public SSOTokenAuthzModule(@Named("frRest")
                           Debug debug)

Method Detail

authorizeCreate

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizeCreate(org.forgerock.services.context.Context context,
                                                                                                                                                                  org.forgerock.json.resource.CreateRequest request)

Specified by:

authorizeCreate in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorizeRead

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizeRead(org.forgerock.services.context.Context context,
                                                                                                                                                                org.forgerock.json.resource.ReadRequest request)

Specified by:

authorizeRead in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorizeUpdate

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizeUpdate(org.forgerock.services.context.Context context,
                                                                                                                                                                  org.forgerock.json.resource.UpdateRequest request)

Specified by:

authorizeUpdate in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorizeDelete

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizeDelete(org.forgerock.services.context.Context context,
                                                                                                                                                                  org.forgerock.json.resource.DeleteRequest request)

Specified by:

authorizeDelete in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorizePatch

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizePatch(org.forgerock.services.context.Context context,
                                                                                                                                                                 org.forgerock.json.resource.PatchRequest request)

Specified by:

authorizePatch in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorizeAction

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizeAction(org.forgerock.services.context.Context context,
                                                                                                                                                                  org.forgerock.json.resource.ActionRequest request)

Specified by:

authorizeAction in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorizeQuery

public org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorizeQuery(org.forgerock.services.context.Context context,
                                                                                                                                                                 org.forgerock.json.resource.QueryRequest request)

Specified by:

authorizeQuery in interface org.forgerock.authz.filter.crest.api.CrestAuthorizationModule

authorize

protected org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> authorize(org.forgerock.services.context.Context context)

validateToken

protected abstract org.forgerock.util.promise.Promise<org.forgerock.authz.filter.api.AuthorizationResult,org.forgerock.json.resource.ResourceException> validateToken(org.forgerock.services.context.Context context,
                                                                                                                                                                            SSOToken token)
                                                                                                                                                                     throws SSOException,
                                                                                                                                                                            org.forgerock.json.resource.ResourceException

Validate the caller's SSO Token.

Parameters:

context - The request context.

token - The caller's SSOToken.

Returns:

The result promise.

Throws:

SSOException - In the case of failed operations on the token. Will be converted to a forbidden result.

org.forgerock.json.resource.ResourceException - Other resource exceptions can be thrown and will be returned as the result.