Package com.inductiveautomation.ignition.client.launch

Class LaunchContextImpl

    • Constructor Detail

    • Method Detail

      • getBundle

        public java.util.ResourceBundle getBundle()

      • getCacheDir

        public java.io.File getCacheDir()
        Description copied from interface: LaunchContext
        The base of the cache dirs: %USER_HOME%/.ignition/cache/
        Specified by:
        getCacheDir in interface LaunchContext

      • getResourceDir

        public java.io.File getResourceDir()
        Description copied from interface: LaunchContext
        The base of the cached resources: %USER_HOME%/.ignition/cache/resources/
        Specified by:
        getResourceDir in interface LaunchContext

      • log

        public void log​(java.lang.String message,
                java.lang.Object... args)
        Description copied from interface: LaunchContext
        A shortcut for: 

         getLog().printf(message, args);
 getLog().println();
        Specified by:
        log in interface LaunchContext

      • getLog

        public java.io.PrintWriter getLog()
        Description copied from interface: LaunchContext
        A PrintWriter that steps can use to log their progress. Under normal conditions, this log is echoed to System.out. However, if an error ever occurs during the launch procedure, the entire contents of the log will be written to a launch crash file under the user's cache dir.
        Specified by:
        getLog in interface LaunchContext

      • getLogContents

        public java.lang.String getLogContents()

      • getTranslationDBLocation

        public java.io.File getTranslationDBLocation()
        Description copied from interface: LaunchContext
        Returns the location of the cached translation term db file. The file will be in the form of "XXX_e{d}_v{d}.dat". The "e{d}" is the edit version, the "v{d}" is the serialization version.
        Specified by:
        getTranslationDBLocation in interface LaunchContext

      • setTranDBLocation

        public void setTranDBLocation​(java.io.File tranDBLocation)

      • getLaunchManifest

        public LaunchManifest getLaunchManifest()
        Description copied from interface: LaunchContext
        This LaunchManifest is downloaded from the gateway during ConnectStep. It describes all JAR files that will we'll need to start up the app of this context, including their CRC32 checksums. Will only be set after ConnectStep finishes.
        Specified by:
        getLaunchManifest in interface LaunchContext

      • setLaunchManifest

        public void setLaunchManifest​(LaunchManifest launchManifest)

      • getDownloadRequiredManifest

        public LaunchManifest getDownloadRequiredManifest()

      • setDownloadRequiredManifest

        public void setDownloadRequiredManifest​(LaunchManifest downloadRequiredManifest)

      • getGwCacheDir

        public java.io.File getGwCacheDir()
        Description copied from interface: LaunchContext
        The actual cache directory for the specific gateway that we ended up connecting to. Only set after CacheStep runs. %USER_HOME%/.ignition/cache/gwHOST_HTTP_HTTPS_CONTEXT/Cx where "x" is the client ID that this JVM has claimed. Each JVM gets its own cache dir so that the they don't step on each other's toes when downloading/modifying jar files.
        Specified by:
        getGwCacheDir in interface LaunchContext

      • setGwCacheDir

        public void setGwCacheDir​(java.io.File gwCacheDir)

      • getMainClass

        public java.lang.String getMainClass()
        Description copied from interface: LaunchContext
        The name of the class that should be started during StartupStep
        Specified by:
        getMainClass in interface LaunchContext

      • setGatewayAddresses

        public void setGatewayAddresses​(java.util.List<GatewayAddress> gatewayAddresses)

      • updateGatewayAddressListCache

        public void updateGatewayAddressListCache​(java.util.List<GatewayAddress> addrs)
        Description copied from interface: LaunchContext
        Updates the cache with a list of gateway addresses that will be available for use next time this project is loaded. Should be update when the client receives notification that new cluster gateways have been added
        Specified by:
        updateGatewayAddressListCache in interface LaunchContext

      • setGatewayAddress

        public void setGatewayAddress​(GatewayAddress gatewayAddress)

      • getProjectName

        public java.lang.String getProjectName()
        Description copied from interface: LaunchContext
        The name of the project. May not be used in all scopes
        Specified by:
        getProjectName in interface LaunchContext

      • getPlatformEdition

        public java.lang.String getPlatformEdition()
        Description copied from interface: LaunchContext
        The platform edition. Standard edition = "", Edge edition = "edge"
        Specified by:
        getPlatformEdition in interface LaunchContext

      • getEdgeFlags

        public java.util.List<java.lang.String> getEdgeFlags()
        Description copied from interface: LaunchContext
        Currently should return an empty list if edition is not edge.
        Specified by:
        getEdgeFlags in interface LaunchContext

      • getProjectCacheSignatureFile

        public java.io.File getProjectCacheSignatureFile()
        This is the project snapshot that we can send to the gw to get changes.

      • updateProjectCache

        public void updateProjectCache​(LaunchContext.WritableProject project)
                        throws java.io.IOException
        Description copied from interface: LaunchContext
        This overload of updateProjectCache takes a WriteableProject, which lets the project be streamed. We cannot remove the old byte[] version, because of re-targeting compatibility.
        Specified by:
        updateProjectCache in interface LaunchContext
        Throws:
        java.io.IOException

      • getUserObject

        public byte[] getUserObject()
        Description copied from interface: LaunchContext
        Returns a serialized user object (if any) that was passed as part of a restart
        Specified by:
        getUserObject in interface LaunchContext

      • getAttribute

        public <T> T getAttribute​(java.lang.String key)
        Description copied from interface: LaunchContext
        A free-for-all map of objects that clients can use to communicate between launches. Beware that one should only store types is this map that are loaded by the system classloader - not custom objects. Any custom objects should be serialized to a byte[] first.
        Specified by:
        getAttribute in interface LaunchContext

      • getAttribute

        public <T> T getAttribute​(java.lang.String key,
                          T defaultValue)
        Specified by:
        getAttribute in interface LaunchContext

      • setAttribute

        public void setAttribute​(java.lang.String key,
                         java.lang.Object value)
        Specified by:
        setAttribute in interface LaunchContext

      • getAttributes

        public java.util.Map<java.lang.String,​java.lang.Object> getAttributes()
        Description copied from interface: LaunchContext
        Retrieves the raw attribute map
        Specified by:
        getAttributes in interface LaunchContext