Package com.inductiveautomation.perspective.gateway.session

Class PerspectiveDesignSession

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.perspective.gateway.session.SessionKernelWrapper<T>

com.inductiveautomation.perspective.gateway.session.AbstractSession<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession

All Implemented Interfaces:

AuditingContext, LoggingContext, PerspectiveElement, PropertyTreeOwner, Session, InternalSession, SessionKernel

public class PerspectiveDesignSession
extends AbstractSession<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

Implementation of AbstractSession which is used when the Ignition Designer is creating, running, and previewing Perspective Views. Created by pjones on 4/17/17.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.perspective.gateway.session.InternalSession

InternalSession.PageVisitor

Nested classes/interfaces inherited from interface com.inductiveautomation.perspective.gateway.api.Session

Session.WebAuthStatusChangeEvent

Field Summary

Fields inherited from class com.inductiveautomation.perspective.gateway.session.AbstractSession

bindings, changeScripts, handlers, pages, props

Fields inherited from interface com.inductiveautomation.perspective.gateway.session.InternalSession

SESSION

Method Summary

Modifier and Type	Method	Description
void	alter(PropertyConfigChange change)
void	close(java.lang.String message)	Destroys this session and moves clients to a terminal state of closed
void	closePage(java.lang.String pageId, java.lang.String message)	Shuts down and removes the page associated with the given page ID which will disconnect the associated message channel (if one is connected).
protected PropertyTreePermissionModel	createPermissionModel(PropertyType scope, PropertyConfigCollection config)
DesignerPropertyReference	createPropertyReference(java.lang.String referencePath, java.util.function.Consumer<PropertyTreeChangeEvent> subscriber, java.util.Set<Origin> acceptableOrigins)	Create a PropertyReference with this PerspectiveElement as the target.
ViewModel	createViewModel(PageModel group, ViewInstanceId id, ViewConfig config, com.inductiveautomation.ignition.common.gson.JsonObject params)
java.util.concurrent.CompletableFuture<java.util.Optional<ViewConfig>>	findViewConfig(java.lang.String viewResourcePath)	Returns a CompletableFuture that completes to present an Optional<ViewConfig> for the specified path.
AuditContext.Builder	getAuditSnapshot()
NamedQueryManager	getNamedQueryManager()
ScriptManager	getScriptManager()
TagHistoryManager	getTagHistoryManager()
TagManager	getTagManager()
WebAuthStatus	getWebAuthStatus()
java.util.Optional<java.lang.String>	logout(java.lang.String message)	Always throws UnsupportedOperationException - it is a mistake if a code path reaches this method
protected void	maybeScheduleReaper()	Call this when it's possible the last page has been closed.
protected DesignerPageModel	newPage(java.lang.String pageId)
void	onDesignerNamedQueriesChange(java.util.Map<java.lang.String,NamedQuery> namedQueryMap)
void	onLoginResponse(WebAuthResponseContext webAuthResponseContext)	Always throws UnsupportedOperationException - it is a mistake if a code path reaches this method
void	onLogoutResponse(WebAuthResponseContext webAuthResponseContext)	Always throws UnsupportedOperationException - it is a mistake if a code path reaches this method
void	sendErrorToDesigner(java.lang.String message, java.lang.Throwable throwable)	Pipes the error message down to the designer (or no-op if this is a client)

Methods inherited from class com.inductiveautomation.perspective.gateway.session.AbstractSession

broadcast, closePage, findPage, findPropConfig, getBindingCount, getComponentCount, getLocale, getOrCreatePage, getPageCount, getPageReport, getPages, getPropertyTreeOf, getTimeZoneId, getViewCount, initProperties, notifyConnected, notifyDisconnected, onKeepaliveReceived, onSessionInit, receive, refreshBinding, sendSessionKeepalive, updateSessionProps, visitPage

Methods inherited from class com.inductiveautomation.perspective.gateway.session.SessionKernelWrapper

claimToken, createToken, getEventBus, getEventManager, getGson, getLastComm, getLastMessageTime, getLogger, getLogoutMessage, getPageClosedMessage, getProjectName, getSessionClosedMessage, getSessionCollection, getSessionId, getSessionInfo, getSessionStats, getStartupTime, getUptime, onHello, onShutdown, onStartup, queue, touch

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuditingContext

audit

Methods inherited from interface com.inductiveautomation.perspective.gateway.session.InternalSession

destroySession, getPerspectiveContext, getProject, getTimeZone, isRunning, scope, shutdown, startup

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.LoggingContext

mdc, mdcSetupTree, mdcTeardownTree, mdcWrap

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PerspectiveElement

getAuditProfile, getQualifiedPath

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.Session

getGatewayContext, getMdcParent, getName, getPage, getPageTimeout, getSession, getView, mdcSetup, mdcTeardown

