Package com.zerog.ia.auto.project.actions

Class ExecuteAntScript

  • All Implemented Interfaces:
    DBHostable, GeneralAction, JEEHostable, OSHostable, Referenceable
    public final class ExecuteAntScript
extends Action
implements GeneralAction
    Executes scripts designed for the Apache Jakarta Project's Ant application. If this action is added to the installer, InstallAnywhere bundles Ant with the application.

    The path to the Ant script to run can be defined in two different ways, using the setExistingScript or the setBundleScript methods.

    • Constructor Detail

      • ExecuteAntScript

        public ExecuteAntScript()

    • Method Detail

      • getExitCodeVar

        public java.lang.String getExitCodeVar()
        The name of the variable to store exit codes.

      • setExitCodeVar

        public void setExitCodeVar​(java.lang.String antExitCodeVar)
        The name of the variable to store exit codes. Default: $EXECUTE_ANT_EXITCODE$.

      • getUseBuildProperties

        public boolean getUseBuildProperties()
        Whether to use the build properties file.

      • setUseBuildProperties

        public void setUseBuildProperties​(boolean use)
        Whether to use the build properties file.

      • getSpecifiedTarget

        public java.lang.String getSpecifiedTarget()
        The name of a specific build script target to run. This target will only be used if the useDefaultTarget property is set to false.

      • setSpecifiedTarget

        public void setSpecifiedTarget​(java.lang.String target)
        The name of a specific build script target to run. This target will only be used if the useDefaultTarget property is set to false.
        See Also:
        setUseDefaultTarget(boolean)

      • getExistingScript

        public java.lang.String getExistingScript()
        The path for an Ant build script file that either exists already or will be installed on the target system.
        See Also:
        setBundleScript(java.lang.String)

      • setExistingScript

        public void setExistingScript​(java.lang.String path)
        The path for an Ant build script file that either exists already or will be installed on the target system.
        See Also:
        getBundleScript()

      • getScriptFileType

        public AntScriptFileType getScriptFileType()
        The build script file type to use.

        Use AntScriptFileType.INSTALLED_FILE to specify a script file using the setBundleScript method, or use AntScriptFileType.EXISTING_FILE to specify a script file using the setExistingScript method.

      • getDependencies

        public java.util.Vector<DependencyProperty> getDependencies()
        The list of JAR and Zip file dependencies.

      • setDependencies

        public void setDependencies​(java.util.Vector<DependencyProperty> dependencies)
        Ant supports a number of additional tasks. These tasks typically require an external library separate from the core Ant tasks. Add to this list any JAR or Zip file dependency to include in the Ant classpath.

        Note: InstallAnywhere automatically adds dependencies required by the Execute Ant Script action.

      • getSubstituteIAVariables

        public boolean getSubstituteIAVariables()
        Whether to substitute the InstallAnywhere variables in build properties file.

      • setSubstituteIAVariables

        public void setSubstituteIAVariables​(boolean substitute)
        Whether to substitute the InstallAnywhere variables in build properties file.

      • getUseDefaultTarget

        public boolean getUseDefaultTarget()
        Whether to use the default build script target.

      • setUseDefaultTarget

        public void setUseDefaultTarget​(boolean useDefault)
        Whether to use the default build script target.

      • setShowPleaseWaitPanel

        public void setShowPleaseWaitPanel​(boolean show)
        Whether to show the "Please wait..." panel while installing the action.

      • getShowPleaseWaitPanel

        public boolean getShowPleaseWaitPanel()
        Whether to show the "Please wait..." panel while installing the action.

      • getShowIndeterminateDialog

        public boolean getShowIndeterminateDialog()
        Whether to show an indeterminate dialog during the execution of the script and to show the message you define calling setDialogLabel (Default: Executing ANT Script...).

      • setShowIndeterminateDialog

        public void setShowIndeterminateDialog​(boolean showIndeterminateDialog)
        Whether to show an indeterminate dialog during the execution of the script and to show the message you define calling setDialogLabel (Default: Executing ANT Script...).

      • setDialogLabel

        public void setDialogLabel​(java.lang.String label)
        The message to be displayed in the indeterminate dialog. (default: Executing ANT Script......)
        See Also:
        setShowIndeterminateDialog(boolean)

      • setBundleScript

        public void setBundleScript​(java.lang.String path)
        The path to the

      • getBundleScript

        public java.lang.String getBundleScript()
        The path to the

      • setBuildProperties

        public void setBuildProperties​(java.lang.String path)
        The path

      • getBuildProperties

        public java.lang.String getBuildProperties()
        The path