Class OAuth2AuthenticationModule

java.lang.Object

com.kingsrook.qqq.backend.core.modules.authentication.implementations.OAuth2AuthenticationModule

All Implemented Interfaces:

QAuthenticationModuleInterface

public class OAuth2AuthenticationModule
extends Object
implements QAuthenticationModuleInterface

Implementation of OAuth2 authentication.

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthenticationModule()

Method Summary

Modifier and Type	Method	Description
static void	clearOIDCProviderMetadataCache()	Clear cached OIDC provider metadata.
QSession	createAutomatedSessionForUser(QInstance qInstance, Serializable userId)
QSession	createSession(QInstance qInstance, Map<String,String> context)
String	getLoginRedirectUrl(String originalUrl)
boolean	isSessionValid(QInstance instance, QSession session)
void	logout(QInstance qInstance, String sessionUUID)	Logout a session by deleting it from the database and clearing the memoization cache.
boolean	usesSessionIdCookie()

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2AuthenticationModule

public OAuth2AuthenticationModule()

Method Details

createSession

public QSession createSession(QInstance qInstance,
 Map<String,String> context)
                       throws QAuthenticationException

Specified by:

createSession in interface QAuthenticationModuleInterface

Throws:

QAuthenticationException

isSessionValid

public boolean isSessionValid(QInstance instance,
 QSession session)

Specified by:

isSessionValid in interface QAuthenticationModuleInterface

getLoginRedirectUrl

public String getLoginRedirectUrl(String originalUrl)
                           throws QAuthenticationException

Specified by:

getLoginRedirectUrl in interface QAuthenticationModuleInterface

Throws:

QAuthenticationException

createAutomatedSessionForUser

public QSession createAutomatedSessionForUser(QInstance qInstance,
 Serializable userId)
                                       throws QAuthenticationException

Specified by:

createAutomatedSessionForUser in interface QAuthenticationModuleInterface

Throws:

QAuthenticationException

usesSessionIdCookie

public boolean usesSessionIdCookie()

Specified by:

usesSessionIdCookie in interface QAuthenticationModuleInterface

logout

public void logout(QInstance qInstance,
 String sessionUUID)

Logout a session by deleting it from the database and clearing the memoization cache.

Specified by:

logout in interface QAuthenticationModuleInterface

Parameters:

qInstance - the QInstance (provided for implementations that need it)

sessionUUID - the session UUID to invalidate

clearOIDCProviderMetadataCache

public static void clearOIDCProviderMetadataCache()

Clear cached OIDC provider metadata. Primarily for testing purposes when WireMock servers restart on different ports between tests.