Interface SessionKernel

    • Method Detail

      • getProjectName

        java.lang.String getProjectName()
        Returns:
        the name of the project associated with the session
      • getGson

        default com.inductiveautomation.ignition.common.gson.Gson getGson()
        Returns:
        a Gson instance for json serialization / de-serialization
      • getLogger

        LoggerEx getLogger()
        Returns:
        the LoggerEx associated with the session
      • getEventBus

        com.google.common.eventbus.EventBus getEventBus()
        Returns:
        the EventBus associated with the session
      • getSessionId

        java.util.UUID getSessionId()
        Returns:
        the session's unique identifier
      • startup

        void startup()
        Starts up the session kernel
        Throws:
        java.lang.IllegalStateException - if the session kernel has already been started or shutdown
      • shutdown

        void shutdown()
        Shuts down the session kernel
        Throws:
        java.lang.IllegalStateException - if the session has not been started or if it has already been shut down
      • getStartupTime

        long getStartupTime()
        Returns:
        the time in nanoseconds when the session kernel started (or 0 if the session kernel has not yet been started)
      • getLastMessageTime

        long getLastMessageTime()
        Returns:
        the time in nanoseconds when the last message was received by the session containing this kernel
      • touch

        void touch()
        Updates the last message time to the current time in nanoseconds
        See Also:
        System.nanoTime()
      • createAccessToken

        java.lang.String createAccessToken()
        Create a new access token for the this session kernel. The access token expires in 30 seconds.
        Returns:
        the new short-lived access token used to establish a web socket connection
      • claimAccessToken

        boolean claimAccessToken​(java.lang.String token)
        Claim the given access token previously created by this session kernel.
        Parameters:
        token - the access token to claim
        Returns:
        true if the access token is valid (not expired). false otherwise