Package com.inductiveautomation.ignition.gateway.dataroutes

Class WicketAccessControl

java.lang.Object

com.inductiveautomation.ignition.gateway.dataroutes.WicketAccessControl

public final class WicketAccessControl
extends java.lang.Object

Holds some static instances of RouteAccessControl objects that help data-api routes require the user to have an active wicket session and be logged in to various sections of the web ui.

Field Summary

Fields

Modifier and Type	Field	Description
static RouteAccessControl	CONFIG_SECTION	Restricts a route handler to only be accessible when the web session is currently logged into the gateway web ui's configure section.
static RouteAccessControl	STATUS_SECTION	Restricts a route handler to only be accessible when the web session is currently logged into the gateway web ui's status section.

Constructor Summary

Constructors

Constructor	Description
WicketAccessControl()

Method Summary

Modifier and Type	Method	Description
static RouteAccessControl	activeRoute(RouteAccessControl routeAccessControl)	Wraps a RouteAccessControl and delegates to it after touching the IgnitionSession associated with the request (if one exists).
static java.util.Optional<IgnitionSession>	getWicketSession(RequestContext context)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_SECTION

public static final RouteAccessControl STATUS_SECTION

Restricts a route handler to only be accessible when the web session is currently logged into the gateway web ui's status section.

CONFIG_SECTION

public static final RouteAccessControl CONFIG_SECTION

Restricts a route handler to only be accessible when the web session is currently logged into the gateway web ui's configure section.

Constructor Detail

WicketAccessControl

public WicketAccessControl()

Method Detail

getWicketSession

public static java.util.Optional<IgnitionSession> getWicketSession(RequestContext context)

activeRoute

public static RouteAccessControl activeRoute(RouteAccessControl routeAccessControl)

Wraps a RouteAccessControl and delegates to it after touching the IgnitionSession associated with the request (if one exists).

Parameters:

routeAccessControl - the RouteAccessControl to wrap

Returns:

the new "active" RouteAccessControl wrapper