Revoke Class Reference

OAuth2.Server.Revoke is the default RevokeTokenClass which is included with the server. More...

Inheritance diagram for Revoke:

Collaboration diagram for Revoke:

Static Public Member Functions
_.Library.Boolean	OnLogoutAccessToken (_.Library.String authCode, _.OAuth2.Server.Properties properties, _.Library.String redirectURI, _.Library.Status sc)
	The OnLogoutAccessToken method is called during the RP-Initiated Front-Channel Logout flow. More...
_.Library.Boolean	OnRevokeAccessToken (_.Library.String authCode, _.Library.Status sc)
	The OnRevokeAccessToken method must return a boolean value or throw an error. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

OAuth2.Server.Revoke is the default RevokeTokenClass which is included with the server.

The default class will pass through, with no side effects upon token revocation.
The RevokeTokenClass is specified in the Authorization Server Configuration. The OnRevokeAccessToken can perform user-specific operations upon token revocation, optionally bypassing the regular revocation flow.
The OnLogoutAccessToken method can perform user-specific operations during RP-Initiated Front-Channel Logout.

Member Function Documentation

OnLogoutAccessToken()

_.Library.Boolean OnLogoutAccessToken ( _.Library.String  authCode, _.OAuth2.Server.Properties  properties, _.Library.String  redirectURI, _.Library.Status  sc  )

static

The OnLogoutAccessToken method is called during the RP-Initiated Front-Channel Logout flow.

If this returns

an error status (or throws an exception), then the normal flow will be bypassed. If it returns 1 the server will skip deleting the token and ending the session (if one exists,) but the normal redirect flow will still take place. The client's redirect URI is passed in the redirectURI parameter. This can be modified by the callback to redirect to another URI; this can be useful if authorization has been delegated to a third-party authorization server. If this callback modifies redirectURI, the new target should redirect to the original URI upon successful completion of the request.

OnRevokeAccessToken()

_.Library.Boolean OnRevokeAccessToken ( _.Library.String  authCode, _.Library.Status  sc  )

static

The OnRevokeAccessToken method must return a boolean value or throw an error.

If the method returns 1 or throws an error, the regular revocation flow is bypassed.
If the method returns 0, the regular revocation flow continues.
Default behavior is to permit regular revocation flow.
Receives the AuthorizationCode property value of the token to be deleted.