Package com.inductiveautomation.ignition.gateway.web.session

Interface WebUiSession

All Superinterfaces:

Session

public interface WebUiSession
extends Session

A session for the react-based web ui for the Gateway, introduced in Ignition 8.3.0. These sessions are created upon first authentication by the user. Until the session is created, the application backend is stateless.

Since:

8.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebUiSession.CsrfWebUiSessionAccessControl	A WebUiSession.WebUiSessionAccessControl which requires that each request furnish a valid CSRF token.
static class	WebUiSession.WebUiSessionAccessControl	An AbstractGatewayAccessControlStrategy where auth context such as user information and granted security levels are derived from Web UI session cookies.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CSRF_TOKEN_HEADER
static final AccessControlStrategy	SESSION_ACCESS
static final AccessControlStrategy	SESSION_READ
static final AccessControlStrategy	SESSION_WRITE

Method Summary

Modifier and Type	Method	Description
static Optional<WebUiSession>	find(RequestContext req)
String	getCsrfToken()
Optional<WebAuthUserContext>	getUserContext()

Methods inherited from interface com.inductiveautomation.ignition.gateway.auth.session.Session

getId, invalidate, isValid

Field Details

CSRF_TOKEN_HEADER

static final String CSRF_TOKEN_HEADER

See Also:

• Constant Field Values

SESSION_ACCESS

static final AccessControlStrategy SESSION_ACCESS

SESSION_READ

static final AccessControlStrategy SESSION_READ

SESSION_WRITE

static final AccessControlStrategy SESSION_WRITE

Method Details

getUserContext

Optional<WebAuthUserContext> getUserContext()

getCsrfToken

String getCsrfToken()

find

static Optional<WebUiSession> find(RequestContext req)