Package com.inductiveautomation.perspective.gateway.comm

Class Routes

java.lang.Object

com.inductiveautomation.perspective.gateway.comm.Routes

public class Routes
extends Object

These are the Perspective routes that are used for the Perspective application itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	Routes.MissingGatewayAddressException

Constructor Summary

Constructors

Constructor	Description
Routes(GatewayHook.PerspectiveGatewayContext context, RouteGroup routes)

Method Summary

Modifier and Type	Method	Description
static PerspectiveSessionCollection	getOrCreateSession(PerspectiveContext context, jakarta.servlet.http.HttpSession webSession, SessionScope scope, String remoteHost, String remoteAddr, List<Locale> locales, com.google.common.collect.ImmutableCollection<String> securityZones, NativeDevice device)
void	mountRoutes()
static AccessControlStrategy	requireSession(EnumSet<SessionScope> scopes)	Scoped access control strategy method used for mounting Perspective routes.

Methods inherited from class java.lang.Object

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

Constructor Details

Routes

public Routes(GatewayHook.PerspectiveGatewayContext context,
 RouteGroup routes)

Method Details

mountRoutes

public void mountRoutes()

requireSession

public static AccessControlStrategy requireSession(EnumSet<SessionScope> scopes)

Scoped access control strategy method used for mounting Perspective routes.

Parameters:

scopes - enum set of SessionScope restricting route access to the provided scopes (Client, Designer, or both).

Returns:

AccessControlStrategy returns the strategy for the provided scopes.

getOrCreateSession

@Nonnull
public static PerspectiveSessionCollection getOrCreateSession(@Nonnull
 PerspectiveContext context,
 @Nonnull
 jakarta.servlet.http.HttpSession webSession,
 @Nonnull
 SessionScope scope,
 @Nullable
 String remoteHost,
 @Nullable
 String remoteAddr,
 @Nonnull
 List<Locale> locales,
 @Nonnull
 com.google.common.collect.ImmutableCollection<String> securityZones,
 @Nonnull
 NativeDevice device)