Package com.inductiveautomation.factorypmi.application.runtime

Class ClientLaunchHook

  • All Implemented Interfaces:
    LaunchHook
    public class ClientLaunchHook
extends java.lang.Object
implements LaunchHook
    This is the hook that gets called from the client bootstrap launcher. This is the "entrypoint" for the Vision Client. It's ClientContextImpl will last for its entire lifecycle, which will always be a single project but may involve logging in and out, and project updates.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setup​(LaunchStep startupStep, LaunchContext context)
      Called during the final "step" of the bootstrap launch process.
      void startup()
      Called after setup() to start the application.
      void staticSetup()
      This setup will be called first, before setup(), but only the first time in a given JVM.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ClientLaunchHook

        public ClientLaunchHook()

    • Method Detail

      • staticSetup

        public void staticSetup()
        Description copied from interface: LaunchHook
        This setup will be called first, before setup(), but only the first time in a given JVM.
        Specified by:
        staticSetup in interface LaunchHook

      • setup

        public void setup​(LaunchStep startupStep,
                  LaunchContext context)
           throws java.lang.Exception

        Called during the final "step" of the bootstrap launch process.

        • Parses the project that the bootstrap loaded downloaded or read in from the cache, and turns it into a bona-fide Project object.
        • Creates the ClientContextImpl which will last the entire lifetime of this Client instance. (but not the bootstrap loader/reloader instance.
        • Initializes the GatewayConnectionManager with a ClientGatewayConnection instance and the Gateway URLS found in launchContext.getGatewayAddresses()
        • Verifies that connection is valid.
        • Loads any Client-scope modules (but does not start them up yet.)
        • Attempts to authenticate if:
          1. This launch was from a retarget. OR
          2. The project if set to auto-login.

        Specified by:
        setup in interface LaunchHook
        Parameters:
        startupStep - The step being displayed. Use this step to affect the message, progress, indeterminate indication, etc of the loading splash screen.
        context - The launch context contains information gathered during the loading phase that should be relevant to the starting application.
        Throws:
        java.lang.Exception

      • startup

        public void startup()
             throws java.lang.Exception
        Description copied from interface: LaunchHook
        Called after setup() to start the application.
        Specified by:
        startup in interface LaunchHook
        Throws:
        java.lang.Exception