Class PerspectiveProject
java.lang.Object
com.inductiveautomation.perspective.gateway.api.PerspectiveProject
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 ClassesModifier and TypeClassDescriptionstatic classUsed to provide scripting access to some metadata about the project -
Field Summary
FieldsModifier and TypeFieldDescriptionfinal booleanfinal Stringfinal Map<ResourceId, String> final booleanThe ordered list of Identity Provider names for this project (from the project's global props).final Stringfinal ProjectConfigfinal booleanfinal Stringfinal SystemEventsConfigfinal StringThe Identity Provider whose security-level rules apply to unauthenticated (anonymous) sessions. -
Constructor Summary
ConstructorsConstructorDescriptionPerspectiveProject(@NonNull ProjectConfig projectConfig, boolean runnable, @NonNull Map<ResourceId, String> compiledStyles, @NonNull SystemEventsConfig systemEvents, @NonNull RuntimeResourceCollection.EffectiveSnapshot snapshot, @Nullable List<String> idps, @Nullable String unauthenticatedIdp, boolean forceIdpAuth, boolean autoIdpAuth, @Nullable String stylesheet) -
Method Summary
-
Field Details
-
name
-
runnable
public final boolean runnable -
projectConfig
-
compiledStyles
-
combinedStyles
-
systemEvents
-
snapshot
-
idps
-
unauthenticatedIdp
The Identity Provider whose security-level rules apply to unauthenticated (anonymous) sessions. Reads should go throughgetUnauthenticatedIdp(). -
forceIdpAuth
public final boolean forceIdpAuth -
autoIdpAuth
public final boolean autoIdpAuth -
stylesheet
-
-
Constructor Details
-
PerspectiveProject
public PerspectiveProject(@NonNull ProjectConfig projectConfig, boolean runnable, @NonNull Map<ResourceId, String> compiledStyles, @NonNull SystemEventsConfig systemEvents, @NonNull RuntimeResourceCollection.EffectiveSnapshot snapshot, @Nullable List<String> idps, @Nullable String unauthenticatedIdp, boolean forceIdpAuth, boolean autoIdpAuth, @Nullable String stylesheet)
-
-
Method Details
-
getStyleHash
- Returns:
- a string that represents the uniqueness of the styles of this project.
-
getSymbolStylesHash
-
getIdps
- Returns:
- the ordered list of Identity Provider names for this project. When the legacy perspective-props single IdP reference (by ID) still resolves, it takes precedence and is returned as a single-element list; otherwise the project's global-props IdP list is returned. never null.
-
getUnauthenticatedIdp
- Returns:
- the Identity Provider whose security-level rules apply to unauthenticated (anonymous)
sessions: a resolvable legacy perspective-props IdP takes precedence (see
getIdps()), otherwise the configured unauthenticated IdP, or empty when none is configured. never null.
-