Package com.inductiveautomation.ignition.client.launch

Class LaunchManifest

java.lang.Object

com.inductiveautomation.ignition.client.launch.LaunchManifest

public class LaunchManifest
extends java.lang.Object

Describes all of the jars, broken up by module, required for launching an application of a given scope.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LaunchManifest.Jar
static class	LaunchManifest.Module

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Integer	frameworkVersion
protected java.lang.String	javaExecutable
protected java.lang.String	jreVersion
protected java.util.Map<java.lang.String,LaunchManifest.Module>	modules
protected int	port
protected java.lang.String	scope
protected java.lang.String	thirdPartyScriptModulesHash
protected boolean	useSsl

Constructor Summary

Constructors

Constructor	Description
LaunchManifest(java.lang.String scope, java.lang.Integer frameworkVersion)
LaunchManifest(java.lang.String scope, java.lang.Integer frameworkVersion, boolean useSsl, int port)
LaunchManifest(java.lang.String scope, java.lang.String jreVersion, java.lang.Integer frameworkVersion)
LaunchManifest(java.lang.String scope, java.lang.String jreVersion, java.lang.Integer frameworkVersion, boolean useSsl, int port)

Method Summary

Modifier and Type	Method	Description
void	addModule(LaunchManifest.Module module)
boolean	equals(java.lang.Object o)
java.lang.Integer	getFrameworkVersion()
java.lang.String	getJavaExecutable()	Returns the java executable to use for launching clients.
java.lang.String	getJreVersion()
java.lang.Iterable<LaunchManifest.Module>	getModules()
int	getPort()
java.lang.String	getScope()
java.lang.String	getThirdPartyScriptModulesHash()	Note that this will return null if this client is a 7.7 client that has been targeted to a 7.6 or earlier Gateway
boolean	isEmpty()	Returns whether or not this manifest has any JAR files described in its modules
boolean	isUseSsl()
AbstractLaunchStep.LockedAction<LaunchManifest>	newDiffAction(LaunchContextImpl context)
static LaunchManifest	readFrom(java.io.InputStream is)
void	setJavaExecutable(java.lang.String javaExecutable)	Sets the java executable to use for launching clients.
void	storeTo(java.io.OutputStream outStream)	Writes this manifest to the stream, and closes it
void	storeTo(java.io.Writer w)	Stores to the stream and flushes but does not close it

Methods inherited from class java.lang.Object

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

Field Detail

scope

protected java.lang.String scope

frameworkVersion

protected java.lang.Integer frameworkVersion

modules

protected java.util.Map<java.lang.String,LaunchManifest.Module> modules

thirdPartyScriptModulesHash

protected java.lang.String thirdPartyScriptModulesHash

useSsl

protected boolean useSsl

port

protected int port

jreVersion

protected java.lang.String jreVersion

javaExecutable

protected java.lang.String javaExecutable

Constructor Detail

LaunchManifest

public LaunchManifest(java.lang.String scope,
                      java.lang.Integer frameworkVersion)

LaunchManifest

public LaunchManifest(java.lang.String scope,
                      java.lang.String jreVersion,
                      java.lang.Integer frameworkVersion)

LaunchManifest

public LaunchManifest(java.lang.String scope,
                      java.lang.Integer frameworkVersion,
                      boolean useSsl,
                      int port)

LaunchManifest

public LaunchManifest(java.lang.String scope,
                      java.lang.String jreVersion,
                      java.lang.Integer frameworkVersion,
                      boolean useSsl,
                      int port)

Method Detail

newDiffAction

public AbstractLaunchStep.LockedAction<LaunchManifest> newDiffAction(LaunchContextImpl context)

getScope

public java.lang.String getScope()

getJreVersion

public java.lang.String getJreVersion()

getFrameworkVersion

public java.lang.Integer getFrameworkVersion()

Returns:

the framework version (set in GatewayContextImpl).

addModule

public void addModule(LaunchManifest.Module module)

getModules

public java.lang.Iterable<LaunchManifest.Module> getModules()

isEmpty

public boolean isEmpty()

Returns whether or not this manifest has any JAR files described in its modules

setJavaExecutable

public void setJavaExecutable(java.lang.String javaExecutable)

Sets the java executable to use for launching clients.

getJavaExecutable

public java.lang.String getJavaExecutable()

Returns the java executable to use for launching clients.

isUseSsl

public boolean isUseSsl()

getPort

public int getPort()

getThirdPartyScriptModulesHash

public java.lang.String getThirdPartyScriptModulesHash()

Note that this will return null if this client is a 7.7 client that has been targeted to a 7.6 or earlier Gateway

storeTo

public void storeTo(java.io.OutputStream outStream)
             throws java.io.IOException

Writes this manifest to the stream, and closes it

Throws:

java.io.IOException

storeTo

public void storeTo(java.io.Writer w)
             throws java.io.IOException

Stores to the stream and flushes but does not close it

Throws:

java.io.IOException

readFrom

public static LaunchManifest readFrom(java.io.InputStream is)
                               throws java.io.IOException,
                                      org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object