Package com.inductiveautomation.perspective.gateway.api

Class PerspectiveProject

java.lang.Object

com.inductiveautomation.perspective.gateway.api.PerspectiveProject

public class PerspectiveProject
extends java.lang.Object

A PerspectiveProject is a simple container of a ProjectConfig, concatenated compiled CSS style resources, and the Map of all style resource IDs to their compiled CSS in the Project. The Map of style resources should be considered immutable and could throw RuntimeExceptions if altered in any way. The combined styles String is automatically generated from the injected compiled resources Map.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PerspectiveProject.SimplifiedGsonEncoder	Used to provide scripting access to some metadata about the project

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	combinedStyles
java.util.Map<ProjectResourceId,java.lang.String>	compiledStyles
boolean	forceIdpAuth
java.lang.String	idp
java.lang.String	name
ProjectConfig	projectConfig
boolean	runnable
RuntimeProject.EffectiveProjectSnapshot	snapshot
SystemEventsConfig	systemEvents

Constructor Summary

Constructors

Constructor	Description
PerspectiveProject(ProjectConfig projectConfig, boolean runnable, java.util.Map<ProjectResourceId,java.lang.String> compiledStyles, SystemEventsConfig systemEvents, RuntimeProject.EffectiveProjectSnapshot snapshot, java.lang.String idp, boolean forceIdpAuth)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.lang.String>	getIdp()
java.lang.String	getStyleHash()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

runnable

public final boolean runnable

projectConfig

public final ProjectConfig projectConfig

compiledStyles

public final java.util.Map<ProjectResourceId,java.lang.String> compiledStyles

combinedStyles

public final java.lang.String combinedStyles

systemEvents

public final SystemEventsConfig systemEvents

snapshot

public final RuntimeProject.EffectiveProjectSnapshot snapshot

idp

public final java.lang.String idp

forceIdpAuth

public final boolean forceIdpAuth

Constructor Detail

PerspectiveProject

public PerspectiveProject(@Nonnull
                          ProjectConfig projectConfig,
                          boolean runnable,
                          @Nonnull
                          java.util.Map<ProjectResourceId,java.lang.String> compiledStyles,
                          @Nonnull
                          SystemEventsConfig systemEvents,
                          @Nonnull
                          RuntimeProject.EffectiveProjectSnapshot snapshot,
                          @Nullable
                          java.lang.String idp,
                          boolean forceIdpAuth)

Method Detail

getStyleHash

public java.lang.String getStyleHash()

Returns:

a string that represents the uniqueness of the styles of this project.

getIdp

public java.util.Optional<java.lang.String> getIdp()

Returns:

the name of the default Identity Provider for this project