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 java.lang.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.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ProjectConfig()
ProjectConfig(Project project, java.util.Map<java.lang.String,ViewConfig> views, PermissionsConfig permissions, PerspectiveProjectProps projectProps, PagesConfig pageConfig, SessionPropsConfig sessionProps, IdleTimeoutProps idleProps, java.util.Map<java.lang.String,KeyEvent> keyEvents, ComponentRegistry componentRegistry)
ProjectConfig(java.lang.String projectName, java.lang.String projectTitle, java.lang.String projectDescription, java.util.Map<java.lang.String,ViewConfig> views, PermissionsConfig permissions, PerspectiveProjectProps projectProps, PagesConfig pageConfig, SessionPropsConfig sessionProps, IdleTimeoutProps idleProps, java.util.Map<java.lang.String,KeyEvent> keyEvents, ComponentRegistry componentRegistry, LastModification lastModification)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<ViewConfig>	findView(java.lang.String path)
static java.util.Optional<LastModification>	getLastModification(Project project)

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

title

public java.lang.String title

description

public java.lang.String description

lastModified

public long lastModified

lastModifiedBy

public java.lang.String lastModifiedBy

views

public java.util.Map<java.lang.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

keyEvents

public java.util.Map<java.lang.String,KeyEvent> keyEvents

componentResources

public java.util.List<BrowserResource> componentResources

Constructor Detail

ProjectConfig

public ProjectConfig()

ProjectConfig

public ProjectConfig(Project project,
                     java.util.Map<java.lang.String,ViewConfig> views,
                     PermissionsConfig permissions,
                     PerspectiveProjectProps projectProps,
                     PagesConfig pageConfig,
                     SessionPropsConfig sessionProps,
                     IdleTimeoutProps idleProps,
                     java.util.Map<java.lang.String,KeyEvent> keyEvents,
                     ComponentRegistry componentRegistry)

ProjectConfig

public ProjectConfig(java.lang.String projectName,
                     java.lang.String projectTitle,
                     java.lang.String projectDescription,
                     java.util.Map<java.lang.String,ViewConfig> views,
                     PermissionsConfig permissions,
                     PerspectiveProjectProps projectProps,
                     PagesConfig pageConfig,
                     SessionPropsConfig sessionProps,
                     IdleTimeoutProps idleProps,
                     java.util.Map<java.lang.String,KeyEvent> keyEvents,
                     ComponentRegistry componentRegistry,
                     LastModification lastModification)

Method Detail

findView

public java.util.Optional<ViewConfig> findView(java.lang.String path)

getLastModification

@Nonnull
public static java.util.Optional<LastModification> getLastModification(@Nonnull
                                                                       Project project)