Interface QAuthenticationModuleInterface

All Known Implementing Classes:

Auth0AuthenticationModule, FullyAnonymousAuthenticationModule, MockAuthenticationModule, OAuth2AuthenticationModule, TableBasedAuthenticationModule

public interface QAuthenticationModuleInterface

Interface that a QAuthenticationModule must implement.

Method Summary

Modifier and Type	Method	Description
default QSession	createAutomatedSessionForUser(QInstance qInstance, Serializable userId)
default QSession	createSession(QInstance qInstance, QAuthenticationMetaData authenticationMetaData, Map<String,String> context)	Create a session for the given (possibly scoped) authentication provider.
QSession	createSession(QInstance qInstance, Map<String,String> context)
default String	getLoginRedirectUrl(String originalUrl)
boolean	isSessionValid(QInstance instance, QSession session)
default void	logout(QInstance qInstance, String sessionUUID)	Logout a session, invalidating it server-side.
default boolean	usesSessionIdCookie()

Method Details

createSession

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

Throws:

QAuthenticationException

createSession

default QSession createSession(QInstance qInstance,
 QAuthenticationMetaData authenticationMetaData,
 Map<String,String> context)
                        throws QAuthenticationException

Create a session for the given (possibly scoped) authentication provider. Callers that resolved a provider (e.g., per API) use this, so a module can read its own provider's settings rather than the instance default. The default ignores the metadata, for modules that only know the instance one.

Throws:

QAuthenticationException

isSessionValid

boolean isSessionValid(QInstance instance,
 QSession session)

createAutomatedSessionForUser

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

Throws:

QAuthenticationException

usesSessionIdCookie

default boolean usesSessionIdCookie()

getLoginRedirectUrl

default String getLoginRedirectUrl(String originalUrl)
                            throws QAuthenticationException

Throws:

QAuthenticationException

logout

default void logout(QInstance qInstance,
 String sessionUUID)

Logout a session, invalidating it server-side.

Parameters:

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

sessionUUID - the session UUID to invalidate