org.apache.tools.ant.taskdefs.optional.starteam
Class StarTeamTask
public abstract class StarTeamTask
Common super class for all StarTeam tasks.
At this level of the hierarchy we are concerned only with obtaining a
connection to the StarTeam server. The subclass TreeBasedTask
,
also abstract defines the tree-walking behavior common to many subtasks.
protected abstract View | createSnapshotView(View rawview) - Derived classes must override
createSnapshotView
defining the kind of configured view appropriate to its task.
|
protected void | disconnectFromServer() - disconnects from the StarTeam server.
|
String | getPassword() - returns the password used for login
|
String | getProjectname() - returns the name of the StarTeam project to be acted on
|
protected Server | getServer() - returns a reference to the server which may be used for informational
purposes by subclasses.
|
String | getServername() - returns the name of the StarTeamServer
|
String | getServerport() - returns the port number of the StarTeam connection
|
protected TypeNames | getTypeNames() - returns a list of TypeNames known to the server.
|
String | getURL() - a convenience method which returns the whole StarTeam
connection information as a single URL string of
|
String | getUserName() - returns the name of the StarTeam user
|
protected String | getUserName(int userID) - Returns the name of the user with the supplied ID or a blank string
if user not found.
|
protected String | getViewURL() - returns an URL string useful for interacting with many StarTeamFinder
methods.
|
String | getViewname() - returns the name of the StarTeam view to be acted on
|
protected View | openView() - All subclasses will call on this method to open the view needed for
processing.
|
void | setPassword(String password) - set the password to be used for login; required.
|
void | setProjectname(String projectname) - set the name of the StarTeam project to be acted on;
required if URL is not set.
|
void | setServername(String servername) - Set the name of StarTeamServer;
required if URL is not set.
|
void | setServerport(String serverport) - set the port number of the StarTeam connection;
required if URL is not set.
|
void | setURL(String url) - Set the server name, server port,
project name and project folder in one shot;
optional, but the server connection must be specified somehow.
|
void | setUserName(String userName) - set the name of the StarTeam user, needed for the connection
|
void | setViewname(String viewname) - set the name of the StarTeam view to be acted on;
required if URL is not set.
|
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
createSnapshotView
protected abstract View createSnapshotView(View rawview)
throws BuildException
Derived classes must override createSnapshotView
defining the kind of configured view appropriate to its task.
rawview
- the unconfigured View
- the snapshot
View
appropriately configured.
disconnectFromServer
protected final void disconnectFromServer()
disconnects from the StarTeam server. Should be called from the
finally clause of every StarTeamTask-based execute method.
getPassword
public final String getPassword()
returns the password used for login
- the password used for login
getProjectname
public final String getProjectname()
returns the name of the StarTeam project to be acted on
- the name of the StarTeam project to be acted on
getServer
protected final Server getServer()
returns a reference to the server which may be used for informational
purposes by subclasses.
- a reference to the server
getServername
public final String getServername()
returns the name of the StarTeamServer
- the name of the StarTeam server
getServerport
public final String getServerport()
returns the port number of the StarTeam connection
- the port number of the StarTeam connection
getTypeNames
protected final TypeNames getTypeNames()
returns a list of TypeNames known to the server.
- a reference to the server's TypeNames
getURL
public final String getURL()
a convenience method which returns the whole StarTeam
connection information as a single URL string of
- a
String
of the form
"servername:portnum/project/view"
getUserName
public final String getUserName()
returns the name of the StarTeam user
- the name of the StarTeam user
getUserName
protected final String getUserName(int userID)
Returns the name of the user with the supplied ID or a blank string
if user not found.
- the name of the user with ID userID
getViewURL
protected final String getViewURL()
returns an URL string useful for interacting with many StarTeamFinder
methods.
- the URL string for this task.
getViewname
public final String getViewname()
returns the name of the StarTeam view to be acted on
- the name of the StarTeam view to be acted on
openView
protected View openView()
throws BuildException
All subclasses will call on this method to open the view needed for
processing. This method also saves a reference to the
Server
that may be accessed for information at various
points in the process.
- the
View
that will be used for processing.
setPassword
public final void setPassword(String password)
set the password to be used for login; required.
password
- the password to be used for login
setProjectname
public final void setProjectname(String projectname)
set the name of the StarTeam project to be acted on;
required if URL is not set.
projectname
- the name of the StarTeam project to be acted on
setServername
public final void setServername(String servername)
Set the name of StarTeamServer;
required if URL is not set.
servername
- a String
value
setServerport
public final void setServerport(String serverport)
set the port number of the StarTeam connection;
required if URL is not set.
serverport
- port number to be set
setURL
public final void setURL(String url)
Set the server name, server port,
project name and project folder in one shot;
optional, but the server connection must be specified somehow.
url
- a String
of the form
"servername:portnum/project/view"
setUserName
public final void setUserName(String userName)
set the name of the StarTeam user, needed for the connection
userName
- name of the user to be logged in
setViewname
public final void setViewname(String viewname)
set the name of the StarTeam view to be acted on;
required if URL is not set.
viewname
- the name of the StarTeam view to be acted on
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.