Package com.inductiveautomation.perspective.gateway.session

Class SessionKernelWrapper<T extends SessionKernel>

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

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

Type Parameters:

T - the type of SessionKernel to be encapsulated by this wrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSession, SecuredPerspectiveProjectSession

public abstract class SessionKernelWrapper<T extends SessionKernel>
extends AbstractLifecycle
implements SessionKernel, InternalSession

Base class for Perspective Sessions which wrap a session kernel. All SessionKernel methods in this class will proxy calls to the delegate session kernel.

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 interface com.inductiveautomation.perspective.gateway.session.InternalSession

SESSION

Method Summary

Modifier and Type	Method	Description
protected abstract void	broadcast(java.lang.String protocol, java.lang.String payload)	Broadcast a message to all pages associated with this session
java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonElement>	claimToken(java.lang.String type, java.lang.String token)	Claim the given token associated with the given data type previously created by this session kernel.
java.lang.String	createToken(java.lang.String type, com.inductiveautomation.ignition.common.gson.JsonElement data)	Create a new token associated with the given type and data for the this session kernel.
AuditContext.Builder	getAuditSnapshot()
com.google.common.eventbus.EventBus	getEventBus()
EventManager	getEventManager()	An EventManager for events targeted to the running Perspective Project this session.
com.inductiveautomation.ignition.common.gson.Gson	getGson()
long	getLastComm(java.util.concurrent.TimeUnit timeUnit)	Return the time in the given time unit when the last communication was received from the client
long	getLastMessageTime()
LoggerEx	getLogger()
java.lang.String	getLogoutMessage()
java.lang.String	getPageClosedMessage()
java.lang.String	getProjectName()	The project that this session is running.
java.lang.String	getSessionClosedMessage()
PerspectiveSessionCollection	getSessionCollection()
java.util.UUID	getSessionId()
PerspectiveSessionInfo	getSessionInfo()
SessionStats	getSessionStats()
long	getStartupTime()
long	getUptime(java.util.concurrent.TimeUnit timeUnit)	Return the amount of time elapsed in the given time unit since the session started up.
void	onHello()	Called every time the hello API is invoked on this session.
protected void	onShutdown()
protected void	onStartup()
ExecutionQueue	queue()	Queue upon which all work for components and their properties should occur on
void	touch()	Updates the last message time to the current time in nanoseconds

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

close, closePage, closePage, destroySession, findPage, getBindingCount, getComponentCount, getLocale, getOrCreatePage, getPageCount, getPages, getPerspectiveContext, getProject, getTimeZone, getTimeZoneId, getViewCount, isRunning, logout, notifyConnected, notifyDisconnected, onKeepaliveReceived, onLoginResponse, onLogoutResponse, onSessionInit, receive, scope, shutdown, startup, updateSessionProps, visitPage

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

mdc, mdcSetupTree, mdcTeardownTree, mdcWrap

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

createPropertyReference, getAuditProfile, getQualifiedPath

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

getPropertyTreeOf

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

createViewModel, findViewConfig, getGatewayContext, getMdcParent, getName, getNamedQueryManager, getPage, getPageTimeout, getScriptManager, getSession, getTagHistoryManager, getTagManager, getView, getWebAuthStatus, mdcSetup, mdcTeardown, refreshBinding, sendErrorToDesigner

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

shutdown, startup

Method Detail

getSessionCollection

public PerspectiveSessionCollection getSessionCollection()

Specified by:

getSessionCollection in interface InternalSession

Specified by:

getSessionCollection in interface SessionKernel

Returns:

the PerspectiveSessionCollection which contains the session

getProjectName

public java.lang.String getProjectName()

Description copied from interface: Session

The project that this session is running.

Specified by:

getProjectName in interface Session

Specified by:

getProjectName in interface SessionKernel

Returns:

the name of the project associated with the session

getGson

public com.inductiveautomation.ignition.common.gson.Gson getGson()

Specified by:

getGson in interface SessionKernel

Returns:

a Gson instance for json serialization / de-serialization

queue

public ExecutionQueue queue()

Description copied from interface: Session

Queue upon which all work for components and their properties should occur on

Specified by:

queue in interface Session

Specified by:

queue in interface SessionKernel

Returns:

the ExecutionQueue used to run session tasks in serial

getLogger

public LoggerEx getLogger()

Specified by:

getLogger in interface LoggingContext

Specified by:

