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, CheckManifestStep, ConnectStep, DownloadJarsStep, DownloadProjectStep, DownloadPyLibStep, 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 and Description
protected LaunchContextImpl	context
protected java.awt.image.BufferedImage	icon

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

changeSupport

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseStep(LaunchContextImpl context, java.lang.String iconName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Describe this step's purpose
abstract java.lang.String	getDescriptionKey()
java.awt.Image	getIcon() A 24x24 icon that represents this step
protected java.lang.String	getString(java.lang.String key) Abstraction to accommodate different methods of looking up bundle strings
protected void	log(java.lang.String message, java.lang.Object... args) Abstraction to accommodate different logging methods
protected void	maybeWaitFor503(java.lang.Exception ex) Checks to see if the exception happens to be an HttpResponseException with responseCode==503.
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 Detail

icon

protected java.awt.image.BufferedImage icon

context

protected LaunchContextImpl context

Constructor Detail

BaseStep

protected BaseStep(LaunchContextImpl context,
                   java.lang.String iconName)

Method Detail

runLockedAction

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

Throws:

java.lang.Exception

getIcon

public java.awt.Image getIcon()

Description copied from interface: LaunchStep

A 24x24 icon that represents this step

getDescription

public java.lang.String getDescription()

Description copied from interface: LaunchStep

Describe this step's purpose

getString

protected java.lang.String getString(java.lang.String key)

Description copied from class: AbstractLaunchStep

Abstraction to accommodate different methods of looking up bundle strings

Specified by:

getString in class AbstractLaunchStep

log

protected void log(java.lang.String message,
                   java.lang.Object... args)

Description copied from class: AbstractLaunchStep

Abstraction to accommodate different logging methods

Specified by:

log in class AbstractLaunchStep

getDescriptionKey

public abstract java.lang.String getDescriptionKey()

waitFor

protected void waitFor(int secs)
                throws java.lang.Exception

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

Throws:

java.lang.Exception

maybeWaitFor503

protected void maybeWaitFor503(java.lang.Exception ex)
                        throws java.lang.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:

java.lang.Exception