ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sco...@apache.org
Subject cvs commit: ant/docs/manual/OptionalTasks ftp.html
Date Sat, 14 May 2005 13:14:15 GMT
scohen      2005/05/14 06:14:14

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/net
                        FTPConfigurator.java FTP.java
               docs/manual/OptionalTasks ftp.html
  Log:
  change name of attribute from systemKeyConfig to systemTypeKey as a more intuitive name
and check in
  documentation for revised FTP task.
  
  Revision  Changes    Path
  1.2       +4 -4      ant/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPConfigurator.java
  
  Index: FTPConfigurator.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPConfigurator.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- FTPConfigurator.java	13 May 2005 10:26:20 -0000	1.1
  +++ FTPConfigurator.java	14 May 2005 13:14:14 -0000	1.2
  @@ -38,11 +38,11 @@
        */
       static FTPClient configure(FTPClient client, FTP task) {
           FTPClientConfig config;
  -        String systemKeyConfig = task.getSystemKeyConfig(); 
  -        if (systemKeyConfig != null) {
  -            config = new FTPClientConfig(systemKeyConfig);
  +        String systemTypeKey = task.getSystemTypeKey(); 
  +        if (systemTypeKey != null) {
  +            config = new FTPClientConfig(systemTypeKey);
               task.log("custom config: system key = " 
  -                    + systemKeyConfig, Project.MSG_VERBOSE);
  +                    + systemTypeKey, Project.MSG_VERBOSE);
           } else {
               config = new FTPClientConfig();
           }
  
  
  
  1.71      +7 -7      ant/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java
  
  Index: FTP.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java,v
  retrieving revision 1.70
  retrieving revision 1.71
  diff -u -r1.70 -r1.71
  --- FTP.java	13 May 2005 10:34:40 -0000	1.70
  +++ FTP.java	14 May 2005 13:14:14 -0000	1.71
  @@ -109,7 +109,7 @@
       private boolean preserveLastModified = false;
       private String chmod = null;
       private String umask = null;
  -    private String systemKeyConfig = null;
  +    private String systemTypeKey = null;
       private String defaultDateFormatConfig = null;
       private String recentDateFormatConfig = null;
       private String serverLanguageCodeConfig = null;
  @@ -1257,11 +1257,11 @@
       /**
        * Method for setting <code>FTPClientConfig</code> remote system key.
        * 
  -     * @param systemKeyConfig
  +     * @param systemTypeKey
        * @see org.apache.commons.net.ftp.FTPClientConfig
        */
  -    public void setSystemKeyConfig(String systemKey) {
  -        this.systemKeyConfig = systemKey;
  +    public void setSystemTypeKey(String systemKey) {
  +        this.systemTypeKey = systemKey;
           configurationHasBeenSet();
       }
   
  @@ -1322,10 +1322,10 @@
   
   
       /**
  -     * @return Returns the systemKeyConfig.
  +     * @return Returns the systemTypeKey.
        */
  -    String getSystemKeyConfig() {
  -        return systemKeyConfig;
  +    String getSystemTypeKey() {
  +        return systemTypeKey;
       }
       /**
        * @return Returns the defaultDateFormatConfig.
  
  
  
  1.32      +171 -6    ant/docs/manual/OptionalTasks/ftp.html
  
  Index: ftp.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/OptionalTasks/ftp.html,v
  retrieving revision 1.31
  retrieving revision 1.32
  diff -u -r1.31 -r1.32
  --- ftp.html	29 Apr 2005 18:58:10 -0000	1.31
  +++ ftp.html	14 May 2005 13:14:14 -0000	1.32
  @@ -172,6 +172,115 @@
         (<em>Note</em>: Ignored on Java 1.1)</td>
       <td valign="top" align="center">No; defaults to false.</td>
     </tr>
  +
  +    <tr>
  +    <td colspan="3">
  +    <p><b>The following attributes require <a href=
  +    "http://jakarta.apache.org/commons/net/download.html">
  +    jakarta-commons-net-1.4.0 or greater</a>.</b></p>
  +    <p>
  +    Use these options when the standard options don't work, because
  +    <ul><li>the server is in a different timezone and you need timestamp
  +    dependency checking</li>
  +    <li>the default timestamp formatting doesn't match the server display and
  +    list parsing therefore fails</li></ul>
  +    </p><p>
  +    If none of these is specified, the default mechanism of letting the system
  +    auto-detect the server OS type based on the FTP SYST command and assuming
  +    standard formatting for that OS type will be used.</p>
  +    </td>
  +    </tr>
  +  <tr>
  +    <td valign="top">systemTypeKey</td>
  +    <td valign="top">Specifies the type of system in use on the server.
  +      Supported values are "UNIX", "VMS", "WINDOWS", "OS/2", "OS/400", "MVS".
  +      If not specified, and no other xxxConfig attributes are specified, the
  +      autodectection mechanism based on the FTP SYST command will be used.
  +    </td>
  +    <td valign="top" align="center">No, but if any of the following xxxConfig
  +        attributes is specified, UNIX will be assumed.
  +    </td>
  +   </tr>
  +   <tr>
  +    <td valign="top">serverTimeZoneConfig</td>
  +    <td valign="top">Specify as a <code>java.util.Timezone</code> identifier
  +    (e.g. <code>GMT</code>, <code>America/Chicago</code> or
  +    <code>Asia/Jakarta</code>) the timezone
  +      used by the server for timestamps.  This enables Ant timestamp dependency
  +      checking even when the server is in a different timezone than the client.
  +      If not specified, the timezone of the client is assumed.
  +    </td>
  +    <td valign="top" align="center">No</td>
  +  </tr>
  +  <tr>
  +    <td valign="top">defaultDateFormatConfig</td>
  +    <td valign="top">Specify in java.text.SimpleDateFormat notation, (e.g.
  +    <code>yyyy-MM-dd</code>) the date format generally used by the FTP server
  +      to parse dates.  In some cases this will be the only date format used.
  +      In others, (unix for example) this will be used for dates
  +      older than a year old. (See recentDateFormatConfig).  If not specified,
  +      the default date format for the system type indicated by the
  +      systemTypeKey attribute will be used.
  +    </td>
  +    <td valign="top" align="center">
  +    No.
  +    </td>
  +  </tr>
  +  <tr>
  +    <td valign="top">recentDateFormatConfig</td>
  +    <td valign="top">Specify in java.text.SimpleDateFormat notation, the date
  +      format used by the FTP server to parse dates less than a year old,
  +      (e.g. <code>MMM dd hh:mm</code>
  +      If not specified, and if the system type indicated by the system key
  +      uses a recent date format, its standard format will be used.
  +    </td>
  +    <td valign="top" align="center">No</td>
  +  </tr>
  +  <tr>
  +    <td valign="top">serverLanguageCodeConfig</td>
  +    <td valign="top">a <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">
  +      two-letter ISO-639 language code</a> used to specify the
  +      language used by the server to format month names.  This only needs to be
  +      specified when the server uses non-numeric abbreviations for months in its
  +      date listings in a language other than English.  This appears to be
  +      becoming rarer and rarer, as commonly distributed ftp servers seem
  +      increasingly to use English or all-numeric formats.
  +      Languages supported are:
  +      <ul>
  +      	<li>en - English</li>
  +      	<li>fr - French</li>
  +      	<li>de - German</li>
  +      	<li>it - Italian</li>
  +      	<li>es - Spanish</li>
  +      	<li>pt - Portuguese</li>
  +      	<li>da - Danish</li>
  +      	<li>sv - Swedish</li>
  +      	<li>no - Norwegian</li>
  +      	<li>nl - Dutch</li>
  +      	<li>ro - Romanian</li>
  +      	<li>sq - Albanian</li>
  +      	<li>sh - Serbo-croatian</li>
  +      	<li>sk - Slovak</li>
  +      	<li>sl - Slovenian</li>
  +      </ul>
  +      If you require a language other than the above, see also the
  +      shortMonthNamesConfig attribute.
  +    </td>
  +
  +    <td valign="top" align="center">No</td>
  +  </tr>
  +  <tr>
  +    <td valign="top">shortMonthNamesConfig</td>
  +    <td valign="top">specify the month abbreviations used on the server in file
  +      timestamp dates as a pipe-delimited string for each month. For example,
  +      a set of month names used by a hypothetical
  +      Icelandic FTP server might conceivably be specified as
  +      <code>"jan|feb|mar|apr|ma&#xED;|j&#xFA;n|j&#xFA;l|&#xE1;g&#xFA;|sep|okt|n&#xF3;v|des"</code>.
  +      This attribute exists primarily to support languages not supported by
  +      the serverLanguageCode attribute.
  +    </td>
  +    <td valign="top" align="center">No</td>
  +  </tr>
   </table>
   <h3>Note about remotedir attribute</h3>
   <table  border="1" cellpadding="2" cellspacing="0"
  @@ -294,7 +403,7 @@
          depends=&quot;yes&quot;&gt;
       &lt;fileset dir=&quot;htdocs/manual&quot;/&gt;
     &lt;/ftp&gt;</pre>
  -<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code>
and 
  +<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code>
and
   uploads all new or changed files in the <code>htdocs/manual</code> directory

   to the <code>incoming</code> directory relative to the default directory
   for <code>anonymous</code>.</p>
  @@ -303,16 +412,37 @@
          remotedir=&quot;/pub/incoming&quot;
          userid=&quot;coder&quot;
          password=&quot;java1&quot;
  +       passive=&quot;yes&quot;
          depends=&quot;yes&quot;
          binary=&quot;no&quot;&gt;
       &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
         &lt;include name=&quot;**/*.html&quot;/&gt;
       &lt;/fileset&gt;
     &lt;/ftp&gt;</pre>
  -<p>Logs in to <code>ftp.apache.org</code> at port <code>2121</code>
as 
  -<code>coder</code> with password <code>java1</code> and uploads
all new or 
  -changed HTML files in the <code>htdocs/manual</code> directory to the 
  -<code>/pub/incoming</code> directory. The files are transferred in text mode.
Passive mode has been switched on to send files from behind a firewall.</p>
  +<p>Logs in to <code>ftp.apache.org</code> at port <code>2121</code>
as
  +<code>coder</code> with password <code>java1</code> and uploads
all new or
  +changed HTML files in the <code>htdocs/manual</code> directory to the
  +<code>/pub/incoming</code> directory. The files are transferred in text mode.
  +Passive mode has been switched on to send files from behind a firewall.</p>
  +<pre>  &lt;ftp server=&quot;ftp.hypothetical.india.org&quot;
  +       port=&quot;2121&quot;
  +       remotedir=&quot;/pub/incoming&quot;
  +       userid=&quot;coder&quot;
  +       password=&quot;java1&quot;
  +       depends=&quot;yes&quot;
  +       binary=&quot;no&quot;
  +       systemTypeKey=&quot;Windows&quot;
  +       serverTimeZoneConfig=&quot;India/Calcutta&quot;&gt;
  +    &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
  +      &lt;include name=&quot;**/*.html&quot;/&gt;
  +    &lt;/fileset&gt;
  +  &lt;/ftp&gt;</pre>
  +<p>Logs in to a Windows server at <code>ftp.hypothetical.india.org</code>
  +at port <code>2121</code> as <code>coder</code> with password <code>java1</code>
  +and uploads all new or changed (accounting for timezone differences)
  +HTML files in the <code>htdocs/manual</code>
  +directory to the <code>/pub/incoming</code> directory. The files are transferred
  +in text mode.</p>
   <pre>  &lt;ftp server=&quot;ftp.nt.org&quot;
          remotedir=&quot;c:\uploads&quot;
          userid=&quot;coder&quot;
  @@ -346,7 +476,42 @@
   <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code>
and 
   recursively downloads all .html files from default directory for that user 
   into the <code>htdocs/manual</code> directory on the local machine.</p>
  -. 
  +<pre>
  +  &lt;ftp action=&quot;get&quot;
  +       server=&quot;ftp.apache.org&quot;
  +       userid=&quot;anonymous&quot;
  +       password=&quot;me@myorg.com&quot;
  +       systemTypeKey="UNIX"
  +       defaultDateFormatConfig=&quot;yyyy-MM-dd HH:mm&quot;&gt;
  +    &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
  +      &lt;include name=&quot;**/*.html&quot;/&gt;
  +    &lt;/fileset&gt;
  +  &lt;/ftp&gt;
  +</pre>
  +<p>If apache.org ever switches to a unix FTP server that uses the new all-numeric
  +format for timestamps, this version would become necessary.  It would accomplish
  +the same functionality as the previous example but would successfully handle the
  +numeric timestamps.
  +The <code>systemTypeKey</code> is not necessary here but helps clarify what
is
  +going on.</p>
  +<pre>
  +  &lt;ftp action=&quot;get&quot;
  +       server=&quot;ftp.hypthetical.fr&quot;
  +       userid=&quot;anonymous&quot;
  +       password=&quot;me@myorg.com&quot;
  +       defaultDateFormatConfig=&quot;d MMM yyyy&quot;
  +       recentDateFormatConfig=&quot;d MMM HH:mm&quot;
  +       serverLanguageCodeConfig=&quot;fr&quot;&gt;
  +     &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
  +      &lt;include name=&quot;**/*.html&quot;/&gt;
  +    &lt;/fileset&gt;
  +  &lt;/ftp&gt;
  +</pre>
  +<p>Logs into a UNIX FTP server at <code>ftp.hypothetical.fr</code> which
displays
  +dates with French names in Standard European format, as <code>anonymous</code>,
and
  +recursively downloads all .html files from default directory for that user
  +into the <code>htdocs/manual</code> directory on the local machine.</p>
  +
   <h3>Deleting Files</h3>
   As you've probably guessed by now, you use nested fileset elements to 
   select the files to delete from the remote FTP server.  Again, the 
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message