IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.ant.tasks
Class ListApplications

java.lang.Object
  extended by Task
      extended by com.ibm.websphere.ant.tasks.WsAdmin
          extended by com.ibm.websphere.ant.tasks.ListApplications

public class ListApplications
extends WsAdmin

The wsListApps task lists all the applications installed on 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.list() command of the wsadmin tool. Refer to the wsadmin documentation for information on this operation. The structure of the wsListApps task is shown below:

<wsListApps wasHome="location of websphere installation" 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"/> The wasHome attribute is optional and contains the location of the WebSphere Installation Directory.
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

<taskdef name="wsListApps" classname="com.ibm.websphere.ant.tasks.ListApplications"/>


Constructor Summary
ListApplications()
          Constructor for ListApplications
 
Method Summary
 void execute()
           
 void setCommand(java.lang.String command)
          Disabled in this subclass
 void setLang(java.lang.String lang)
          Disabled in this subclass
 void setScript(java.lang.String script)
          Disabled in this subclass
 
Methods inherited from class com.ibm.websphere.ant.tasks.WsAdmin
createArg, createJvmarg, isDebug, setConntype, setDebug, setFailonerror, setFileEncoding, setHost, setJvmMaxMemory, setPassword, setPort, setProfile, setProfileName, setProperties, setUser, setWasHome
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ListApplications

public ListApplications()
Constructor for ListApplications

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

execute

public void execute()
             throws BuildException
Overrides:
execute in class WsAdmin
Throws:
BuildException
See Also:
Task#execute()

IBM WebSphere Application ServerTM
Release 8