Please find attached the patch file for starteam.html. This document has
been update to include descriptions for the following enhancements:
33507 - Need way to have files retrieved via the <stcheckout> task be
read-only
39926 - StarTeam tasks to identify themselves as Ant + version number to
the StarTeam Server
40995 - StarTeam checkout support Promotion State
40946 - stcheckout ignores convertEOL when used with "asofdate"
46326 - Use Starteam MPX Cache Agent for Checkouts
46327 - Use cache credentials (optional) for logging in rather than
having scripts with hardcoded passwords
Regards,
John Ballment | Applications Analyst | Asciano Limited
Level 4, 2-12 Macquarie Street Parramatta NSW 2150 | PO Locked Bag 90
Parramatta NSW 2124
Tel: 02 9893 2618 | Fax: 02 9893 2698 | Mob: 0418 740 871
Email: john_ballm...@pacificnational.com.au | www.asciano.com.au
__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4448 (20090922) __________
The message was checked by ESET NOD32 Antivirus.
http://www.eset.com
Index: docs/manual/OptionalTasks/starteam.html
===================================================================
--- docs/manual/OptionalTasks/starteam.html (revision 750354)
+++ docs/manual/OptionalTasks/starteam.html (working copy)
@@ -27,6 +27,7 @@
<li><a href="#stcheckin">STCheckin</a></li>
<li><a href="#stlabel">STLabel</a></li>
<li><a href="#stlist">STList</a></li>
+ <li><a href="#stencryptepassword">STEncryptPassword</a></li>
<li><a href="#starteam"><i>StarTeam (deprecated) </i></a></li>
</ul>
@@ -101,6 +102,31 @@
<td valign="top">viewname</td>
<td valign="top">The name of the view in the StarTeam project on which to
operate.</td>
</tr>
+ <tr>
+ <td valign="top">logOnProvider</td>
+ <td valign="top">The fully qualified class name of a class that implements
the StarTeamLogOnProvider. The default provider is
"org.apache.tools.ant.taskdefs.optional.starteam.StarTeamDefaultLogOn" which
implements a log on using the username and password attributes. Other providers
include StarTeamAutoLogOn which uses existing cached credentials to connect to
the server. The username and password attributes do not need to be defined and
will not be used if they are defined. And StarTeamEncryptLogOn the username and
passwordFile attributes to extract the encrypted password using the Borland SDK
Utilities' EncryptPassword.jar package. This package needs to be on the ANT
classpath. The Borland SDK Utilities can be downloaded from <a
href="http://support.borland.com/community/index.php?t=getfile&id=177&";>here</a></td>
+ <td align="center" valign="top">no</td>
+ </tr>
+ <tr>
+ <td valign="top">passwordFile</td>
+ <td valign="top">The absolute path and filename of the encrypted password
file to set the connection password.</td>
+ <td align="center" valign="top">no</td>
+ </tr>
+ <tr>
+ <td valign="top">encryptionAlgorithm</td>
+ <td valign="top">Enables an encrypted connection to the StarTeam Server,
assuming that it support encryption. Valid values are RC2_CBC, RC2_CFB,
RC2_ECB and RC4.</td>
+ <td align="center" valign="top">no</td>
+ </tr>
+ <tr>
+ <td valign="top">useCA</td>
+ <td valign="top">Enables support for StarTeam MPX broker and StarTeam MPX
Cache Agent. Expected to be either host:port or autolocate.</td>
+ <td align="center" valign="top">no</td>
+ </tr>
+ <tr>
+ <td valign="top">useCompression</td>
+ <td valign="top">Enables support for data compression. Valid values are
true or false.</td>
+ <td align="center" valign="top">no</td>
+ </tr>
</table>
@@ -167,7 +193,7 @@
<tr>
<td valign="top">label</td>
<td valign="top">Check out files as of this label. The label must exist
in starteam or an exception will be thrown.</td>
- <td align="center" valign="center" rowspan="2">Either or neither, but not
both, may be specified. Neither <code>locked</code> or <code>unlocked</code>
may be true if either <code>label</code> or <code>asofdate</code> is
specified.</td>
+ <td align="center" valign="center" rowspan="3">Either or none, but no
combinations, may be specified. Neither <code>locked</code> or
<code>unlocked</code> may be true if either <code>label</code> or
<code>asofdate</code> or <code>PromotionState</code> is specified.</td>
</tr>
<tr>
<td valign="top">asofdate</td>
@@ -180,6 +206,10 @@
will be thrown. <em>Since Ant 1.6.</em></td>
</tr>
<tr>
+ <td valign="top">promotionState</td>
+ <td valign="top">Check out files as of this Promotion State. The
Promotion State must exist in starteam or an exception will be thrown.</td>
+ </tr>
+ <tr>
<td valign="top">asofdateformat</td>
<td valign="top">java.util.SimpleDateFormat compatible string used
to parse the <code>asofdate</code> attribute. <em>Since Ant
@@ -234,6 +264,17 @@
the server. </td>
<td align="center" valign="top">no</td>
</tr>
+ <td valign="top">markUnlockedFilesReadOnly</td>
+ <td valign="top">If true, files that have a Status of Unlocked will be
marked as Read-Only on check out.
+ If false, files will not be marked as Read-Only on check out.
+ If project, then the StarTeam Project's property is used to determine
whether files should be marked as Read-Only on check out.</td>
+ <td align="center" valign="top">no</td>
+ </tr>
+ </tr>
+ <td valign="top">optimizeForSlowConnections</td>
+ <td valign="top">If true, StarTeam will try to send only the deltas of the
changes, where the delta is smaller than the whole file.</td>
+ <td align="center" valign="top">no</td>
+ </tr>
</table>
@@ -268,9 +309,51 @@
<br></br>
<pre>
<stcheckout URL="STARTEAM:49201/Aproject/AView"
+
logonprovider="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamAutoLogOn"
+ rootlocalfolder="C:\dev\buildtest\co"
+ forced="true"
+ />
+</pre>
+If you have your credentials cached from a previous session you can accomplish
the same thing as the previous example, using the URL attribute.
+<br></br>
+<pre>
+ <stcheckout URL="STARTEAM:49201/Aproject/AView"
+
logonprovider="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamEncryptLogOn"
username="auser"
+ passwordfile="C:\dev\auser.pwd"
+ rootlocalfolder="C:\dev\buildtest\co"
+ forced="true"
+ />
+</pre>
+Another way to log in without a hardcoded password is to use an encrypted
password file.
+<br></br>
+<pre>
+ <stcheckout URL="STARTEAM:49201/Aproject/AView"
+ username="auser"
password="secret"
+ useCA="STARTEAM2:5201"
rootlocalfolder="C:\dev\buildtest\co"
+ forced="true"
+ />
+</pre>
+This example enable checking out via the StarTeam MPX Cache Agent running on
host machine and port number.
+<br></br>
+<pre>
+ <stcheckout URL="STARTEAM:49201/Aproject/AView"
+ username="auser"
+ password="secret"
+ useCA=autolocate
+ rootlocalfolder="C:\dev\buildtest\co"
+ forced="true"
+ />
+</pre>
+The StarTeam MPX Cache Agent can also be automatically located using
autolocate.
+<br></br>
+<pre>
+ <stcheckout URL="STARTEAM:49201/Aproject/AView"
+ username="auser"
+ password="secret"
+ rootlocalfolder="C:\dev\buildtest\co"
rootstarteamfolder="\Dev"
excludes="*.bak *.old"
label="v2.6.001"
@@ -791,7 +874,51 @@
</pre>
<hr></hr>
+<a name="stlist">
+<h2>STEncryptPassword</h2></a>
+<h3>Description</h3>
+
+Creates an encrypted version of the user's password and stores it in a file.
This task wraps the Borland SDK Utilities' EncryptPassword so that it can be
used directly from within ANT.
+
+<h3>Parameters</h3>
+See also <A href="#common-params">the required common StarTeam
parameters</A>.<br></br>
+<table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">username</td>
+ <td valign="top">The username of the account used to log in to the
StarTeam server.</td>
+ <td align="center" valign="top">yes</td>
+ </tr>
+ <tr>
+ <td valign="top">password</td>
+ <td valign="top">The password of the account used to log in to the
StarTeam server.</td>
+ <td align="center" valign="top">yes</td>
+ </tr>
+ <tr>
+ <td valign="top">passwordFile</td>
+ <td valign="top">The absolute path and filename of the encrypted password
file to set the connection password.</td>
+ <td align="center" valign="top">yes</td>
+ </tr>
+</table>
+<h3>Examples</h3>
+
+<pre>
+
+ <stencryptpassword passwordfile="./project/auser.pwd"
+ username="auser"
+ password="secret"
+ />
+</pre>
+
+
+
+<hr></hr>
+
<a name="starteam">
<h2>Starteam</h2></a>
<h3><i>Deprecated</i></h3>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@ant.apache.org
For additional commands, e-mail: dev-h...@ant.apache.org
