Class JavaSettings


  • public final class JavaSettings
    extends java.lang.Object
    The Java VM specific settings, like the classpath, heap size and additional VM arguments.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAdditionalArguments()
      The additional command-line arguments to be passed to the installer's virtual machine.
      java.util.Vector<ProjectObject> getClasspath()
      The list of classpath settings for the project's LaunchAnywhere actions.
      java.lang.String getEncryptionAlgorithm()
      The algorithm name to use with JCE encryption.
      boolean getEncryptionUseJCE()
      Whether or not to support Java Cryptology Extension (JCE) encryption.
      InstallBundledVMOption getInstallBundledVM()
      The behavior to use when the installer decides whether or not to install the bundled VM.
      java.lang.String getInstallerValidVMList()
      The criterias that define what VMs are valid for the installer.
      java.lang.String getMaxHeapSize()
      The maximum heap size in byte for the installer's virtual machine.
      java.lang.String getMinHeapSize()
      The minimum heap size in byte for the installer's virtual machine.
      boolean getOnlyInstallBundledVMIfOneNotFoundInSystem()
      Whether or not to only install the bundled Java VM if a compatible one is not found in the file system.
      java.lang.String getStderrRedirect()
      The file path where to store the installer's stderr output.
      java.lang.String getStdoutRedirect()
      The file path where to store the installer's stdout output.
      boolean getUninstallJRE()
      Whether or not to remove the bundled VM when uninstalling.
      int getVMInstallFolderId()
      The magic folder ID where to install the VM.
      java.lang.String getVMInstallFolderName()
      The sub folder where to install the VM.
      VMListSearchBehavior getVmListSearchBehavior()
      The installer behavior when finding a valid Java VM for the installed application.
      java.lang.String getVMSearchSpecificValidVMList()
      The specific Java VM list to be used when searching a VM for the installed application.
      void setAdditionalArguments​(java.lang.String AdditionalArguments)
      The additional command-line arguments to be passed to the installer's virtual machine.
      void setEncryptionAlgorithm​(java.lang.String algorithm)
      The algorithm name to use with JCE encryption.
      void setEncryptionUseJCE​(boolean useJCEEncryption)
      Whether or not to support Java Cryptology Extension (JCE) encryption.
      void setInstallBundledVM​(InstallBundledVMOption option)
      The behavior to use when the installer decides whether or not to install the bundled VM.
      void setInstallerValidVMList​(java.lang.String InstallerValidVMList)
      The criterias that define what VMs are valid for the installer.
      void setMaxHeapSize​(java.lang.String MaxHeapSize)
      The maximum heap size in byte for the installer's virtual machine.
      void setMinHeapSize​(java.lang.String MinHeapSize)
      The minimum heap size in byte for the installer's virtual machine.
      void setOnlyInstallBundledVMIfOneNotFoundInSystem​(boolean onlyInstallBundledVMIfOneNotFoundInSystem)
      Whether or not to only install the bundled Java VM if a compatible one is not found in the file system.
      void setStderrRedirect​(java.lang.String StderrRedirect)
      The file path where to store the installer's stderr output.
      void setStdoutRedirect​(java.lang.String StdoutRedirect)
      The file path where to store the installer's stdout output.
      void setUninstallJRE​(boolean uninstall)
      Whether or not to remove the bundled VM when uninstalling.
      void setVMInstallFolderId​(int magicFolderId)
      The magic folder ID where to install the VM.
      void setVMInstallFolderName​(java.lang.String directoryName)
      The sub folder where to install the VM.
      void setVmListSearchBehavior​(VMListSearchBehavior vmListSearchBehavior)
      The installer behavior when finding a valid Java VM for the installed application.
      void setVMSearchSpecificValidVMList​(java.lang.String validVmList)
      The specific Java VM list to be used when searching a VM for the installed application.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getClasspath

        public java.util.Vector<ProjectObject> getClasspath()
        The list of classpath settings for the project's LaunchAnywhere actions.

        The items of this list can be fine-tuned (reordered) to best fit the application's requirements. Classpath items can also be added or removed.

        The valid classpath items are file resources actions, like the InstallFile, InstallDirectory and InstallZipFile actions. Those actions should also be assigned to the install tree of the installations.

      • getInstallBundledVM

        public InstallBundledVMOption getInstallBundledVM()
        The behavior to use when the installer decides whether or not to install the bundled VM.
      • setInstallBundledVM

        public void setInstallBundledVM​(InstallBundledVMOption option)
        The behavior to use when the installer decides whether or not to install the bundled VM.
      • getVMInstallFolderId

        public int getVMInstallFolderId()
        The magic folder ID where to install the VM. It can be a MagicFolder id or the InstallFolder id.
        See Also:
        MagicFolder, Project.getInstallFolder()
      • setVMInstallFolderId

        public void setVMInstallFolderId​(int magicFolderId)
        The magic folder ID where to install the VM. It can be a MagicFolder id or the InstallFolder id.
        See Also:
        MagicFolder, Project.getInstallFolder()
      • getVMInstallFolderName

        public java.lang.String getVMInstallFolderName()
        The sub folder where to install the VM. The sub folder is relative to the magic folder defined in vmInstallFolderId property.
        See Also:
        getVMInstallFolderId()
      • setVMInstallFolderName

        public void setVMInstallFolderName​(java.lang.String directoryName)
        The sub folder where to install the VM. The sub folder is relative to the magic folder defined in vmInstallFolderId property.
        See Also:
        setVMInstallFolderId(int)
      • getUninstallJRE

        public boolean getUninstallJRE()
        Whether or not to remove the bundled VM when uninstalling.
      • setUninstallJRE

        public void setUninstallJRE​(boolean uninstall)
        Whether or not to remove the bundled VM when uninstalling.
      • getEncryptionUseJCE

        public boolean getEncryptionUseJCE()
        Whether or not to support Java Cryptology Extension (JCE) encryption.

        InstallAnywhere includes basic encryption to obfuscate encrypted elements. Checking Use JCE Encryption substitutes the JVM's JCE encryption for InstallAnywhere's basic encryption. If JCE encryption is not available (as in pre-1.4 JVMs), InstallAnywhere defaults to its own encryption method.
      • setEncryptionUseJCE

        public void setEncryptionUseJCE​(boolean useJCEEncryption)
        Whether or not to support Java Cryptology Extension (JCE) encryption.

        InstallAnywhere includes basic encryption to obfuscate encrypted elements. Checking Use JCE Encryption substitutes the JVM's JCE encryption for InstallAnywhere's basic encryption. If JCE encryption is not available (as in pre-1.4 JVMs), InstallAnywhere defaults to its own encryption method.
      • getEncryptionAlgorithm

        public java.lang.String getEncryptionAlgorithm()
        The algorithm name to use with JCE encryption.

        Using JCE encryption, along with a FIPS-compliant JCE library and supported algorithm, you can ensure your installers are FIPS 140-2 compliant. Please consult the InstallAnywhere manual for more information.
        See Also:
        setEncryptionUseJCE(boolean)
      • setEncryptionAlgorithm

        public void setEncryptionAlgorithm​(java.lang.String algorithm)
        The algorithm name to use with JCE encryption.

        Using JCE encryption, along with a FIPS-compliant JCE library and supported algorithm, you can ensure your installers are FIPS 140-2 compliant. Please consult the InstallAnywhere manual for more information.
        See Also:
        getEncryptionUseJCE()
      • getOnlyInstallBundledVMIfOneNotFoundInSystem

        public boolean getOnlyInstallBundledVMIfOneNotFoundInSystem()
        Whether or not to only install the bundled Java VM if a compatible one is not found in the file system.
      • setOnlyInstallBundledVMIfOneNotFoundInSystem

        public void setOnlyInstallBundledVMIfOneNotFoundInSystem​(boolean onlyInstallBundledVMIfOneNotFoundInSystem)
        Whether or not to only install the bundled Java VM if a compatible one is not found in the file system.
      • getVMSearchSpecificValidVMList

        public java.lang.String getVMSearchSpecificValidVMList()
        The specific Java VM list to be used when searching a VM for the installed application. You can specify criteria for the virtual machine type (JRE or JDK), vendor and version. Please consult the InstallAnywhere manual for more information about how to specify a VM validation criteria.
      • setVMSearchSpecificValidVMList

        public void setVMSearchSpecificValidVMList​(java.lang.String validVmList)
        The specific Java VM list to be used when searching a VM for the installed application. You can specify criteria for the virtual machine type (JRE or JDK), vendor and version. Please consult the InstallAnywhere manual for more information about how to specify a VM validation criteria.
      • getVmListSearchBehavior

        public VMListSearchBehavior getVmListSearchBehavior()
        The installer behavior when finding a valid Java VM for the installed application.

        The valid behaviors are USE_INSTALLER_VM_LIST, USE_LAUNCHER_VM_LIST and SPECIFIC_VM_LIST. Default to USE_INSTALLER_VM_LIST.

      • setVmListSearchBehavior

        public void setVmListSearchBehavior​(VMListSearchBehavior vmListSearchBehavior)
        The installer behavior when finding a valid Java VM for the installed application.

        The valid behaviors are USE_INSTALLER_VM_LIST, USE_LAUNCHER_VM_LIST and SPECIFIC_VM_LIST. Default to USE_INSTALLER_VM_LIST.

      • getInstallerValidVMList

        public java.lang.String getInstallerValidVMList()
        The criterias that define what VMs are valid for the installer. Please consult the InstallAnywhere manual for more informatoin about how to define VM validation criteria.
      • setInstallerValidVMList

        public void setInstallerValidVMList​(java.lang.String InstallerValidVMList)
        The criterias that define what VMs are valid for the installer. Please consult the InstallAnywhere manual for more informatoin about how to define VM validation criteria.
      • getMinHeapSize

        public java.lang.String getMinHeapSize()
        The minimum heap size in byte for the installer's virtual machine.
      • setMinHeapSize

        public void setMinHeapSize​(java.lang.String MinHeapSize)
        The minimum heap size in byte for the installer's virtual machine.
      • getMaxHeapSize

        public java.lang.String getMaxHeapSize()
        The maximum heap size in byte for the installer's virtual machine.
      • setMaxHeapSize

        public void setMaxHeapSize​(java.lang.String MaxHeapSize)
        The maximum heap size in byte for the installer's virtual machine.
      • getStderrRedirect

        public java.lang.String getStderrRedirect()
        The file path where to store the installer's stderr output. Use 'console' to send output to a console window.
      • setStderrRedirect

        public void setStderrRedirect​(java.lang.String StderrRedirect)
        The file path where to store the installer's stderr output. Use 'console' to send output to a console window.
      • getStdoutRedirect

        public java.lang.String getStdoutRedirect()
        The file path where to store the installer's stdout output. Use 'console' to send output to a console window.
      • setStdoutRedirect

        public void setStdoutRedirect​(java.lang.String StdoutRedirect)
        The file path where to store the installer's stdout output. Use 'console' to send output to a console window.
      • getAdditionalArguments

        public java.lang.String getAdditionalArguments()
        The additional command-line arguments to be passed to the installer's virtual machine.
      • setAdditionalArguments

        public void setAdditionalArguments​(java.lang.String AdditionalArguments)
        The additional command-line arguments to be passed to the installer's virtual machine.