Package com.inductiveautomation.ignition.gateway.auth.web

Class WebAuthRequestCollection

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.ignition.gateway.auth.web.WebAuthRequestCollection

All Implemented Interfaces:

java.util.EventListener, javax.servlet.http.HttpSessionBindingListener

public class WebAuthRequestCollection
extends AbstractLifecycle
implements javax.servlet.http.HttpSessionBindingListener

A collection of web auth requests represented as relay state -> WebAuthRequestCollection.WebAuthCallback pairs.

Each HttpSession may have at most one collection.

The internal collection supports high-concurrency and is thread-safe.

When a collection is bound to an HttpSession, it is started up, which schedules the first reaper.

A reaper is scheduled every 2 minutes to clear out any expired web auth requests.

When a collection is unbound from an HttpSession, it is shut down, which clears the internal collection .

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebAuthRequestCollection.BaseWebAuthResponseHandler	Base WebAuthRequestCollection.WebAuthResponseHandler interface which provides some default method implementations common to many types of handlers
class	WebAuthRequestCollection.LoginRequestBuilder	Provides a fluent-API (builder-style) pattern for creating new login requests encoded as a URI
static interface	WebAuthRequestCollection.LoginResponseHandler	WebAuthRequestCollection.BaseWebAuthResponseHandler which handles login responses
class	WebAuthRequestCollection.LogoutRequestBuilder	Provides a fluent-API (builder-style) pattern for creating new logout requests encoded as a URI
static interface	WebAuthRequestCollection.LogoutResponseHandler	WebAuthRequestCollection.BaseWebAuthResponseHandler which handles logout responses
static class	WebAuthRequestCollection.WebAuthCallback	Wraps a web auth request's creation timestamp, state to be carried from request to response, and a web auth response handler for handling the web auth response associated with the request.
class	WebAuthRequestCollection.WebAuthRequestBuilder<T extends WebAuthRequestCollection.WebAuthRequestBuilder<T>>	Provides a fluent-API (builder-style) pattern for creating new web auth requests encoded as a URI
static interface	WebAuthRequestCollection.WebAuthResponseHandler	Handler for web auth responses
static interface	WebAuthRequestCollection.WebAuthTimeoutContext	Provides context for WebAuthRequestCollection.WebAuthResponseHandlers to handle timeouts

Method Summary

Modifier and Type	Method	Description
WebAuthRequestCollection.LoginRequestBuilder	createLoginRequest()
WebAuthRequestCollection.LogoutRequestBuilder	createLogoutRequest()
java.util.Optional<WebAuthRequestCollection.WebAuthCallback>	get(java.lang.String state)	Fetch the WebAuthRequestCollection.WebAuthCallback associated with the given relay state value
static WebAuthRequestCollection	getOrCreate(RequestContext req)	Gets the WebAuthRequestCollection associated with the HttpSession on the given RequestContext.
static WebAuthRequestCollection	getOrCreate(GatewayContext gatewayContext, javax.servlet.http.HttpServletRequest httpServletRequest)	Gets the WebAuthRequestCollection associated with the HttpSession on the given HttpServletRequest.
static WebAuthRequestCollection	getOrCreate(GatewayContext gatewayContext, javax.servlet.http.HttpSession httpSession)	Gets the WebAuthRequestCollection associated with the given HttpSession.
protected void	onShutdown()
protected void	onStartup()
void	registerHandler(java.lang.String state, java.lang.String app, WebAuthRequestCollection.WebAuthResponseHandler handler)	Allows you to manually register a state key to a given handler.
java.util.Optional<WebAuthRequestCollection.WebAuthCallback>	remove(java.lang.String state)	Remove the WebAuthRequestCollection.WebAuthCallback associated with the given relay state value
void	valueBound(javax.servlet.http.HttpSessionBindingEvent event)
void	valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Method Detail

getOrCreate

@Nonnull
public static WebAuthRequestCollection getOrCreate(@Nonnull
                                                   GatewayContext gatewayContext,
                                                   @Nonnull
                                                   javax.servlet.http.HttpSession httpSession)

