com.inductiveautomation.ignition.gateway.auth.security.level

Interface SecurityLevelManager

public interface SecurityLevelManager

A SecurityLevelManager is the source of record for all SecurityLevels configured in the system

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecurityLevelManager.ChangeEvent Simple class to notify subscribers of the event bus that the security levels have changed

Method Summary

Modifier and Type	Method and Description
com.google.common.eventbus.EventBus	getEventBus() The EventBus where ChangeEvents are posted
com.google.common.collect.ImmutableCollection<SecurityLevelConfig>	getSecurityLevelsConfig() Fetch all SecurityLevelConfigs in the system
boolean	isAuthorized(com.google.common.collect.ImmutableCollection<SecurityLevelPath> targets, com.google.common.collect.ImmutableCollection<SecurityLevelPath> securityLevels, boolean isAllOf) Checks if the security levels are authorized against the target.
void	updateSecurityLevelsConfig(com.google.common.collect.ImmutableCollection<SecurityLevelConfig> updatedSecurityLevelsConfig) Update all SecurityLevelConfigs in the system

Method Detail

getSecurityLevelsConfig

@Nonnull
com.google.common.collect.ImmutableCollection<SecurityLevelConfig> getSecurityLevelsConfig()

Fetch all SecurityLevelConfigs in the system

updateSecurityLevelsConfig

@Nonnull
void updateSecurityLevelsConfig(@Nonnull
                                         com.google.common.collect.ImmutableCollection<SecurityLevelConfig> updatedSecurityLevelsConfig)

Update all SecurityLevelConfigs in the system

Parameters:

updatedSecurityLevelsConfig - the new security levels config

isAuthorized

boolean isAuthorized(@Nonnull
                     com.google.common.collect.ImmutableCollection<SecurityLevelPath> targets,
                     @Nonnull
                     com.google.common.collect.ImmutableCollection<SecurityLevelPath> securityLevels,
                     boolean isAllOf)

Checks if the security levels are authorized against the target. If isAllOf is true, each of the target security levels must be an ancestor of one of the given security levels. If isAllOf is false, at least one of the target security levels must be an ancestor of one of the given security levels.

getEventBus

@Nonnull
com.google.common.eventbus.EventBus getEventBus()

The EventBus where ChangeEvents are posted