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

Interface WebAuthRequestCollection.BaseWebAuthResponseHandler

All Superinterfaces:

WebAuthRequestCollection.WebAuthResponseHandler

All Known Subinterfaces:

WebAuthRequestCollection.LoginResponseHandler, WebAuthRequestCollection.LogoutResponseHandler

Enclosing class:

WebAuthRequestCollection

public static interface WebAuthRequestCollection.BaseWebAuthResponseHandler
extends WebAuthRequestCollection.WebAuthResponseHandler

Base WebAuthRequestCollection.WebAuthResponseHandler interface which provides some default method implementations common to many types of handlers

Method Summary

Modifier and Type	Method	Description
void	applyResponse(WebAuthSession webAuthSession, WebAuthResponseContext webAuthResponseContext)
java.net.URI	doHandle(RequestContext requestContext, WebAuthUserContext webAuthUserContext)	Handle the web auth response.
java.util.Optional<java.lang.String>	getIdentityProvider(RequestContext requestContext)
com.google.common.collect.ImmutableCollection<java.lang.String>	getSecurityZones(RequestContext requestContext)
default java.net.URI	handle(RequestContext requestContext, WebAuthResponseContext webAuthResponseContext)	Handle the web auth response.
default boolean	shouldRotateSessionId()

Methods inherited from interface com.inductiveautomation.ignition.gateway.auth.web.WebAuthRequestCollection.WebAuthResponseHandler

handleTimeout

Method Detail

getIdentityProvider

@Nonnull
java.util.Optional<java.lang.String> getIdentityProvider(@Nonnull
                                                         RequestContext requestContext)

Parameters:

requestContext - the RequestContext for the HTTP Request carrying the web auth response

Returns:

the Identity Provider which should be used to process the web auth response

getSecurityZones

@Nonnull
com.google.common.collect.ImmutableCollection<java.lang.String> getSecurityZones(@Nonnull
                                                                                 RequestContext requestContext)

Parameters:

requestContext - the RequestContext for the HTTP Request carrying the web auth response

Returns:

the security zones for the current request context

applyResponse

void applyResponse(@Nonnull
                   WebAuthSession webAuthSession,
                   @Nonnull
                   WebAuthResponseContext webAuthResponseContext)

doHandle

@Nonnull
java.net.URI doHandle(@Nonnull
                      RequestContext requestContext,
                      @Nonnull
                      WebAuthUserContext webAuthUserContext)
               throws java.lang.Exception

Handle the web auth response.

Parameters:

requestContext - the RequestContext for the HTTP Request carrying the web auth response

webAuthUserContext - the WebAuthUserContext containing the WebAuthUser, granted security levels, and security zones

Returns:

the URI to which the user should be redirected after handling the web auth response

Throws:

java.lang.Exception - if there is an unexpected problem handling the web auth response

shouldRotateSessionId

default boolean shouldRotateSessionId()

handle

@Nonnull
default java.net.URI handle(@Nonnull
                            RequestContext requestContext,
                            @Nonnull
                            WebAuthResponseContext webAuthResponseContext)
                     throws java.lang.Exception

Description copied from interface: WebAuthRequestCollection.WebAuthResponseHandler

Handle the web auth response.

Specified by:

handle in interface WebAuthRequestCollection.WebAuthResponseHandler

Parameters:

requestContext - the RequestContext for the HTTP Request carrying the web auth response

webAuthResponseContext - the WebAuthResponseContext for the web auth response

Returns:

the URI to which the user should be redirected after handling the web auth response

Throws:

java.lang.Exception - if there is an unexpected problem handling the web auth response