com.inductiveautomation.ignition.gateway.auth.web.session

Interface WebAuthSession

public interface WebAuthSession

A WebAuthSession manages a user's WebAuthSessionContext for a given IdP based on incoming WebAuthResponseContext updates, Security Zones, and any other contextual information available. The WebAuthSession notifies the listener passed during startup(Runnable) when the WebAuthSessionContext changes so that the listener may pull the new value by calling getContext().

See Also:

IdpAdapterManager.createSession(String, ImmutableCollection)

Method Summary

Modifier and Type	Method and Description
WebAuthSessionContext	getContext()
java.util.Optional<java.lang.String>	getIdpId()
void	logout() Clears the user from this WebAuthSession
void	onLoginResponse(WebAuthResponseContext webAuthResponseContext) Push a new WebAuthResponseContext when the user logs in from the IdP
void	onLogoutResponse(WebAuthResponseContext webAuthResponseContext) Push a new WebAuthResponseContext when the user logs out from the IdP
void	shutdown() Shut down the session.
void	startup(java.lang.Runnable listener) Start up the session.

Method Detail

startup

void startup(@Nonnull
             java.lang.Runnable listener)

Start up the session. May only be called once. The given listener is called for any changes to the WebAuthSessionContext

Parameters:

listener - the Runnable which will be called when the WebAuthSessionContext changes

Throws:

java.lang.IllegalStateException - if the session was already started or shut down

shutdown

void shutdown()

Shut down the session. May only be called once after startup. The listener passed into startup(Runnable) will no longer be called when the WebAuthSessionContext changes and the listener's reference will be released.

Throws:

java.lang.IllegalStateException - if the session was already shut down or if it was never started

getIdpId

@Nonnull
java.util.Optional<java.lang.String> getIdpId()

Returns:

an Optional containing the IdP Adapter ID associated with this session or an empty Optional if the IdP Adapter ID is null

getContext

@Nonnull
WebAuthSessionContext getContext()

Returns:

the latest WebAuthSessionContext

onLoginResponse

void onLoginResponse(@Nonnull
                     WebAuthResponseContext webAuthResponseContext)

Push a new WebAuthResponseContext when the user logs in from the IdP

Parameters:

webAuthResponseContext - the WebAuthResponseContext

Throws:

java.lang.IllegalStateException - if the session is not running

onLogoutResponse

void onLogoutResponse(@Nonnull
                      WebAuthResponseContext webAuthResponseContext)

Push a new WebAuthResponseContext when the user logs out from the IdP

Parameters:

webAuthResponseContext - the WebAuthResponseContext

Throws:

java.lang.IllegalStateException - if the session is not running

logout

void logout()

Clears the user from this WebAuthSession