Package com.inductiveautomation.ignition.gateway.dataroutes

Class AbstractGatewayAccessControlStrategy

java.lang.Object

com.inductiveautomation.ignition.gateway.dataroutes.AbstractAccessControlStrategy

com.inductiveautomation.ignition.gateway.dataroutes.AbstractGatewayAccessControlStrategy

All Implemented Interfaces:

AccessControlStrategy

Direct Known Subclasses:

ApiTokenManager.TokenAccessControl, SecurityZoneAccessControlStrategy, WebUiSession.WebUiSessionAccessControl

public abstract class AbstractGatewayAccessControlStrategy
extends AbstractAccessControlStrategy

An access control strategy that understands how to map the PermissionType enum to the gateways' configured required permissions far that type.

In other words, if the access type is PermissionType.WRITE, this strategy will look up the permissions for the "Config" permissions in the gateway's system properties.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PermissionType	permissionType

Fields inherited from class com.inductiveautomation.ignition.gateway.dataroutes.AbstractAccessControlStrategy

EMPTY_SECURITY_LEVELS

Fields inherited from interface com.inductiveautomation.ignition.gateway.dataroutes.AccessControlStrategy

OPEN_ROUTE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGatewayAccessControlStrategy(PermissionType permissionType)

Method Summary

Modifier and Type	Method	Description
protected Set<PermissionsConfig>	getRequiredPermissions(RequestContext context)	Get the required permissions for the given request.
String	toString()

Methods inherited from class com.inductiveautomation.ignition.gateway.dataroutes.AbstractAccessControlStrategy

canAccess, getSecurityLevels

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.dataroutes.AccessControlStrategy

getWwwAuthenticateHeader, validate

Field Details

permissionType

protected final PermissionType permissionType

Constructor Details

AbstractGatewayAccessControlStrategy

protected AbstractGatewayAccessControlStrategy(PermissionType permissionType)

Method Details

getRequiredPermissions

protected Set<PermissionsConfig> getRequiredPermissions(RequestContext context)

Description copied from class: AbstractAccessControlStrategy

Get the required permissions for the given request. If more than one permissions config is returned, the route will be granted access if any of the permissions configs are satisfied. In other words, the returned configs are OR-ed together.

Specified by:

getRequiredPermissions in class AbstractAccessControlStrategy

toString

public String toString()

Overrides:

toString in class Object