com.ibm.websphere.ant.tasks

Class StopApplication

  • All Implemented Interfaces:
    java.lang.Cloneable

    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" profileName="the profile name of the desired server" 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 failonerror="true | false"/> 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 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 <taskdef name="wsStopApp" classname="com.ibm.websphere.ant.tasks.StopApplication"/>

    • Field Summary

      • Fields inherited from class org.apache.tools.ant.Task

        target, taskName, taskType, wrapper

      • Fields inherited from class org.apache.tools.ant.ProjectComponent

        description, location, project

    • Constructor Summary

      Constructors 
      Constructor and Description
      StopApplication()
      Constructor for StopApplication.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      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 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

      • Methods inherited from class org.apache.tools.ant.ProjectComponent

        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

      • Methods inherited from class java.lang.Object

        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.
        Parameters:
        ear - The ear to set

      • 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
        Throws:
        org.apache.tools.ant.BuildException
        See Also:
        Task.execute()
IBM WebSphere Application ServerTM
Release 8.5