Package com.zerog.ia.auto.project

Class Project

  • All Implemented Interfaces:
    Referenceable
    public final class Project
extends InstallableObject
    The central piece of an InstallAnywhere installer project.

    The Project class allows the customization of the installer settings and also contains the methods to access the pre-install, install, post-install, pre-uninstall and post-uninstall trees of the installation.

    This class should not be instantiated using a construtor, the methods in the ProjectAutomation class should be used instead.
    See Also:
    com.zerog.ia.auto.ProjectAutomation

    • Constructor Detail

      • Project

        public Project()

    • Method Detail

      • getProjectDescription

        public ProjectDescription getProjectDescription()
        The object that defines the project description settings, like the product name and version.
        See Also:
        ProjectDescription

      • getPreInstallActions

        public java.util.Vector getPreInstallActions()
        The Vector of actions and panels to be executed during the pre-install phase of the installation.

      • setPreInstallActions

        public void setPreInstallActions​(java.util.Vector v)

      • getPostInstallActions

        public java.util.Vector getPostInstallActions()
        The Vector of actions and panels to be executed during the post-install phase of the installation.

      • setPostInstallActions

        public void setPostInstallActions​(java.util.Vector v)

      • setCustomInstallSet

        public void setCustomInstallSet​(InstallSet installSet)
        The custom InstallSet that allows the end user to customize the installer. This InstallSet is available to end user during installation via the ChooseInstallSetPanel, which should be configured to enable customizable installations.
        See Also:
        ChooseInstallSetPanel

      • getCustomInstallSet

        public InstallSet getCustomInstallSet()
        The custom InstallSet that allows the end user to customize the installer. This InstallSet is available to end user during installation via the ChooseInstallSetPanel, which should be configured to enable customizable installations.
        See Also:
        ChooseInstallSetPanel

      • getDefaultInstallSetIndex

        public int getDefaultInstallSetIndex()
        The index of the default InstallSet. The index is based on the getInstallSets() Vector.

      • setDefaultInstallSetIndex

        public void setDefaultInstallSetIndex​(int defaultSetIndex)
        The index of the default InstallSet. The index is based on the getInstallSets() Vector.

      • setNotUpdateGlobalRegistry

        public void setNotUpdateGlobalRegistry​(boolean notUpdateGlobalRegistry)
        Whether or not to prevent the installer from updating the InstallAnywhere product registry. By default, InstallAnywhere installers update the product registry when they are run.

      • getNotUpdateGlobalRegistry

        public boolean getNotUpdateGlobalRegistry()
        Whether or not to prevent the installer from updating the InstallAnywhere product registry. By default, InstallAnywhere installers update the product registry when they are run.

      • getInstallFolder

        public InstallFolder getInstallFolder()
        The main installation folder, where the application files are installed in the target machine. The InstallFolder object can also be used as a destination folder for the OSHostDestinationFolder.

        By default the installation folder targets "Programs Folder\$PRODUCT_NAME$". The default installation folder can be configured individually for each platform.

        See Also:
        InstallFolder

      • getShortcutFolder

        public ShortcutFolder getShortcutFolder()
        The folder where to install the shortcuts/links/aliases. The ShortcutFolder object can also be used as a destination folder for the OSHostDestinationFolder.

        The default shortcut folder can be configured individually for each platform.

        See Also:
        ShortcutFolder

      • setRulesFailedMessage

        public void setRulesFailedMessage​(java.lang.String rulesFailedMessage)
        The message to be displayed when installer rules fail.

      • getRulesFailedMessage

        public java.lang.String getRulesFailedMessage()
        The message to be displayed when installer rules fail.

      • getMergeModuleAdvertisedVariables

        public java.util.Vector<MergeModuleAdvertisedVariable> getMergeModuleAdvertisedVariables()
        The variables that the merge module needs from the parent installer or will be passed back from the merge module to a parent installer.

      • setMergeModuleAdvertisedVariables

        public void setMergeModuleAdvertisedVariables​(java.util.Vector<MergeModuleAdvertisedVariable> variables)
        The variables that the merge module needs from the parent installer or will be passed back from the merge module to a parent installer.

      • setPreUninstallActions

        public void setPreUninstallActions​(java.util.Vector preUninstallActions)

      • getPreUninstallActions

        public java.util.Vector getPreUninstallActions()
        The Vector of actions and panels to be executed during the pre-uninstall phase of the installation.

      • setPostUninstallActions

        public void setPostUninstallActions​(java.util.Vector postUninstallActions)

      • getPostUninstallActions

        public java.util.Vector getPostUninstallActions()
        The Vector of actions and panels to be executed during the post-uninstall phase of the installation.

      • getVariableExclusions

        public java.util.Vector<VariableExclusion> getVariableExclusions()
        The Vector of variables that should be encrypted or excluded from the response file and install log.

        Encrypting the variable values can make the installer more secure. The values of encrypted variables are stored only in their encrypted form. InstallAnywhere decrypts encrypted variables when the installer needs to retrieve or set their values, but records only the encrypted values in installer output, such as install scripts, install logs, response files, and installer debug output.

      • setVariableExclusions

        public void setVariableExclusions​(java.util.Vector<VariableExclusion> variableExclusions)
        The Vector of variables that should be encrypted or excluded from the response file and install log.

        Encrypting the variable values can make the installer more secure. The values of encrypted variables are stored only in their encrypted form. InstallAnywhere decrypts encrypted variables when the installer needs to retrieve or set their values, but records only the encrypted values in installer output, such as install scripts, install logs, response files, and installer debug output.

      • getResponseFileEnabled

        public boolean getResponseFileEnabled()
        Whether or not the installer should generate a response file.

      • setResponseFileEnabled

        public void setResponseFileEnabled​(boolean responseFileEnabled)
        Whether or not the installer should generate a response file.

      • getUninstallCategories

        public java.util.Vector getUninstallCategories()

      • setUninstallCategories

        public void setUninstallCategories​(java.util.Vector uninstallCategories)

      • getCategoriesTable

        public java.util.Vector getCategoriesTable()

      • setCategoriesTable

        public void setCategoriesTable​(java.util.Vector categoriesTable)

      • getManageExpressionID

        public java.lang.String getManageExpressionID()

      • setManageExpressionID

        public void setManageExpressionID​(java.lang.String manageExpressionID)

      • getFileExtensionID

        public java.lang.String getFileExtensionID()

      • setFileExtensionID

        public void setFileExtensionID​(java.lang.String fileExtensionID)

      • getSavedExpressions

        public com.zerog.ia.designer.manageexpressions.ManageExpressions getSavedExpressions()

      • setSavedExpressions

        public void setSavedExpressions​(com.zerog.ia.designer.manageexpressions.ManageExpressions savedExpressions)

      • getFileExtensions

        public com.zerog.ia.designer.manageexpressions.fileextension.FileExtensions getFileExtensions()

      • setFileExtensions

        public void setFileExtensions​(com.zerog.ia.designer.manageexpressions.fileextension.FileExtensions fileExtensions)

      • getSkipPreInstallLog

        public boolean getSkipPreInstallLog()

      • setSkipPreInstallLog

        public void setSkipPreInstallLog​(boolean skipPreInstallLog)

      • getDateFormatChange

        public boolean getDateFormatChange()

      • setDateFormatChange

        public void setDateFormatChange​(boolean dateFormatChange)

      • getUnixPermissionLog

        public java.lang.String getUnixPermissionLog()

      • setUnixPermissionLog

        public void setUnixPermissionLog​(java.lang.String unixPermissionLog)

      • getEstimatedSize

        public java.lang.String getEstimatedSize()

      • setEstimatedSize

        public void setEstimatedSize​(java.lang.String estimationSize)

      • isSecurityEnabled

        public boolean isSecurityEnabled()

      • setSecurityEnabled

        public void setSecurityEnabled​(boolean securityEnabled)

      • isBuildOnWindowsPlatform

        public boolean isBuildOnWindowsPlatform()

      • setBuildOnWindowsPlatform

        public void setBuildOnWindowsPlatform​(boolean buildOnWindowsPlatform)

      • isApplyInstallerFileAttributes

        public boolean isApplyInstallerFileAttributes()

      • setApplyInstallerFileAttributes

        public void setApplyInstallerFileAttributes​(boolean applyInstallerFileAttributes)

      • isApplyLauncherFileAttributes

        public boolean isApplyLauncherFileAttributes()

      • setApplyLauncherFileAttributes

        public void setApplyLauncherFileAttributes​(boolean applyLauncherFileAttributes)

      • getOSHost

        public OSHost getOSHost()
        The root object for the actions to be executed during the install phase of the installation targeting the operating system.

      • setOSHost

        public void setOSHost​(OSHost OSHost)
        The root object for the actions to be executed during the install phase of the installation targeting the operating system.

      • getDBHosts

        public java.util.Vector<DBHost> getDBHosts()
        The root object for the actions to be executed during the install phase of the installation targeting a specific database.

      • getJEEHosts

        public java.util.Vector<JEEHost> getJEEHosts()
        The root object for the actions to be executed during the install phase of the installation targeting a specific JEE application server.

      • getInstallSets

        public java.util.Vector<InstallSet> getInstallSets()
        The Vector of install sets the installer should provide to the end user.

      • getFeatures

        public java.util.Vector<Feature> getFeatures()
        The Vector of features the installer should provide to the end user.

      • getComponents

        public java.util.Vector<Component> getComponents()
        The Vector of components the installer should provide to the end user.

      • getJavaSettings

        public JavaSettings getJavaSettings()
        The classpath settings, bundled Java VM installation behavior, VM search criterias and other Java specific settings.

      • setTagsInInstallPiece

        public void setTagsInInstallPiece​(java.util.Vector<Tag> TagsInInstallPiece)
        The Vector of tags to be associated with the Project.
        Overrides:
        setTagsInInstallPiece in class InstallableObject

      • getTags

        public java.util.Vector<Tag> getTags()
        The Vector of tags to be associated with the Project.

      • setTags

        public void setTags​(java.util.Vector<Tag> Tags)
        The Vector of tags to be associated with the Project.

      • getInstallerUI

        public InstallerUI getInstallerUI()
        The installer look and feel, billboards and other UI settings.

      • getRollbackEnabledProject

        public boolean getRollbackEnabledProject()
        Enable rollback for the installer

      • setRollbackEnabledProject

        public void setRollbackEnabledProject​(boolean RollbackEnabledProject)
        Enable rollback for the installer

      • getBuildConfigurations

        public java.util.Vector<BuildConfiguration> getBuildConfigurations()
        The Vector of build settings that define the target platforms and types of distribution to build the installer.

        Currently InstallAnywhere only supports one BuildConfiguration per installer, which means that only the first item of the Vector will be considered when building the installer.

      • setBuildConfigurations

        public void setBuildConfigurations​(java.util.Vector<BuildConfiguration> BuildConfigurations)
        The Vector of build settings that define the target platforms and types of distribution to build the installer.

        Currently InstallAnywhere only supports one BuildConfiguration per installer, which means that only the first item of the Vector will be considered when building the installer.

      • getApplianceBuildConfigurations

        public java.util.Vector<ApplianceBuildConfiguration> getApplianceBuildConfigurations()
        The Vector of appliance build configurations

      • setApplianceBuildConfigurations

        public void setApplianceBuildConfigurations​(java.util.Vector<ApplianceBuildConfiguration> ApplianceBuildConfigurations)
        The Vector of appliance build configurations

      • getInstanceDefinition

        public InstanceDefinition getInstanceDefinition()
        Specify instance management settings for the installer

      • setInstanceDefinition

        public void setInstanceDefinition​(InstanceDefinition InstanceDefinition)
        Specify instance management settings for the installer

      • getMaintModeConfigs

        public MaintenanceDefinition getMaintModeConfigs()
        Specify maintenance mode settings for the installer

      • setMaintModeConfigs

        public void setMaintModeConfigs​(MaintenanceDefinition MaintModeConfigs)
        Specify maintenance mode settings for the installer

      • getEnableWOW64Install

        public boolean getEnableWOW64Install()
        Enable WOW 64 for Install Setting for installer

      • setEnableWOW64Install

        public void setEnableWOW64Install​(boolean EnableWOW64Install)
        Enable WOW 64 for Install Setting for installer

      • getEnableWOW64Uninstall

        public boolean getEnableWOW64Uninstall()
        Enable WOW 64 for Uninstall Setting for installer

      • setEnableWOW64Uninstall

        public void setEnableWOW64Uninstall​(boolean EnableWOW64Uninstall)
        Enable WOW 64 for Uninstall Setting for installer

      • getEnableWOW64Services

        public boolean getEnableWOW64Services()
        Enable WOW 64 for Services Setting for installer

      • setEnableWOW64Services

        public void setEnableWOW64Services​(boolean EnableWOW64Services)
        Enable WOW 64 for Services Setting for installer

      • getLauncher64BitLaunchSetting

        public int getLauncher64BitLaunchSetting()
        Specify Launcher JVM Selection Settings for Installer. Set this to
        0: for use 64 bit jvm, if not 32 bit

      • setLauncher64BitLaunchSetting

        public void setLauncher64BitLaunchSetting​(int Launcher64BitLaunchSetting)
        Specify Launcher JVM Selection Settings for Installer. Set this to
        0: for use 64 bit jvm, if not 32 bit

      • getCodeSignOnMacEnabled

        public boolean getCodeSignOnMacEnabled()
        Enable Code Signing for MacOSX Installer

      • setCodeSignOnMacEnabled

        public void setCodeSignOnMacEnabled​(boolean CodeSignOnMacEnabled)
        Enable Code Signing for MacOSX Installer

      • getPkcs12Certificate

        public java.lang.String getPkcs12Certificate()
        Location of the PKCS#12 Certificate Keystore

      • setPkcs12Certificate

        public void setPkcs12Certificate​(java.lang.String Pkcs12Certificate)
        Location of the PKCS#12 Certificate Keystore

      • getKeystorePassword

        public java.lang.String getKeystorePassword()
        Password to the PKCS#12 Keystore

      • setKeystorePassword

        public void setKeystorePassword​(java.lang.String KeystorePassword)
        Password to the PKCS#12 Keystore

      • getOldStyleInstallersEnabled

        public boolean getOldStyleInstallersEnabled()
        Build the old style installers for mac (10.4 and below)

      • setOldStyleInstallersEnabled

        public void setOldStyleInstallersEnabled​(boolean OldStyleInstallersEnabled)
        Build the old style installers for mac (10.4 and below)

      • getWindowsPlatform

        public WindowsPlatform getWindowsPlatform()
        The Windows platform specific settings.

      • getUnixPlatform

        public UnixPlatform getUnixPlatform()
        The Unix platform specific settings.

      • getMacOSPlatform

        public MacOSPlatform getMacOSPlatform()
        The Mac OS X platform specific settings.

      • getI5OSPlatform

        public I5OSPlatform getI5OSPlatform()
        The System i (i5/OS) platform specific settings.

      • getHelpSettings

        public HelpSettings getHelpSettings()
        The installer help settings.

      • getFileSettings

        public FileSettings getFileSettings()
        The general file settings.

      • getLogSettings

        public LogSettings getLogSettings()
        The log settings.

      • getExternalResourceBundles

        public java.util.Vector<ExternalResourceBundle> getExternalResourceBundles()
        The vector of external resource bundles

      • setExternalResourceBundles

        public void setExternalResourceBundles​(java.util.Vector<ExternalResourceBundle> ExternalResourceBundles)
        The vector of external resource bundles

      • getSortLocaleKeys

        public boolean getSortLocaleKeys()
        sort locale keys - whether

      • setSortLocaleKeys

        public void setSortLocaleKeys​(boolean SortLocaleKeys)
        sort locale keys - whether

      • getRemoveUnreferencedLocaleKeys

        public boolean getRemoveUnreferencedLocaleKeys()
        remove unreferenced locale keys - whether

      • setRemoveUnreferencedLocaleKeys

        public void setRemoveUnreferencedLocaleKeys​(boolean RemoveUnreferencedLocaleKeys)
        remove unreferenced locale keys - whether

      • getAutoCleanComponentsOnBuild

        public boolean getAutoCleanComponentsOnBuild()
        Whether or not to auto-clean the unused components when saving the project.

      • setAutoCleanComponentsOnBuild

        public void setAutoCleanComponentsOnBuild​(boolean AutoCleanComponentsOnBuild)
        Whether or not to auto-clean the unused components when saving the project.

      • getRestartForRollback

        public boolean getRestartForRollback()
        Determines if Windows should reboot in case of a rollback

      • setRestartForRollback

        public void setRestartForRollback​(boolean RestartForRollback)
        Determines if Windows should reboot in case of a rollback

      • getMultipleLaunch

        public boolean getMultipleLaunch()
        Prevents multiple launches of an installer at a specified time

      • setMultipleLaunch

        public void setMultipleLaunch​(boolean MultipleLaunch)
        Prevents multiple launches of an installer at a specified time

      • getCancelButtonEnabledDuringInstall

        public boolean getCancelButtonEnabledDuringInstall()
        Cancel button settings when install is in progress.[false to disable/true to enable]

      • setCancelButtonEnabledDuringInstall

        public void setCancelButtonEnabledDuringInstall​(boolean CancelButtonEnabledDuringInstall)
        Cancel button settings when install is in progress.[false to disable/true to enable]

      • getAIXEntry

        public AIXEntry getAIXEntry()
        AIX Entry setting when Installation is in progress

      • setAIXEntry

        public void setAIXEntry​(AIXEntry AIXEntry)
        AIX Entry setting when Installation is in progress

      • getBuildTimeVariables

        public java.util.Vector<ProjectBuildTimeVariableAtom> getBuildTimeVariables()
        Vector containing build time variables

      • setBuildTimeVariables

        public void setBuildTimeVariables​(java.util.Vector<ProjectBuildTimeVariableAtom> BuildTimeVariables)
        Vector containing build time variables

      • getBuildVariablePropertyFileAttached

        public boolean getBuildVariablePropertyFileAttached()
        To store build time variable property file path

      • setBuildVariablePropertyFileAttached

        public void setBuildVariablePropertyFileAttached​(boolean BuildVariablePropertyFileAttached)
        To store build time variable property file path

      • getAdditionalClasspaths

        public java.util.Vector<java.lang.String> getAdditionalClasspaths()

      • setAdditionalClasspaths

        public void setAdditionalClasspaths​(java.util.Vector<java.lang.String> AdditionalClasspaths)

      • getSoftwareIdentificationTag

        public SoftwareIdentificationTag getSoftwareIdentificationTag()
        The software identification tag entry

      • setSoftwareIdentificationTag

        public void setSoftwareIdentificationTag​(SoftwareIdentificationTag SoftwareIdentificationTag)
        The software identification tag entry

      • getSwidTagIncluded

        public boolean getSwidTagIncluded()
        Whether the software identification tag need to be included

      • setSwidTagIncluded

        public void setSwidTagIncluded​(boolean SwidTagIncluded)
        Whether the software identification tag need to be included

      • getWinCodeSign

        public WindowsCodeSign getWinCodeSign()
        Details for Windows executable to be signed

      • setWinCodeSign

        public void setWinCodeSign​(WindowsCodeSign WinCodeSign)
        Details for Windows executable to be signed

      • getUpgradeSettings

        public UpgradeSettings getUpgradeSettings()
        Upgrade Settings for the Project

      • setUpgradeSettings

        public void setUpgradeSettings​(UpgradeSettings UpgradeSettings)
        Upgrade Settings for the Project

      • getInstallerUpdateSettings

        public InstallerUpdateSettings getInstallerUpdateSettings()
        Installer update Settings for the Project

      • setInstallerUpdateSettings

        public void setInstallerUpdateSettings​(InstallerUpdateSettings InstallerUpdateSettings)
        Installer update Settings for the Project

      • getTomcatServerNamesList

        public java.util.ArrayList<java.lang.String> getTomcatServerNamesList()
        A list containing names of all Tomcat server hosts

      • setTomcatServerNamesList

        public void setTomcatServerNamesList​(java.util.ArrayList<java.lang.String> TomcatServerNamesList)
        A list containing names of all Tomcat server hosts

      • getInstallerIconName

        public java.lang.String getInstallerIconName()
        Name of the Installer Executable Icon path. Provide only file name excluding path.

      • setInstallerIconName

        public void setInstallerIconName​(java.lang.String InstallerIconName)
        Name of the Installer Executable Icon path. Provide only file name excluding path.

      • getInstallerIconPath

        public java.lang.String getInstallerIconPath()
        Path of the Installer Executable Icon path. Provide only path excluding file name.

      • setInstallerIconPath

        public void setInstallerIconPath​(java.lang.String InstallerIconPath)
        Path of the Installer Executable Icon path. Provide only path excluding file name.

      • getInstallerIconImagePath

        public java.lang.String getInstallerIconImagePath()
        Path of the Installer Title Image. Provide only path excluding file name.

      • setInstallerIconImagePath

        public void setInstallerIconImagePath​(java.lang.String InstallerIconImagePath)
        Path of the Installer Title Image. Provide only path excluding file name.

      • getInstallerIconImageName

        public java.lang.String getInstallerIconImageName()
        Name of the Installer Title Image. Provide only file name excluding path.

      • setInstallerIconImageName

        public void setInstallerIconImageName​(java.lang.String InstallerIconImageName)
        Name of the Installer Title Image. Provide only file name excluding path.

      • getBillboardTimerEnabled

        public boolean getBillboardTimerEnabled()
        Determine if BillBoards should change during installation

      • setBillboardTimerEnabled

        public void setBillboardTimerEnabled​(boolean BillboardTimerEnabled)
        Determine if BillBoards should change during installation

      • getBillboardIntervals

        public double getBillboardIntervals()
        Interval of changing billboard

      • setBillboardIntervals

        public void setBillboardIntervals​(double BillboardIntervals)
        Interval of changing billboard