Package com.inductiveautomation.ignition.client.launch

Class LaunchManifest

java.lang.Object
com.inductiveautomation.ignition.client.launch.LaunchManifest
public class LaunchManifest extends Object
Describes all of the jars, broken up by module, required for launching an application of a given scope.

  • Field Details

    • scope

      protected String scope

    • frameworkVersion

      protected Integer frameworkVersion

    • modules

      protected Map<String,LaunchManifest.Module> modules

    • thirdPartyScriptModulesHash

      protected String thirdPartyScriptModulesHash

    • useSsl

      protected boolean useSsl

    • port

      protected int port

    • jreVersion

      protected String jreVersion

    • javaExecutable

      protected String javaExecutable

    • useCondensedDialogFont

      protected boolean useCondensedDialogFont

    • jpmsModules

      protected List<JpmsModule> jpmsModules

    • userClassRejectList

      protected List<String> userClassRejectList

  • Constructor Details

    • LaunchManifest

      public LaunchManifest(String scope, Integer frameworkVersion)

    • LaunchManifest

      public LaunchManifest(String scope, String jreVersion, Integer frameworkVersion)

    • LaunchManifest

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

    • LaunchManifest

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

  • Method Details

    • newDiffAction

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

    • getScope

      public String getScope()

    • getJreVersion

      public String getJreVersion()

    • useCondensedDialogFont

      public boolean useCondensedDialogFont()
      Returns:
      true if the designer or client should use the condensed version of the Dialog font. This font is the Noto Sans Condensed font and is packaged in the JRE alongside the standard Noto Sans font.

    • setUseCondensedDialogFont

      public void setUseCondensedDialogFont(boolean useCondensedDialogFont)

    • getJpmsModules

      public List<JpmsModule> getJpmsModules()
      Returns the list of JpmsModules which have explicit opens/exports requirements due to Strong Encapsulation of the JVM internals.

    • setJpmsModules

      public void setJpmsModules(List<JpmsModule> jpmsModules)
      Sets the JpmsModules which are required for this client.
      Parameters:
      jpmsModules - a list of modules. Must not be null, but may be an empty list

    • getUserClassRejectList

      public List<String> getUserClassRejectList()

    • setUserClassRejectList

      public void setUserClassRejectList(List<String> userClassRejectList)

    • getFrameworkVersion

      public Integer getFrameworkVersion()
      Returns:
      the framework version (set in GatewayContextImpl).

    • addModule

      public void addModule(LaunchManifest.Module module)

    • getModules

      public 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(String javaExecutable)
      Sets the java executable to use for launching clients.

    • getJavaExecutable

      public String getJavaExecutable()
      Returns the java executable to use for launching clients.

    • isUseSsl

      public boolean isUseSsl()

    • getPort

      public int getPort()

    • getThirdPartyScriptModulesHash

      public 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(OutputStream outStream) throws IOException
      Writes this manifest to the stream, and closes it
      Throws:
      IOException

    • storeTo

      public void storeTo(Writer w) throws IOException
      Stores to the stream and flushes but does not close it
      Throws:
      IOException

    • readFrom

      public static LaunchManifest readFrom(InputStream is) throws IOException, SAXException, ParserConfigurationException
      Throws:
      IOException
      SAXException
      ParserConfigurationException

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object