Gets the WebAuthRequestCollection associated with the given HttpSession. If a WebAuthRequestCollection does not exist on the session, a new instance is created, set on the session, and returned.

Parameters:

gatewayContext - the currently executing GatewayContext

httpSession - the HttpSession holding the WebAuthRequestCollection

Returns:

the WebAuthRequestCollection associated with the given HttpSession

getOrCreate

@Nonnull
public static WebAuthRequestCollection getOrCreate(@Nonnull
                                                   GatewayContext gatewayContext,
                                                   @Nonnull
                                                   javax.servlet.http.HttpServletRequest httpServletRequest)

Gets the WebAuthRequestCollection associated with the HttpSession on the given HttpServletRequest. If a WebAuthRequestCollection does not exist on the session, a new instance is created, set on the session, and returned.

Parameters:

gatewayContext - the currently executing GatewayContext

httpServletRequest - the HttpServletRequest which contains the HttpSession holding the WebAuthRequestCollection

Returns:

the WebAuthRequestCollection associated with the given HttpServletRequest's HttpSession

See Also:

getOrCreate(GatewayContext, HttpSession)

getOrCreate

@Nonnull
public static WebAuthRequestCollection getOrCreate(@Nonnull
                                                   RequestContext req)

Gets the WebAuthRequestCollection associated with the HttpSession on the given RequestContext. If a WebAuthRequestCollection does not exist on the session, a new instance is created, set on the session, and returned.

Parameters:

req - the RequestContext which contains the HttpSession holding the WebAuthRequestCollection

Returns:

the WebAuthRequestCollection associated with the given RequestContext's HttpSession

See Also:

getOrCreate(GatewayContext, HttpServletRequest)

get

@Nonnull
public java.util.Optional<WebAuthRequestCollection.WebAuthCallback> get(@Nonnull
                                                                        java.lang.String state)

Fetch the WebAuthRequestCollection.WebAuthCallback associated with the given relay state value

Parameters:

state - the relay state value

Returns:

an Optional containing the WebAuthRequestCollection.WebAuthCallback associated with the given relay state or an empty Optional if there is no WebAuthRequestCollection.WebAuthCallback associated with the given relay state

remove

@Nonnull
public java.util.Optional<WebAuthRequestCollection.WebAuthCallback> remove(@Nonnull
                                                                           java.lang.String state)

Remove the WebAuthRequestCollection.WebAuthCallback associated with the given relay state value

Parameters:

state - the relay state value

Returns:

an Optional containing the WebAuthRequestCollection.WebAuthCallback associated with the given relay state or an empty Optional if there is no WebAuthRequestCollection.WebAuthCallback associated with the given relay state

valueBound

public void valueBound(javax.servlet.http.HttpSessionBindingEvent event)

Specified by:

valueBound in interface javax.servlet.http.HttpSessionBindingListener

valueUnbound

public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)

Specified by:

valueUnbound in interface javax.servlet.http.HttpSessionBindingListener

onStartup

protected void onStartup()

Specified by:

onStartup in class AbstractLifecycle

onShutdown

protected void onShutdown()

Specified by:

onShutdown in class AbstractLifecycle

registerHandler

public void registerHandler(java.lang.String state,
                            java.lang.String app,
                            WebAuthRequestCollection.WebAuthResponseHandler handler)

Allows you to manually register a state key to a given handler.

Parameters:

state - the state key used to retrieve WebAuthRequestCollection.WebAuthCallback instead of using the state key generated from the WebAuthState

app - the app's name

handler - the WebAuthRequestCollection.WebAuthResponseHandler to handle the web auth response for this request

createLoginRequest

@Nonnull
public WebAuthRequestCollection.LoginRequestBuilder createLoginRequest()

Returns:

a new WebAuthRequestCollection.LoginRequestBuilder instance

createLogoutRequest

@Nonnull
public WebAuthRequestCollection.LogoutRequestBuilder createLogoutRequest()

Returns:

a new WebAuthRequestCollection.LogoutRequestBuilder instance