Package 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 posts a WebAuthSessionChangeEvent to its EventBus when the WebAuthSessionContext changes so that any listener may pull the new value by calling getContext().

See Also:

• IdpAdapterManager.createSession(String, ImmutableCollection)

Method Summary

Modifier and Type	Method	Description
WebAuthSessionContext	getContext()
com.google.common.eventbus.EventBus	getEventBus()	WebAuthSessionChangeEvents will be posted to the EventBus when the WebAuthSession has changed.
Optional<String>	getName()
default Optional<String>	logout()	Clears the user from this WebAuthSession
Optional<String>	logout(String message)	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()	Start up the session.

Method Details

startup

void startup()

Start up the session. May only be called once.

Throws:

IllegalStateException - if the session was already started or shut down

shutdown

void shutdown()

Shut down the session. May only be called once after startup.

Throws:

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

getName

@Nonnull
Optional<String> getName()

Returns:

an Optional containing the IdP Adapter name associated with this session or an empty Optional if the IdP Adapter name 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:

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:

IllegalStateException - if the session is not running

logout

default Optional<String> logout()

Clears the user from this WebAuthSession

Returns:

an optional signed attributes document used as a hint to the IdP during logout

logout

Optional<String> logout(@Nullable
 String message)

Clears the user from this WebAuthSession

Parameters:

message - an optional message to include with the logout event

Returns:

an optional signed attributes document used as a hint to the IdP during logout

getEventBus

@Nonnull
com.google.common.eventbus.EventBus getEventBus()

WebAuthSessionChangeEvents will be posted to the EventBus when the WebAuthSession has changed. Interested parties may call EventBus.register(Object) to listen for changes.

Returns:

the EventBus for this WebAuthSession