Package com.inductiveautomation.perspective.gateway.session

Class AbstractSessionKernel

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.perspective.gateway.session.AbstractSessionKernel

All Implemented Interfaces:

SessionKernel

public abstract class AbstractSessionKernel
extends AbstractLifecycle
implements SessionKernel

Base class for SessionKernel implementations. Encapsulates the basic properties and lifecycle of a session kernel.

Method Summary

Modifier and Type	Method	Description
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 jsonElement)	Create a new token associated with the given type and data for the this session kernel.
com.google.common.eventbus.EventBus	getEventBus()
long	getLastMessageTime()
LoggerEx	getLogger()
java.lang.String	getProjectName()
PerspectiveSessionCollection	getSessionCollection()
java.util.UUID	getSessionId()
long	getStartupTime()
protected void	onShutdown()
protected void	onStartup()
ExecutionQueue	queue()
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.session.SessionKernel

getGson, shutdown, startup

Method Detail

getSessionCollection

public PerspectiveSessionCollection getSessionCollection()

Specified by:

getSessionCollection in interface SessionKernel

Returns:

the PerspectiveSessionCollection which contains the session

getProjectName

public java.lang.String getProjectName()

Specified by:

getProjectName in interface SessionKernel

Returns:

the name of the project associated with the session

queue

public ExecutionQueue queue()

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 SessionKernel

Returns:

the LoggerEx associated with the session

getEventBus

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

Specified by:

getEventBus in interface SessionKernel

Returns:

the EventBus associated with the session

getSessionId

public java.util.UUID getSessionId()

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

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()

onStartup

protected void onStartup()

Specified by:

onStartup in class AbstractLifecycle

onShutdown

protected void onShutdown()

Specified by:

onShutdown in class AbstractLifecycle

createToken

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

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