com.ibm.websphere.ant.tasks
Class StopApplication

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--com.ibm.websphere.ant.tasks.WsAdmin
                    |
                    +--com.ibm.websphere.ant.tasks.StopApplication
public class StopApplication
extends WsAdmin

The wsStopApp task enables you to stop an existing or newly installed application on a WebSphere Server or in a WebSphere Cell. This task is a subclass of the wsadmin task and shares many of the same attributes. This task is a wrapper for the ApplicationManager.stopApplication() command of the wsadmin tool. Refer to the wsadmin documentation for information on this operation. The structure of the wsStopApp task is shown below:

<wsStopApp wasHome="location of websphere installation" server="the name of the server containing the application to start" node="the name of the node containing the application to start" application="the name of the application to stop" properties="java properties file containing attributes to set in the JVM System properties" profile="a script file to be executed before the main command or file" conntype="specifies the type of connection to be used." host="the host to connect to" port="the port on the host to connect to" user="user ID to authenticate with" password="password to authenticate with"/> The wasHome attribute is optional and contains the location of the WebSphere Installation Directory.
The server attribute is optional and specifies the name of the server containing the application you wish to start
The node attribute is optional and specifies the name of the node containing the application you wish to start
The application attribute is required and specifies the name of the application you wish to stop
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 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

To use this task, add the following to your Ant build.xml <taskdef name="wsStopApplication" classname="com.ibm.websphere.ant.tasks.StopApplication"/>

Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
StopApplication()
          Constructor for StopApplication.
 
Method Summary
 void execute()
           
 void setApplication(java.lang.String application)
          Sets the ear.
 void setCommand(java.lang.String command)
          Disabled in this subclass
 void setLang(java.lang.String lang)
          Disabled in this subclass
 void setNode(java.lang.String node)
          Sets the name of the node containing the application.
 void setScript(java.lang.String script)
          Disabled in this subclass
 void setServer(java.lang.String server)
          Sets the name of the server containing the application.
 
Methods inherited from class com.ibm.websphere.ant.tasks.WsAdmin
createArg, setConntype, setFailonerror, setHost, setInstance, setPassword, setPort, setProfile, setProperties, setUser, setWasHome
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StopApplication

public StopApplication()
Constructor for StopApplication.

Method Detail

setCommand

public void setCommand(java.lang.String command)
Disabled in this subclass

Overrides:
setCommand in class WsAdmin
Parameters:
command - The command to set

setLang

public void setLang(java.lang.String lang)
Disabled in this subclass

Overrides:
setLang in class WsAdmin
Parameters:
lang - The lang to set

setScript

public void setScript(java.lang.String script)
Disabled in this subclass

Overrides:
setScript in class WsAdmin
Parameters:
script - The script to set

setApplication

public void setApplication(java.lang.String application)
Sets the ear.

setServer

public void setServer(java.lang.String server)
Sets the name of the server containing the application.

Parameters:
server - The name of the server

setNode

public void setNode(java.lang.String node)
Sets the name of the node containing the application.

Parameters:
node - The name of the node

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class WsAdmin
org.apache.tools.ant.BuildException
See Also:
Task#execute()

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.