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.
  • 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

    • idps

      public final List<String> idps
      The ordered list of Identity Provider names for this project (from the project's global props). Reads should go through getIdps().
    • unauthenticatedIdp

      public final String unauthenticatedIdp
      The Identity Provider whose security-level rules apply to unauthenticated (anonymous) sessions. Reads should go through getUnauthenticatedIdp().
    • forceIdpAuth

      public final boolean forceIdpAuth
    • autoIdpAuth

      public final boolean autoIdpAuth
    • stylesheet

      public final String stylesheet
  • Constructor Details

  • Method Details

    • getStyleHash

      public String getStyleHash()
      Returns:
      a string that represents the uniqueness of the styles of this project.
    • getSymbolStylesHash

      public String getSymbolStylesHash()
    • getIdps

      public List<String> 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

      public Optional<String> 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.