Methods inherited from interface com.inductiveautomation.perspective.gateway.session.SessionKernel

shutdown, startup

Method Detail

alter

public void alter(PropertyConfigChange change)

newPage

@Nonnull
protected DesignerPageModel newPage(@Nonnull
                                    java.lang.String pageId)

Overrides:

newPage in class AbstractSession<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

createPermissionModel

protected PropertyTreePermissionModel createPermissionModel(PropertyType scope,
                                                            PropertyConfigCollection config)

Overrides:

createPermissionModel in class AbstractSession<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

maybeScheduleReaper

protected void maybeScheduleReaper()

Description copied from class: AbstractSession

Call this when it's possible the last page has been closed. The session will then schedule the reaper to close the session itself (runtime sessions only, designer sessions don't reap in this way)

Specified by:

maybeScheduleReaper in class AbstractSession<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

getWebAuthStatus

@Nonnull
public WebAuthStatus getWebAuthStatus()

Returns:

the WebAuthStatus for this Session

logout

@Nonnull
public java.util.Optional<java.lang.String> logout(@Nullable
                                                   java.lang.String message)

Always throws UnsupportedOperationException - it is a mistake if a code path reaches this method

Parameters:

message - the message to display to the user after they are logged out of this session

Returns:

a logout token or hint for the IdP if one is available

onLoginResponse

public void onLoginResponse(@Nonnull
                            WebAuthResponseContext webAuthResponseContext)

Always throws UnsupportedOperationException - it is a mistake if a code path reaches this method

Parameters:

webAuthResponseContext - the login response object

onLogoutResponse

public void onLogoutResponse(@Nonnull
                             WebAuthResponseContext webAuthResponseContext)

Always throws UnsupportedOperationException - it is a mistake if a code path reaches this method

Parameters:

webAuthResponseContext - the logout response object

createViewModel

public ViewModel createViewModel(PageModel group,
                                 ViewInstanceId id,
                                 ViewConfig config,
                                 com.inductiveautomation.ignition.common.gson.JsonObject params)

findViewConfig

public java.util.concurrent.CompletableFuture<java.util.Optional<ViewConfig>> findViewConfig(java.lang.String viewResourcePath)

Description copied from interface: Session

Returns a CompletableFuture that completes to present an Optional<ViewConfig> for the specified path. The use of the future is to allow for the asynch collection of configs for views which are retrieved via asynchronous processes, as is the case when a view is being edited/altered in the designer.

Parameters:

viewResourcePath - path to the view's project resource within the project being run.

getTagManager

public TagManager getTagManager()

getTagHistoryManager

public TagHistoryManager getTagHistoryManager()

getScriptManager

@Nonnull
public ScriptManager getScriptManager()

getNamedQueryManager

public NamedQueryManager getNamedQueryManager()

createPropertyReference

@Nonnull
public DesignerPropertyReference createPropertyReference(java.lang.String referencePath,
                                                         java.util.function.Consumer<PropertyTreeChangeEvent> subscriber,
                                                         java.util.Set<Origin> acceptableOrigins)

Description copied from interface: PerspectiveElement

Create a PropertyReference with this PerspectiveElement as the target.

Parameters:

referencePath - the path to the property

subscriber - the subscriber - a Consumer of PropertyTreeChangeEvents

acceptableOrigins - the Set of Origins in which the subscriber is interested

Returns:

the PropertyReference

onDesignerNamedQueriesChange

public void onDesignerNamedQueriesChange(java.util.Map<java.lang.String,NamedQuery> namedQueryMap)

close

public void close(@Nullable
                  java.lang.String message)

Description copied from interface: Session

Destroys this session and moves clients to a terminal state of closed

Parameters:

message - the message displayed to the client on the terminal state page

closePage

public void closePage(java.lang.String pageId,
                      @Nullable
                      java.lang.String message)

Description copied from interface: InternalSession

Shuts down and removes the page associated with the given page ID which will disconnect the associated message channel (if one is connected). Moves the client to a terminal state page of closed with the given message.

Specified by:

closePage in interface InternalSession

Overrides:

closePage in class AbstractSession<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

Parameters:

pageId - the page ID associated with the target page

message - the message displayed to the client on the terminal state page

sendErrorToDesigner

public void sendErrorToDesigner(java.lang.String message,
                                java.lang.Throwable throwable)

Description copied from interface: Session

Pipes the error message down to the designer (or no-op if this is a client)

getAuditSnapshot

@Nonnull
public AuditContext.Builder getAuditSnapshot()

Specified by:

getAuditSnapshot in interface AuditingContext

Overrides:

getAuditSnapshot in class SessionKernelWrapper<com.inductiveautomation.perspective.gateway.session.PerspectiveDesignSession.SessionKernelImpl>

Returns:

A new, or extended, AuditContext.Builder, with qualified information about the current scope.