com.ibm.websphere.ant.tasks
Class InstallApplication
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.Task
-
- com.ibm.websphere.ant.tasks.WsAdmin
-
- com.ibm.websphere.ant.tasks.InstallApplication
-
- All Implemented Interfaces:
- java.lang.Cloneable
public class InstallApplication extends WsAdmin
The wsInstallApp task enables you to install a new application into a WebSphere Server or Cell. This task is a subclass of the wsadmin task and shares many of the same attributes. This task is a wrapper for the AdminApp.install() command of the wsadmin tool. Refer to the wsadmin documentation for information on the valid options available during application installation. The structure of the wsInstallApp task is shown below:
The ear attribute is required and contains the path of the ear that you wish to install.
The options attribute is optional and contains the set of options you wish to pass to the installation process.
The properties attribute is optional and it contains a java properties file containing attributes to set in the JVM System properties
The profile attribute is optional and it contains a script file to be executed before the main command or file
The profileName attribute is optional and it contains the name of the server profile to be used
The conntype attribute is optional and it specifies the type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, JMS, and NONE. NONE means that no server connection is made. The host attribute is optional and only specified if the conntype is specified. It contains the hostname of the machine to connect to
The port attribute is optional and only specified if the conntype is specified. It contains the port on the host to connect to
The user attribute is optional and contains the user ID to authenticate with
The password attribute is optional and contains the password to authenticate with
The failonerror attribute is optional. When this is specified the build will fail if any exception is thrown. The default is false.
To use this task, add the following to your Ant build.xml
-
-
Constructor Summary
Constructors Constructor and Description InstallApplication()
Constructor for InstallApplication.
-
Method Summary
Methods Modifier and Type Method and Description org.apache.tools.ant.types.Commandline.Argument
createArg()
Creates a nested arg element.void
execute()
void
setCommand(java.lang.String command)
Disabled in this subclassvoid
setEar(java.lang.String application)
Sets the ear.void
setLang(java.lang.String lang)
Disabled in this subclassvoid
setOptions(java.lang.String options)
Sets the options.void
setScript(java.lang.String script)
Disabled in this subclass-
Methods inherited from class com.ibm.websphere.ant.tasks.WsAdmin
createJvmarg, isDebug, setConntype, setDebug, setFailonerror, setFileEncoding, setHost, setJvmMaxMemory, setPassword, setPort, setProfile, setProfileName, setProperties, setUser, setWasHome
-
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
-
-
-
-
Constructor Detail
-
InstallApplication
public InstallApplication()
Constructor for InstallApplication.
-
-
Method Detail
-
setCommand
public void setCommand(java.lang.String command)
Disabled in this subclass- Overrides:
setCommand
in classWsAdmin
- Parameters:
command
- The command to set
-
setLang
public void setLang(java.lang.String lang)
Disabled in this subclass
-
setScript
public void setScript(java.lang.String script)
Disabled in this subclass
-
setEar
public void setEar(java.lang.String application)
Sets the ear.- Parameters:
ear
- The ear to set
-
execute
public void execute() throws org.apache.tools.ant.BuildException
-
setOptions
public void setOptions(java.lang.String options)
Sets the options.- Parameters:
options
- The options to set
-
createArg
public org.apache.tools.ant.types.Commandline.Argument createArg()
Description copied from class:WsAdmin
Creates a nested arg element.- Overrides:
createArg
in classWsAdmin
- See Also:
WsAdmin.createArg()
-
-