Package net.ltgt.oidc.servlet

Class RevokingOAuthTokensHandler

java.lang.Object

net.ltgt.oidc.servlet.RevokingOAuthTokensHandler

All Implemented Interfaces:

OAuthTokensHandler

public class RevokingOAuthTokensHandler
extends Object
implements OAuthTokensHandler

An OAuthTokensHandler that immediately (though asynchronously) revokes the access token.

This is the default handler used by the CallbackServlet when no specific handler has been configured, using the globally configured HTTP request sender.

See Also:

• OAuth 2.0 Token Revocation

Field Summary

Fields inherited from interface net.ltgt.oidc.servlet.OAuthTokensHandler

CONTEXT_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor	Description
RevokingOAuthTokensHandler(Configuration configuration)	Constructs a revoking token handler with the given configuration.
RevokingOAuthTokensHandler(Configuration configuration, @Nullable HTTPRequestSender httpRequestSender)	Constructs a revoking token handler with the given configuration and HTTP request sender.
RevokingOAuthTokensHandler(Configuration configuration, @Nullable HTTPRequestSender httpRequestSender, Executor executor)	Constructs a revoking token handler with the given configuration, HTTP executor sender, and executor.
RevokingOAuthTokensHandler(Configuration configuration, Executor executor)	Constructs a revoking token handler with the given configuration and executor, and no HTTP executor sender.

Method Summary

Modifier and Type	Method	Description
protected void	handleError(HTTPResponse response)	Handles an unsuccessful response to the token revocation request.
protected void	handleError(Exception e)	Handles an exception happening in the asynchronous revocation task.
void	tokensAcquired(AccessTokenResponse tokenResponse, HttpSession session)	Called by the CallbackServlet before it forgets about the tokens.

Methods inherited from class java.lang.Object

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

Constructor Details

RevokingOAuthTokensHandler

public RevokingOAuthTokensHandler(Configuration configuration)

Constructs a revoking token handler with the given configuration.

The asynchronous task will be executed in the ForkJoinPool.commonPool().

RevokingOAuthTokensHandler

public RevokingOAuthTokensHandler(Configuration configuration,
 @Nullable HTTPRequestSender httpRequestSender)

Constructs a revoking token handler with the given configuration and HTTP request sender.

The asynchronous task will be executed in the ForkJoinPool.commonPool().

RevokingOAuthTokensHandler

public RevokingOAuthTokensHandler(Configuration configuration,
 Executor executor)

Constructs a revoking token handler with the given configuration and executor, and no HTTP executor sender.

RevokingOAuthTokensHandler

public RevokingOAuthTokensHandler(Configuration configuration,
 @Nullable HTTPRequestSender httpRequestSender,
 Executor executor)

Constructs a revoking token handler with the given configuration, HTTP executor sender, and executor.

Method Details

tokensAcquired

public void tokensAcquired(AccessTokenResponse tokenResponse,
 HttpSession session)

Description copied from interface: OAuthTokensHandler

Called by the CallbackServlet before it forgets about the tokens.

Specified by:

tokensAcquired in interface OAuthTokensHandler

Parameters:

tokenResponse - The token response, containing the OAuth tokens and possibly some custom parameters

handleError

@ForOverride
protected void handleError(Exception e)

Handles an exception happening in the asynchronous revocation task.

The default implementation re-throws the exception, possibly wrapped in an UncheckedIOException or a RuntimeException.

handleError

@ForOverride
protected void handleError(HTTPResponse response)

Handles an unsuccessful response to the token revocation request.

The default implementation does nothing.