Package com.inductiveautomation.ignition.client.launch.steps

Class BaseStep

java.lang.Object

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

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

All Implemented Interfaces:

LaunchStep

Direct Known Subclasses:

CacheStep, CheckJpmsRequirementsStep, CheckManifestStep, ConnectStep, DownloadJarsStep, DownloadPyLibStep, DownloadRuntimeStep, DownloadTranslationsStep, StartupStep, TestStep

public abstract class BaseStep
extends AbstractLaunchStep

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

Modifier and Type	Field	Description
protected LaunchContextImpl	context

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

changeSupport

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseStep(LaunchContextImpl context)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Describe this step's purpose
abstract String	getDescriptionKey()
protected String	getString(String key)	Abstraction to accommodate different methods of looking up bundle strings
void	log(String message, Object... args)	Abstraction to accommodate different logging methods
protected void	maybeWaitFor503(Exception ex)	Checks to see if the exception happens to be an HttpResponseException with responseCode==503.
protected void	restartClient()	Triggers a restart of the client.
protected <T> T	runLockedAction(AbstractLaunchStep.LockedAction<T> action)
protected void	waitFor(int secs)	Waits for a number of seconds, updating the progress bar appropriately

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

Methods inherited from interface com.inductiveautomation.ignition.client.launch.LaunchStep

run

Field Details

context

protected LaunchContextImpl context

Constructor Details

BaseStep

protected BaseStep(LaunchContextImpl context)

Method Details

runLockedAction

protected <T> T runLockedAction(AbstractLaunchStep.LockedAction<T> action)
                         throws Exception

Throws:

Exception

getDescription

public String getDescription()

Description copied from interface: LaunchStep

Describe this step's purpose

getString

protected String getString(String key)

Description copied from class: AbstractLaunchStep

Abstraction to accommodate different methods of looking up bundle strings

Specified by:

getString in class AbstractLaunchStep

log

public void log(String message,
 Object... args)

Description copied from class: AbstractLaunchStep

Abstraction to accommodate different logging methods

Specified by:

log in interface LaunchStep

Specified by:

log in class AbstractLaunchStep

getDescriptionKey

public abstract String getDescriptionKey()

waitFor

protected void waitFor(int secs)
                throws Exception

Waits for a number of seconds, updating the progress bar appropriately

Throws:

Exception

maybeWaitFor503

protected void maybeWaitFor503(Exception ex)
                        throws Exception

Checks to see if the exception happens to be an HttpResponseException with responseCode==503. If so, waits for 10 seconds while setting the message to the "ServiceUnavailable" message.

Throws:

Exception

restartClient

protected void restartClient()
                      throws LaunchException

Triggers a restart of the client. This should only be done in situations when the existing client cannot have whatever change applied and a new JVM must be created in order to apply whatever requirement is needed.

Throws:

LaunchException