getLogger in interface SessionKernel

Returns:

the LoggerEx associated with the session

getEventBus

public com.google.common.eventbus.EventBus getEventBus()

Specified by:

getEventBus in interface Session

Specified by:

getEventBus in interface SessionKernel

getEventManager

public EventManager getEventManager()

Description copied from interface: Session

An EventManager for events targeted to the running Perspective Project this session.

Specified by:

getEventManager in interface Session

Specified by:

getEventManager in interface SessionKernel

Returns:

the EventManager associated with the session

getSessionId

public java.util.UUID getSessionId()

Specified by:

getSessionId in interface Session

Specified by:

getSessionId in interface SessionKernel

Returns:

the session's unique identifier

getStartupTime

public long getStartupTime()

Specified by:

getStartupTime in interface SessionKernel

Returns:

the time in nanoseconds when the session kernel started (or 0 if the session kernel has not yet been started)

getLastMessageTime

public long getLastMessageTime()

Specified by:

getLastMessageTime in interface SessionKernel

Returns:

the time in nanoseconds when the last message was received by the session containing this kernel

getSessionStats

public SessionStats getSessionStats()

Specified by:

getSessionStats in interface Session

Specified by:

getSessionStats in interface SessionKernel

Returns:

An object containing various statistics that pertain to this session. Also useful for registering metrics that will automatically get removed when this session is shut down.

touch

public void touch()

Description copied from interface: SessionKernel

Updates the last message time to the current time in nanoseconds

Specified by:

touch in interface SessionKernel

See Also:

System.nanoTime()

broadcast

protected abstract void broadcast(java.lang.String protocol,
                                  java.lang.String payload)

Broadcast a message to all pages associated with this session

Parameters:

protocol - the protocol of the message to broadcast

payload - the payload of the message to broadcast

onStartup

protected void onStartup()

Specified by:

onStartup in class AbstractLifecycle

onShutdown

protected void onShutdown()

Specified by:

onShutdown in class AbstractLifecycle

onHello

public void onHello()

Description copied from interface: InternalSession

Called every time the hello API is invoked on this session.

Specified by:

onHello in interface InternalSession

getSessionInfo

public PerspectiveSessionInfo getSessionInfo()

Specified by:

getSessionInfo in interface InternalSession

Returns:

a report about this session

getUptime

public long getUptime(java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: InternalSession

Return the amount of time elapsed in the given time unit since the session started up.

Specified by:

getUptime in interface InternalSession

Parameters:

timeUnit - the TimeUnit to which the internal startup time should be converted

Returns:

the up time in the given unit

getLastComm

public long getLastComm(java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: InternalSession

Return the time in the given time unit when the last communication was received from the client

Specified by:

getLastComm in interface InternalSession

Parameters:

timeUnit - the TimeUnit to which the last communication time should be converted

Returns:

the last communication time in the given unit

getSessionClosedMessage

public java.lang.String getSessionClosedMessage()

Specified by:

getSessionClosedMessage in interface InternalSession

Returns:

the default message sent to the client when the session is closed

getPageClosedMessage

public java.lang.String getPageClosedMessage()

Specified by:

getPageClosedMessage in interface InternalSession

Returns:

the default message sent to the client then a page is closed

getLogoutMessage

public java.lang.String getLogoutMessage()

Specified by:

getLogoutMessage in interface InternalSession

Returns:

the default message sent to the client when the user logs out

getAuditSnapshot

@Nonnull
public AuditContext.Builder getAuditSnapshot()

Specified by:

getAuditSnapshot in interface AuditingContext

Returns:

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

createToken

public java.lang.String createToken(java.lang.String type,
                                    com.inductiveautomation.ignition.common.gson.JsonElement data)

Description copied from interface: SessionKernel

Create a new token associated with the given type and data for the this session kernel. The token expires in 30 seconds.

Specified by:

createToken in interface InternalSession

Specified by:

createToken in interface SessionKernel

Returns:

the new short-lived token

claimToken

public java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonElement> claimToken(java.lang.String type,
                                                                                               java.lang.String token)

Description copied from interface: SessionKernel

Claim the given token associated with the given data type previously created by this session kernel.

Specified by:

claimToken in interface InternalSession

Specified by:

claimToken in interface SessionKernel

token - the token to claim

Returns:

an Optional containing the JsonElement data associated with the given data type and token, or an empty Optional if no data exists for the given data type and token pair