com.inductiveautomation.ignition.client.launch.steps

Class DownloadPyLibStep

java.lang.Object

com.inductiveautomation.ignition.client.launch.steps.AbstractLaunchStep

com.inductiveautomation.ignition.client.launch.steps.BaseStep

com.inductiveautomation.ignition.client.launch.steps.DownloadPyLibStep

All Implemented Interfaces:

LaunchStep

public class DownloadPyLibStep
extends BaseStep

Downloads the zipped third-party Python scripts from the gateway

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.client.launch.steps.AbstractLaunchStep

AbstractLaunchStep.LockedAction<T>

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.client.launch.LaunchStep

LaunchStep.StepState

Field Summary

Fields inherited from class com.inductiveautomation.ignition.client.launch.steps.BaseStep

context

Fields inherited from class com.inductiveautomation.ignition.client.launch.steps.AbstractLaunchStep

changeSupport

Constructor Summary

Constructors

Constructor and Description
DownloadPyLibStep(LaunchContextImpl context)

Method Summary

Modifier and Type	Method and Description
static void	download(AbstractLaunchStep step, java.lang.String gwUrl, java.io.File toFile, int attempt) Downloads 3rd party script modules from the gateway
java.lang.String	getDescriptionKey()
void	run()
static void	unzipPyLib(java.io.File pylibZip, java.io.File outputDir, LaunchStep step, boolean force) Unzips a pylib zip file to the gwcach/pylib folder and maintains the hash file

Methods inherited from class com.inductiveautomation.ignition.client.launch.steps.BaseStep

getDescription, getString, log, maybeWaitFor503, runLockedAction, waitFor

Methods inherited from class com.inductiveautomation.ignition.client.launch.steps.AbstractLaunchStep

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getMessage, getProgress, getState, isIndeterminate, newConnection, newConnection, removePropertyChangeListener, removePropertyChangeListener, runLockedAction, setIndeterminate, setMessage, setMessagef, setProgress, setState

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadPyLibStep

public DownloadPyLibStep(LaunchContextImpl context)

Method Detail

getDescriptionKey

public java.lang.String getDescriptionKey()

Specified by:

getDescriptionKey in class BaseStep

run

public void run()
         throws java.lang.Exception

Throws:

java.lang.Exception

download

public static void download(AbstractLaunchStep step,
                            java.lang.String gwUrl,
                            java.io.File toFile,
                            int attempt)
                     throws java.lang.Exception

Downloads 3rd party script modules from the gateway

Parameters:

step - The step originating the download. Nullable.

gwUrl - The URL of the gateway

toFile - The file to store the pylib.zip bytes in

attempt - What attempt is this? Used for messages for the step, if any.

Throws:

java.lang.Exception

unzipPyLib

public static void unzipPyLib(java.io.File pylibZip,
                              java.io.File outputDir,
                              LaunchStep step,
                              boolean force)
                       throws java.lang.Exception

Unzips a pylib zip file to the gwcach/pylib folder and maintains the hash file

Throws:

java.lang.Exception