Class ExecuteCommand
- java.lang.Object
-
- com.zerog.ia.auto.project.ProjectObject
-
- com.zerog.ia.auto.project.InstallableObject
-
- com.zerog.ia.auto.project.actions.Action
-
- com.zerog.ia.auto.project.actions.ExecuteCommand
-
- All Implemented Interfaces:
DBHostable
,GeneralAction
,JEEHostable
,OSHostable
,Referenceable
- Direct Known Subclasses:
ExecuteUninstaller
,UninstallISSoftware
public class ExecuteCommand extends Action implements GeneralAction
Runs executables from the target system's command line.
-
-
Constructor Summary
Constructors Constructor Description ExecuteCommand()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCommandLine()
The syntax to run the executable, containing the name of the executable (command) or the full path to the executable.java.lang.String
getDialogLabel()
The message to be displayed in the indeterminate dialog.java.lang.String
getExitCodeVar()
The name of the variable to store exit codes.boolean
getPleaseWaitConsole()
Whether to show Please Wait panel in console mode during the execution of the scriptboolean
getShowIndeterminateDialog()
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel.boolean
getShowPleaseWaitPanel()
Whether to show a "Please wait..." panel while executing the action.java.lang.String
getStderrVar()
The name of the variable to store process's stderr.java.lang.String
getStdoutVar()
The name of the variable to store process's stdout.boolean
getSuppressConsoleWindow()
Whether to suppress the console dialog on Windows machines.java.lang.String
getTitle()
The title that describes the function of the script or batch file.boolean
getWaitForProcess()
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.boolean
isSubstituteUnknownVariable()
Whether to substitute unknown variables or not.void
setCommandLine(java.lang.String commandLine)
The syntax to run the executable.void
setDialogLabel(java.lang.String label)
The message to be displayed in the indeterminate dialog.void
setExitCodeVar(java.lang.String exitCodeVar)
The name of the variable to store exit codes.void
setPleaseWaitConsole(boolean show)
Whether to show Please Wait panel in console mode during the execution of the scriptvoid
setShowIndeterminateDialog(boolean show)
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel (default: Executing...).void
setShowPleaseWaitPanel(boolean show)
Whether to show a "Please wait..." panel while executing the action.void
setStderrVar(java.lang.String stderrVar)
The name of the variable to store process's stderr.void
setStdoutVar(java.lang.String stdoutVar)
The name of the variable to store process's stdout.void
setSubstituteUnknownVariable(boolean substituteUnknownVariable)
Whether to substitute unknown variables or not.void
setSuppressConsoleWindow(boolean suppress)
Whether to suppress the console dialog on Windows machines.void
setTitle(java.lang.String title)
The title that describes the function of the script or batch file.void
setWaitForProcess(boolean wait)
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.-
Methods inherited from class com.zerog.ia.auto.project.InstallableObject
getBelongsToUninstallPhase, getRollbackEnabledCancel, getRollbackEnabledError, getRuleExpression, getRules, getRulesLogicalOperation, getTagsInInstallPiece, setBelongsToUninstallPhase, setRollbackEnabledCancel, setRollbackEnabledError, setRuleExpression, setRulesLogicalOperation, setTagsInInstallPiece
-
Methods inherited from class com.zerog.ia.auto.project.ProjectObject
equals, getReferenceID, hashCode, setReferenceID
-
-
-
-
Method Detail
-
getStdoutVar
public java.lang.String getStdoutVar()
The name of the variable to store process's stdout.
-
setStdoutVar
public void setStdoutVar(java.lang.String stdoutVar)
The name of the variable to store process's stdout. Default: $EXECUTE_STDOUT$.
-
getStderrVar
public java.lang.String getStderrVar()
The name of the variable to store process's stderr.
-
setStderrVar
public void setStderrVar(java.lang.String stderrVar)
The name of the variable to store process's stderr. Default: $EXECUTE_STDERR$.
-
getExitCodeVar
public java.lang.String getExitCodeVar()
The name of the variable to store exit codes.
-
setExitCodeVar
public void setExitCodeVar(java.lang.String exitCodeVar)
The name of the variable to store exit codes. Default: $EXECUTE_EXITCODE$.
-
setWaitForProcess
public void setWaitForProcess(boolean wait)
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.- Parameters:
wait
- Suspend installation.
-
getWaitForProcess
public boolean getWaitForProcess()
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.- Returns:
- Suspend installation.
-
setShowPleaseWaitPanel
public void setShowPleaseWaitPanel(boolean show)
Whether to show a "Please wait..." panel while executing the action.
-
getShowPleaseWaitPanel
public boolean getShowPleaseWaitPanel()
Whether to show a "Please wait..." panel while executing the action.
-
setSuppressConsoleWindow
public void setSuppressConsoleWindow(boolean suppress)
Whether to suppress the console dialog on Windows machines.- Parameters:
suppress
- Suppress the console dialog
-
getSuppressConsoleWindow
public boolean getSuppressConsoleWindow()
Whether to suppress the console dialog on Windows machines.- Returns:
- Suppress the console dialog
-
setShowIndeterminateDialog
public void setShowIndeterminateDialog(boolean show)
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel (default: Executing...).
-
getShowIndeterminateDialog
public boolean getShowIndeterminateDialog()
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel.
-
setPleaseWaitConsole
public void setPleaseWaitConsole(boolean show)
Whether to show Please Wait panel in console mode during the execution of the script
-
getPleaseWaitConsole
public boolean getPleaseWaitConsole()
Whether to show Please Wait panel in console mode during the execution of the script
-
setDialogLabel
public void setDialogLabel(java.lang.String label)
The message to be displayed in the indeterminate dialog. (default: Executing...)- See Also:
setShowIndeterminateDialog(boolean)
-
getDialogLabel
public java.lang.String getDialogLabel()
The message to be displayed in the indeterminate dialog.- See Also:
setShowIndeterminateDialog(boolean)
-
setCommandLine
public void setCommandLine(java.lang.String commandLine)
The syntax to run the executable. Type the name of the executable (command) or the full path to the executable. Any text following the command is passed as arguments to the executable. Single arguments that contain spaces must be quoted; otherwise, they are passed as multiple arguments. (To pass actual quotation marks as part of an argument, escape them with a backslashes character - for example \".) All elements in Command Line may be represented either as literal values or by InstallAnywhere variables.- Parameters:
commandLine
- The syntax to run the executable
-
getCommandLine
public java.lang.String getCommandLine()
The syntax to run the executable, containing the name of the executable (command) or the full path to the executable. Any text following the command is passed as arguments to the executable.- Returns:
- The syntax to run the executable
-
isSubstituteUnknownVariable
public boolean isSubstituteUnknownVariable()
Whether to substitute unknown variables or not.
-
setSubstituteUnknownVariable
public void setSubstituteUnknownVariable(boolean substituteUnknownVariable)
Whether to substitute unknown variables or not.
-
getTitle
public java.lang.String getTitle()
The title that describes the function of the script or batch file.
-
setTitle
public void setTitle(java.lang.String title)
The title that describes the function of the script or batch file.
-
-