Package com.inductiveautomation.perspective.gateway.api

Class PerspectiveProject

java.lang.Object

com.inductiveautomation.perspective.gateway.api.PerspectiveProject

public class PerspectiveProject
extends 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 ResourceCollection. 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
final boolean	autoIdpAuth
final String	combinedStyles
final Map<ResourceId,String>	compiledStyles
final boolean	forceIdpAuth
final String	idp
final String	name
final ProjectConfig	projectConfig
final boolean	runnable
final RuntimeResourceCollection.EffectiveSnapshot	snapshot
final String	stylesheet
final SystemEventsConfig	systemEvents

Constructor Summary

Constructors

Constructor	Description
PerspectiveProject(ProjectConfig projectConfig, boolean runnable, Map<ResourceId,String> compiledStyles, SystemEventsConfig systemEvents, RuntimeResourceCollection.EffectiveSnapshot snapshot, String idp, boolean forceIdpAuth, boolean autoIdpAuth, String stylesheet)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getIdp()
String	getStyleHash()
String	getSymbolStylesHash()

Methods inherited from class java.lang.Object

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

Field Details

name

public final String name

runnable

public final boolean runnable

projectConfig

public final ProjectConfig projectConfig

compiledStyles

public final Map<ResourceId,String> compiledStyles

combinedStyles

public final String combinedStyles

systemEvents

public final SystemEventsConfig systemEvents

snapshot

public final RuntimeResourceCollection.EffectiveSnapshot snapshot

idp

public final String idp

forceIdpAuth

public final boolean forceIdpAuth

autoIdpAuth

public final boolean autoIdpAuth

stylesheet

public final String stylesheet

Constructor Details

PerspectiveProject

public PerspectiveProject(@Nonnull
 ProjectConfig projectConfig,
 boolean runnable,
 @Nonnull
 Map<ResourceId,String> compiledStyles,
 @Nonnull
 SystemEventsConfig systemEvents,
 @Nonnull
 RuntimeResourceCollection.EffectiveSnapshot snapshot,
 @Nullable
 String idp,
 boolean forceIdpAuth,
 boolean autoIdpAuth,
 @Nullable
 String stylesheet)

Method Details

getStyleHash

public String getStyleHash()

Returns:

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

getSymbolStylesHash

public String getSymbolStylesHash()

getIdp

public Optional<String> getIdp()

Returns:

the name of the default Identity Provider for this project