Package com.inductiveautomation.perspective.gateway.config

Class ProjectConfig

java.lang.Object

com.inductiveautomation.perspective.gateway.config.ProjectConfig

Direct Known Subclasses:

ProjectDiff

public class ProjectConfig
extends Object

The ProjectConfig class is Gson serializable model used by the gateway to represent a saveable Perspective client state for a given Perspective module Project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectConfig.RuntimeGsonAdapter	Custom Gson serializer for ProjectConfig that properly handles the componentResources field.

Field Summary

Fields

Modifier and Type	Field	Description
String	description
IdleTimeoutProps	idleProps
Map<String,KeyEvent>	keyEvents
long	lastModified
String	lastModifiedBy
String	name
OfflineModeConfig	offlineModeConfig
PagesConfig	pageConfig
PermissionsConfig	permissions
PerspectiveProjectProps	props
SessionPropsConfig	sessionProps
SymbolPropConfig	symbolProps
String	title
Map<String,ViewConfig>	views	All the view config objects associated with this project.

Constructor Summary

Constructors

Constructor	Description
ProjectConfig()
ProjectConfig(ResourceCollection project, Map<String,ViewConfig> views, PermissionsConfig permissions, PerspectiveProjectProps projectProps, PagesConfig pageConfig, SessionPropsConfig sessionProps, IdleTimeoutProps idleProps, SymbolPropConfig symbolProps, Map<String,KeyEvent> keyEvents, ComponentRegistry componentRegistry, OfflineModeConfig offlineModeConfig)
ProjectConfig(String projectName, String projectTitle, String projectDescription, Map<String,ViewConfig> views, PermissionsConfig permissions, PerspectiveProjectProps projectProps, PagesConfig pageConfig, SessionPropsConfig sessionProps, IdleTimeoutProps idleProps, SymbolPropConfig symbolProps, Map<String,KeyEvent> keyEvents, ComponentRegistry componentRegistry, LastModification lastModification, OfflineModeConfig offlineModeConfig)

Method Summary

Modifier and Type	Method	Description
Optional<ViewConfig>	findView(String path)
List<BrowserResource>	getComponentResources()	Returns the list of browser resources required by all components used in this project's views.
static Optional<LastModification>	getLastModification(ResourceCollection project)

Methods inherited from class java.lang.Object

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

Field Details

name

public String name

title

public String title

description

public String description

lastModified

public long lastModified

lastModifiedBy

public String lastModifiedBy

views

public Map<String,ViewConfig> views

All the view config objects associated with this project. This is a complete list at the time of startup, and includes configuration objects for views that may not be currently active/instantiated on the client side.

permissions

public PermissionsConfig permissions

props

public PerspectiveProjectProps props

pageConfig

public PagesConfig pageConfig

sessionProps

public SessionPropsConfig sessionProps

idleProps

public IdleTimeoutProps idleProps

symbolProps

public SymbolPropConfig symbolProps

keyEvents

public Map<String,KeyEvent> keyEvents

offlineModeConfig

public OfflineModeConfig offlineModeConfig

Constructor Details

ProjectConfig

public ProjectConfig()

ProjectConfig

public ProjectConfig(ResourceCollection project,
 Map<String,ViewConfig> views,
 PermissionsConfig permissions,
 PerspectiveProjectProps projectProps,
 PagesConfig pageConfig,
 SessionPropsConfig sessionProps,
 IdleTimeoutProps idleProps,
 SymbolPropConfig symbolProps,
 Map<String,KeyEvent> keyEvents,
 ComponentRegistry componentRegistry,
 OfflineModeConfig offlineModeConfig)

ProjectConfig

public ProjectConfig(String projectName,
 String projectTitle,
 String projectDescription,
 Map<String,ViewConfig> views,
 PermissionsConfig permissions,
 PerspectiveProjectProps projectProps,
 PagesConfig pageConfig,
 SessionPropsConfig sessionProps,
 IdleTimeoutProps idleProps,
 SymbolPropConfig symbolProps,
 Map<String,KeyEvent> keyEvents,
 ComponentRegistry componentRegistry,
 LastModification lastModification,
 OfflineModeConfig offlineModeConfig)

Method Details

findView

public Optional<ViewConfig> findView(String path)

getLastModification

@Nonnull
public static Optional<LastModification> getLastModification(@Nonnull
 ResourceCollection project)

getComponentResources

public List<BrowserResource> getComponentResources()

Returns the list of browser resources required by all components used in this project's views.

Resource building is lazily computed and memoized using Suppliers.memoize(com.google.common.base.Supplier<T>) to ensure all modules have completed their startup phase and registered their components with the ComponentRegistry. Building resources eagerly in the constructor can result in missing component descriptors if custom modules haven't finished initialization yet.

Returns:

ordered list of browser resources with dependencies topologically sorted