????

Your IP : 216.73.216.152

Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/net/
Upload File :
Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:54 CEST 2012 -->
<title>FTP (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="FTP (Apache Ant API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/net/FTP.html" target="_top">Frames</a></li>
<li><a href="FTP.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs.optional.net</div>
<h2 title="Class FTP" class="title">Class FTP</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</a></li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.net.FTP</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FTP</span>
extends <a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></pre>
<div class="block">Basic FTP client. Performs the following actions:
 <ul>
   <li> <strong>send</strong> - send files to a remote server. This is the
   default action.</li>
   <li> <strong>get</strong> - retrieve files from a remote server.</li>
   <li> <strong>del</strong> - delete files from a remote server.</li>
   <li> <strong>list</strong> - create a file listing.</li>
   <li> <strong>chmod</strong> - change unix file permissions.</li>
   <li> <strong>rmdir</strong> - remove directories, if empty, from a
   remote server.</li>
 </ul>
 <strong>Note:</strong> Some FTP servers - notably the Solaris server - seem
 to hold data ports open after a "retr" operation, allowing them to timeout
 instead of shutting them down cleanly. This happens in active or passive
 mode, and the ports will remain open even after ending the FTP session. FTP
 "send" operations seem to close ports immediately. This behavior may cause
 problems on some systems when downloading large sets of files.</div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.3</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Action</a></strong></code>
<div class="block">an action to perform, one of
 "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod",
 "rmdir"</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPDirectoryScanner</a></strong></code>
<div class="block">internal class allowing to read the contents of a remote file system
 using the FTP protocol
 used in particular for ftp get operations
 differences with DirectoryScanner
 "" (the root of the fileset) is never included in the included directories
 followSymlinks defaults to false</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPFileProxy.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPFileProxy</a></strong></code>
<div class="block">internal class providing a File-like interface to some of the information
 available from the FTP server</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPSystemType.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPSystemType</a></strong></code>
<div class="block">one of the valid system type keys recognized by the systemTypeKey
 attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Granularity.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Granularity</a></strong></code>
<div class="block">represents one of the valid timestamp adjustment values
 recognized by the <code>timestampGranularity</code> attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.LanguageCode.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.LanguageCode</a></strong></code>
<div class="block">Enumerated class for languages.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#ACTION_STRS">ACTION_STRS</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#ACTION_TARGET_STRS">ACTION_TARGET_STRS</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#CHMOD">CHMOD</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#COMPLETED_ACTION_STRS">COMPLETED_ACTION_STRS</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#DEFAULT_FTP_PORT">DEFAULT_FTP_PORT</a></strong></code>
<div class="block">Default port for FTP</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#DEL_FILES">DEL_FILES</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#GET_FILES">GET_FILES</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#LIST_FILES">LIST_FILES</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#MK_DIR">MK_DIR</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#RM_DIR">RM_DIR</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#SEND_FILES">SEND_FILES</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#SITE_CMD">SITE_CMD</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.Task">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.tools.ant.<a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></h3>
<code><a href="../../../../../../../org/apache/tools/ant/Task.html#target">target</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.tools.ant.<a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a></h3>
<code><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#FTP()">FTP</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</a></strong>(<a href="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a>&nbsp;set)</code>
<div class="block">A set of files to upload or download</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#checkAttributes()">checkAttributes</a></strong>()</code>
<div class="block">Checks to see that all required parameters are set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#createParents(org.apache.commons.net.ftp.FTPClient, java.lang.String)">createParents</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
             java.lang.String&nbsp;filename)</code>
<div class="block">Creates all parent directories specified in a complete relative
 pathname.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#delFile(org.apache.commons.net.ftp.FTPClient, java.lang.String)">delFile</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
       java.lang.String&nbsp;filename)</code>
<div class="block">Delete a file from the remote host.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#doSiteCommand(org.apache.commons.net.ftp.FTPClient, java.lang.String)">doSiteCommand</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
             java.lang.String&nbsp;theCMD)</code>
<div class="block">Sends a site command to the ftp server</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#execute()">execute</a></strong>()</code>
<div class="block">Runs the task.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#executeRetryable(org.apache.tools.ant.util.RetryHandler, org.apache.tools.ant.util.Retryable, java.lang.String)">executeRetryable</a></strong>(<a href="../../../../../../../org/apache/tools/ant/util/RetryHandler.html" title="class in org.apache.tools.ant.util">RetryHandler</a>&nbsp;h,
                <a href="../../../../../../../org/apache/tools/ant/util/Retryable.html" title="interface in org.apache.tools.ant.util">Retryable</a>&nbsp;r,
                java.lang.String&nbsp;descr)</code>
<div class="block">Executable a retryable object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getDefaultDateFormatConfig()">getDefaultDateFormatConfig</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getFile(org.apache.commons.net.ftp.FTPClient, java.lang.String, java.lang.String)">getFile</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
       java.lang.String&nbsp;dir,
       java.lang.String&nbsp;filename)</code>
<div class="block">Retrieve a single file from the remote host.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getRecentDateFormatConfig()">getRecentDateFormatConfig</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getServerLanguageCodeConfig()">getServerLanguageCodeConfig</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getServerTimeZoneConfig()">getServerTimeZoneConfig</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getShortMonthNamesConfig()">getShortMonthNamesConfig</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getSystemTypeKey()">getSystemTypeKey</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#isUpToDate(org.apache.commons.net.ftp.FTPClient, java.io.File, java.lang.String)">isUpToDate</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
          java.io.File&nbsp;localFile,
          java.lang.String&nbsp;remoteFile)</code>
<div class="block">Checks to see if the remote file is current as compared with the local
 file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#listFile(org.apache.commons.net.ftp.FTPClient, java.io.BufferedWriter, java.lang.String)">listFile</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
        java.io.BufferedWriter&nbsp;bw,
        java.lang.String&nbsp;filename)</code>
<div class="block">List information about a single file from the remote host.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#log(java.lang.String, int)">log</a></strong>(java.lang.String&nbsp;msg,
   int&nbsp;level)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#makeRemoteDir(org.apache.commons.net.ftp.FTPClient, java.lang.String)">makeRemoteDir</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
             java.lang.String&nbsp;dir)</code>
<div class="block">Create the specified directory on the remote host.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#resolveFile(java.lang.String)">resolveFile</a></strong>(java.lang.String&nbsp;file)</code>
<div class="block">Correct a file path to correspond to the remote host requirements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#rmDir(org.apache.commons.net.ftp.FTPClient, java.lang.String)">rmDir</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
     java.lang.String&nbsp;dirname)</code>
<div class="block">Delete a directory, if empty, from the remote host.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#sendFile(org.apache.commons.net.ftp.FTPClient, java.lang.String, java.lang.String)">sendFile</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
        java.lang.String&nbsp;dir,
        java.lang.String&nbsp;filename)</code>
<div class="block">Sends a single file to the remote host.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setAccount(java.lang.String)">setAccount</a></strong>(java.lang.String&nbsp;pAccount)</code>
<div class="block">Sets the login account to use on the specified server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setAction(org.apache.tools.ant.taskdefs.optional.net.FTP.Action)">setAction</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Action</a>&nbsp;action)</code>
<div class="block">Sets the FTP action to be taken.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setAction(java.lang.String)">setAction</a></strong>(java.lang.String&nbsp;action)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>since 1.5.x.
             setAction(String) is deprecated and is replaced with
      setAction(FTP.Action) to make Ant's Introspection mechanism do the
      work and also to encapsulate operations on the type in its own
      class.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setBinary(boolean)">setBinary</a></strong>(boolean&nbsp;binary)</code>
<div class="block">If true, uses binary mode, otherwise text mode (default is binary).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setChmod(java.lang.String)">setChmod</a></strong>(java.lang.String&nbsp;theMode)</code>
<div class="block">Sets the file permission mode (Unix only) for files sent to the
 server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setDefaultDateFormatConfig(java.lang.String)">setDefaultDateFormatConfig</a></strong>(java.lang.String&nbsp;defaultDateFormat)</code>
<div class="block">Sets the defaultDateFormatConfig attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setDepends(boolean)">setDepends</a></strong>(boolean&nbsp;depends)</code>
<div class="block">Set to true to transmit only files that are new or changed from their
 remote counterparts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setEnableRemoteVerification(boolean)">setEnableRemoteVerification</a></strong>(boolean&nbsp;b)</code>
<div class="block">Whether to verify that data and control connections are
 connected to the same remote host.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setIgnoreNoncriticalErrors(boolean)">setIgnoreNoncriticalErrors</a></strong>(boolean&nbsp;ignoreNoncriticalErrors)</code>
<div class="block">set the flag to skip errors on directory creation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setInitialSiteCommand(java.lang.String)">setInitialSiteCommand</a></strong>(java.lang.String&nbsp;initialCommand)</code>
<div class="block">Sets the initialSiteCommand attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setListing(java.io.File)">setListing</a></strong>(java.io.File&nbsp;listing)</code>
<div class="block">The output file for the "list" action.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setNewer(boolean)">setNewer</a></strong>(boolean&nbsp;newer)</code>
<div class="block">A synonym for <tt>depends</tt>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPassive(boolean)">setPassive</a></strong>(boolean&nbsp;passive)</code>
<div class="block">Specifies whether to use passive mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPassword(java.lang.String)">setPassword</a></strong>(java.lang.String&nbsp;password)</code>
<div class="block">Sets the login password for the given user id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPort(int)">setPort</a></strong>(int&nbsp;port)</code>
<div class="block">Sets the FTP port used by the remote server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPreserveLastModified(boolean)">setPreserveLastModified</a></strong>(boolean&nbsp;preserveLastModified)</code>
<div class="block">Set to true to preserve modification times for "gotten" files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setRecentDateFormatConfig(java.lang.String)">setRecentDateFormatConfig</a></strong>(java.lang.String&nbsp;recentDateFormat)</code>
<div class="block">Sets the recentDateFormatConfig attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setRemotedir(java.lang.String)">setRemotedir</a></strong>(java.lang.String&nbsp;dir)</code>
<div class="block">Sets the remote directory where files will be placed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setRetriesAllowed(java.lang.String)">setRetriesAllowed</a></strong>(java.lang.String&nbsp;retriesAllowed)</code>
<div class="block">Defines how many times to retry executing FTP command before giving up.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setSeparator(java.lang.String)">setSeparator</a></strong>(java.lang.String&nbsp;separator)</code>
<div class="block">Sets the remote file separator character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setServer(java.lang.String)">setServer</a></strong>(java.lang.String&nbsp;server)</code>
<div class="block">Sets the FTP server to send files to.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setServerLanguageCodeConfig(org.apache.tools.ant.taskdefs.optional.net.FTP.LanguageCode)">setServerLanguageCodeConfig</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.LanguageCode.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.LanguageCode</a>&nbsp;serverLanguageCode)</code>
<div class="block">Sets the serverLanguageCode attribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setServerTimeZoneConfig(java.lang.String)">setServerTimeZoneConfig</a></strong>(java.lang.String&nbsp;serverTimeZoneId)</code>
<div class="block">Sets the serverTimeZoneConfig attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setShortMonthNamesConfig(java.lang.String)">setShortMonthNamesConfig</a></strong>(java.lang.String&nbsp;shortMonthNames)</code>
<div class="block">Sets the shortMonthNamesConfig attribute</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setSiteCommand(java.lang.String)">setSiteCommand</a></strong>(java.lang.String&nbsp;siteCommand)</code>
<div class="block">Sets the siteCommand attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setSkipFailedTransfers(boolean)">setSkipFailedTransfers</a></strong>(boolean&nbsp;skipFailedTransfers)</code>
<div class="block">If true, enables unsuccessful file put, delete and get
 operations to be skipped with a warning and the remainder
 of the files still transferred.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setSystemTypeKey(org.apache.tools.ant.taskdefs.optional.net.FTP.FTPSystemType)">setSystemTypeKey</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPSystemType.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPSystemType</a>&nbsp;systemKey)</code>
<div class="block">Sets the systemTypeKey attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setTimeDiffAuto(boolean)">setTimeDiffAuto</a></strong>(boolean&nbsp;timeDiffAuto)</code>
<div class="block">&quot;true&quot; to find out automatically the time difference
 between local and remote machine.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setTimeDiffMillis(long)">setTimeDiffMillis</a></strong>(long&nbsp;timeDiffMillis)</code>
<div class="block">number of milliseconds to add to the time on the remote machine
 to get the time on the local machine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setTimestampGranularity(org.apache.tools.ant.taskdefs.optional.net.FTP.Granularity)">setTimestampGranularity</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Granularity.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Granularity</a>&nbsp;timestampGranularity)</code>
<div class="block">Sets the timestampGranularity attribute</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setUmask(java.lang.String)">setUmask</a></strong>(java.lang.String&nbsp;theUmask)</code>
<div class="block">Sets the default mask for file creation on a unix server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setUserid(java.lang.String)">setUserid</a></strong>(java.lang.String&nbsp;userid)</code>
<div class="block">Sets the login user id to use on the specified server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setVerbose(boolean)">setVerbose</a></strong>(boolean&nbsp;verbose)</code>
<div class="block">Set to true to receive notification about each file as it is
 transferred.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#transferFiles(org.apache.commons.net.ftp.FTPClient)">transferFiles</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp)</code>
<div class="block">Sends all files specified by the configured filesets to the remote
 server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#transferFiles(org.apache.commons.net.ftp.FTPClient, org.apache.tools.ant.types.FileSet)">transferFiles</a></strong>(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
             <a href="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a>&nbsp;fs)</code>
<div class="block">For each file in the fileset, do the appropriate action: send, get,
 delete, or list.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.Task">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.tools.ant.<a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></h3>
<code><a href="../../../../../../../org/apache/tools/ant/Task.html#bindToOwner(org.apache.tools.ant.Task)">bindToOwner</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#init()">init</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, java.lang.Throwable, int)">log</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.Throwable, int)">log</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.tools.ant.<a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a></h3>
<code><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="SEND_FILES">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEND_FILES</h4>
<pre>protected static final&nbsp;int SEND_FILES</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.SEND_FILES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="GET_FILES">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GET_FILES</h4>
<pre>protected static final&nbsp;int GET_FILES</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.GET_FILES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEL_FILES">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEL_FILES</h4>
<pre>protected static final&nbsp;int DEL_FILES</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.DEL_FILES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LIST_FILES">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LIST_FILES</h4>
<pre>protected static final&nbsp;int LIST_FILES</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.LIST_FILES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MK_DIR">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MK_DIR</h4>
<pre>protected static final&nbsp;int MK_DIR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.MK_DIR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CHMOD">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CHMOD</h4>
<pre>protected static final&nbsp;int CHMOD</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.CHMOD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="RM_DIR">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RM_DIR</h4>
<pre>protected static final&nbsp;int RM_DIR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.RM_DIR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SITE_CMD">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SITE_CMD</h4>
<pre>protected static final&nbsp;int SITE_CMD</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.SITE_CMD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_FTP_PORT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_FTP_PORT</h4>
<pre>public static final&nbsp;int DEFAULT_FTP_PORT</pre>
<div class="block">Default port for FTP</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.DEFAULT_FTP_PORT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ACTION_STRS">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ACTION_STRS</h4>
<pre>protected static final&nbsp;java.lang.String[] ACTION_STRS</pre>
</li>
</ul>
<a name="COMPLETED_ACTION_STRS">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPLETED_ACTION_STRS</h4>
<pre>protected static final&nbsp;java.lang.String[] COMPLETED_ACTION_STRS</pre>
</li>
</ul>
<a name="ACTION_TARGET_STRS">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ACTION_TARGET_STRS</h4>
<pre>protected static final&nbsp;java.lang.String[] ACTION_TARGET_STRS</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="FTP()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FTP</h4>
<pre>public&nbsp;FTP()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setRemotedir(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemotedir</h4>
<pre>public&nbsp;void&nbsp;setRemotedir(java.lang.String&nbsp;dir)</pre>
<div class="block">Sets the remote directory where files will be placed. This may be a
 relative or absolute path, and must be in the path syntax expected by
 the remote server. No correction of path syntax will be performed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dir</code> - the remote directory name.</dd></dl>
</li>
</ul>
<a name="setServer(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServer</h4>
<pre>public&nbsp;void&nbsp;setServer(java.lang.String&nbsp;server)</pre>
<div class="block">Sets the FTP server to send files to.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>server</code> - the remote server name.</dd></dl>
</li>
</ul>
<a name="setPort(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPort</h4>
<pre>public&nbsp;void&nbsp;setPort(int&nbsp;port)</pre>
<div class="block">Sets the FTP port used by the remote server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>port</code> - the port on which the remote server is listening.</dd></dl>
</li>
</ul>
<a name="setUserid(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserid</h4>
<pre>public&nbsp;void&nbsp;setUserid(java.lang.String&nbsp;userid)</pre>
<div class="block">Sets the login user id to use on the specified server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>userid</code> - remote system userid.</dd></dl>
</li>
</ul>
<a name="setPassword(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;setPassword(java.lang.String&nbsp;password)</pre>
<div class="block">Sets the login password for the given user id.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - the password on the remote system.</dd></dl>
</li>
</ul>
<a name="setAccount(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAccount</h4>
<pre>public&nbsp;void&nbsp;setAccount(java.lang.String&nbsp;pAccount)</pre>
<div class="block">Sets the login account to use on the specified server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pAccount</code> - the account name on remote system</dd><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="setBinary(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBinary</h4>
<pre>public&nbsp;void&nbsp;setBinary(boolean&nbsp;binary)</pre>
<div class="block">If true, uses binary mode, otherwise text mode (default is binary).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binary</code> - if true use binary mode in transfers.</dd></dl>
</li>
</ul>
<a name="setPassive(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassive</h4>
<pre>public&nbsp;void&nbsp;setPassive(boolean&nbsp;passive)</pre>
<div class="block">Specifies whether to use passive mode. Set to true if you are behind a
 firewall and cannot connect without it. Passive mode is disabled by
 default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>passive</code> - true is passive mode should be used.</dd></dl>
</li>
</ul>
<a name="setVerbose(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVerbose</h4>
<pre>public&nbsp;void&nbsp;setVerbose(boolean&nbsp;verbose)</pre>
<div class="block">Set to true to receive notification about each file as it is
 transferred.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbose</code> - true if verbose notifications are required.</dd></dl>
</li>
</ul>
<a name="setNewer(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNewer</h4>
<pre>public&nbsp;void&nbsp;setNewer(boolean&nbsp;newer)</pre>
<div class="block">A synonym for <tt>depends</tt>. Set to true to transmit only new
 or changed files.

 See the related attributes timediffmillis and timediffauto.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newer</code> - if true only transfer newer files.</dd></dl>
</li>
</ul>
<a name="setTimeDiffMillis(long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeDiffMillis</h4>
<pre>public&nbsp;void&nbsp;setTimeDiffMillis(long&nbsp;timeDiffMillis)</pre>
<div class="block">number of milliseconds to add to the time on the remote machine
 to get the time on the local machine.

 use in conjunction with <code>newer</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeDiffMillis</code> - number of milliseconds</dd><dt><span class="strong">Since:</span></dt>
  <dd>ant 1.6</dd></dl>
</li>
</ul>
<a name="setTimeDiffAuto(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeDiffAuto</h4>
<pre>public&nbsp;void&nbsp;setTimeDiffAuto(boolean&nbsp;timeDiffAuto)</pre>
<div class="block">&quot;true&quot; to find out automatically the time difference
 between local and remote machine.

 This requires right to create
 and delete a temporary file in the remote directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeDiffAuto</code> - true = find automatically the time diff</dd><dt><span class="strong">Since:</span></dt>
  <dd>ant 1.6</dd></dl>
</li>
</ul>
<a name="setPreserveLastModified(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreserveLastModified</h4>
<pre>public&nbsp;void&nbsp;setPreserveLastModified(boolean&nbsp;preserveLastModified)</pre>
<div class="block">Set to true to preserve modification times for "gotten" files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>preserveLastModified</code> - if true preserver modification times.</dd></dl>
</li>
</ul>
<a name="setDepends(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDepends</h4>
<pre>public&nbsp;void&nbsp;setDepends(boolean&nbsp;depends)</pre>
<div class="block">Set to true to transmit only files that are new or changed from their
 remote counterparts. The default is to transmit all files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>depends</code> - if true only transfer newer files.</dd></dl>
</li>
</ul>
<a name="setSeparator(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSeparator</h4>
<pre>public&nbsp;void&nbsp;setSeparator(java.lang.String&nbsp;separator)</pre>
<div class="block">Sets the remote file separator character. This normally defaults to the
 Unix standard forward slash, but can be manually overridden using this
 call if the remote server requires some other separator. Only the first
 character of the string is used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>separator</code> - the file separator on the remote system.</dd></dl>
</li>
</ul>
<a name="setChmod(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChmod</h4>
<pre>public&nbsp;void&nbsp;setChmod(java.lang.String&nbsp;theMode)</pre>
<div class="block">Sets the file permission mode (Unix only) for files sent to the
 server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theMode</code> - unix style file mode for the files sent to the remote
        system.</dd></dl>
</li>
</ul>
<a name="setUmask(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUmask</h4>
<pre>public&nbsp;void&nbsp;setUmask(java.lang.String&nbsp;theUmask)</pre>
<div class="block">Sets the default mask for file creation on a unix server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theUmask</code> - unix style umask for files created on the remote server.</dd></dl>
</li>
</ul>
<a name="addFileset(org.apache.tools.ant.types.FileSet)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFileset</h4>
<pre>public&nbsp;void&nbsp;addFileset(<a href="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a>&nbsp;set)</pre>
<div class="block">A set of files to upload or download</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>set</code> - the set of files to be added to the list of files to be
        transferred.</dd></dl>
</li>
</ul>
<a name="setAction(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAction</h4>
<pre>public&nbsp;void&nbsp;setAction(java.lang.String&nbsp;action)
               throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>since 1.5.x.
             setAction(String) is deprecated and is replaced with
      setAction(FTP.Action) to make Ant's Introspection mechanism do the
      work and also to encapsulate operations on the type in its own
      class.</i></div>
<div class="block">Sets the FTP action to be taken. Currently accepts "put", "get", "del",
 "mkdir", "chmod", "list", and "site".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - the FTP action to be performed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if the action is not a valid action.</dd></dl>
</li>
</ul>
<a name="setAction(org.apache.tools.ant.taskdefs.optional.net.FTP.Action)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAction</h4>
<pre>public&nbsp;void&nbsp;setAction(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Action</a>&nbsp;action)
               throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Sets the FTP action to be taken. Currently accepts "put", "get", "del",
 "mkdir", "chmod", "list", and "site".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - the FTP action to be performed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if the action is not a valid action.</dd></dl>
</li>
</ul>
<a name="setListing(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setListing</h4>
<pre>public&nbsp;void&nbsp;setListing(java.io.File&nbsp;listing)</pre>
<div class="block">The output file for the "list" action. This attribute is ignored for
 any other actions.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listing</code> - file in which to store the listing.</dd></dl>
</li>
</ul>
<a name="setSkipFailedTransfers(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSkipFailedTransfers</h4>
<pre>public&nbsp;void&nbsp;setSkipFailedTransfers(boolean&nbsp;skipFailedTransfers)</pre>
<div class="block">If true, enables unsuccessful file put, delete and get
 operations to be skipped with a warning and the remainder
 of the files still transferred.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>skipFailedTransfers</code> - true if failures in transfers are ignored.</dd></dl>
</li>
</ul>
<a name="setIgnoreNoncriticalErrors(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreNoncriticalErrors</h4>
<pre>public&nbsp;void&nbsp;setIgnoreNoncriticalErrors(boolean&nbsp;ignoreNoncriticalErrors)</pre>
<div class="block">set the flag to skip errors on directory creation.
 (and maybe later other server specific errors)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreNoncriticalErrors</code> - true if non-critical errors should not
        cause a failure.</dd></dl>
</li>
</ul>
<a name="setSystemTypeKey(org.apache.tools.ant.taskdefs.optional.net.FTP.FTPSystemType)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSystemTypeKey</h4>
<pre>public&nbsp;void&nbsp;setSystemTypeKey(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.FTPSystemType.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.FTPSystemType</a>&nbsp;systemKey)</pre>
<div class="block">Sets the systemTypeKey attribute.
 Method for setting <code>FTPClientConfig</code> remote system key.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemKey</code> - the key to be set - BUT if blank
 the default value of null (which signifies "autodetect") will be kept.</dd><dt><span class="strong">See Also:</span></dt><dd><code>FTPClientConfig</code></dd></dl>
</li>
</ul>
<a name="setDefaultDateFormatConfig(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultDateFormatConfig</h4>
<pre>public&nbsp;void&nbsp;setDefaultDateFormatConfig(java.lang.String&nbsp;defaultDateFormat)</pre>
<div class="block">Sets the defaultDateFormatConfig attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDateFormat</code> - configuration to be set, unless it is
 null or empty string, in which case ignored.</dd><dt><span class="strong">See Also:</span></dt><dd><code>FTPClientConfig</code></dd></dl>
</li>
</ul>
<a name="setRecentDateFormatConfig(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecentDateFormatConfig</h4>
<pre>public&nbsp;void&nbsp;setRecentDateFormatConfig(java.lang.String&nbsp;recentDateFormat)</pre>
<div class="block">Sets the recentDateFormatConfig attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recentDateFormat</code> - configuration to be set, unless it is
 null or empty string, in which case ignored.</dd><dt><span class="strong">See Also:</span></dt><dd><code>FTPClientConfig</code></dd></dl>
</li>
</ul>
<a name="setServerLanguageCodeConfig(org.apache.tools.ant.taskdefs.optional.net.FTP.LanguageCode)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServerLanguageCodeConfig</h4>
<pre>public&nbsp;void&nbsp;setServerLanguageCodeConfig(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.LanguageCode.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.LanguageCode</a>&nbsp;serverLanguageCode)</pre>
<div class="block">Sets the serverLanguageCode attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serverLanguageCode</code> - configuration to be set, unless it is
 null or empty string, in which case ignored.</dd><dt><span class="strong">See Also:</span></dt><dd><code>FTPClientConfig</code></dd></dl>
</li>
</ul>
<a name="setServerTimeZoneConfig(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServerTimeZoneConfig</h4>
<pre>public&nbsp;void&nbsp;setServerTimeZoneConfig(java.lang.String&nbsp;serverTimeZoneId)</pre>
<div class="block">Sets the serverTimeZoneConfig attribute.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serverTimeZoneId</code> - configuration to be set, unless it is
 null or empty string, in which case ignored.</dd><dt><span class="strong">See Also:</span></dt><dd><code>FTPClientConfig</code></dd></dl>
</li>
</ul>
<a name="setShortMonthNamesConfig(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShortMonthNamesConfig</h4>
<pre>public&nbsp;void&nbsp;setShortMonthNamesConfig(java.lang.String&nbsp;shortMonthNames)</pre>
<div class="block">Sets the shortMonthNamesConfig attribute</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>shortMonthNames</code> - configuration to be set, unless it is
 null or empty string, in which case ignored.</dd><dt><span class="strong">See Also:</span></dt><dd><code>FTPClientConfig</code></dd></dl>
</li>
</ul>
<a name="setRetriesAllowed(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRetriesAllowed</h4>
<pre>public&nbsp;void&nbsp;setRetriesAllowed(java.lang.String&nbsp;retriesAllowed)</pre>
<div class="block">Defines how many times to retry executing FTP command before giving up.
 Default is 0 - try once and if failure then give up.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>retriesAllowed</code> - number of retries to allow.  -1 means
 keep trying forever. "forever" may also be specified as a
 synonym for -1.</dd></dl>
</li>
</ul>
<a name="getSystemTypeKey()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemTypeKey</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSystemTypeKey()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the systemTypeKey.</dd></dl>
</li>
</ul>
<a name="getDefaultDateFormatConfig()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultDateFormatConfig</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDefaultDateFormatConfig()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the defaultDateFormatConfig.</dd></dl>
</li>
</ul>
<a name="getRecentDateFormatConfig()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecentDateFormatConfig</h4>
<pre>public&nbsp;java.lang.String&nbsp;getRecentDateFormatConfig()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the recentDateFormatConfig.</dd></dl>
</li>
</ul>
<a name="getServerLanguageCodeConfig()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerLanguageCodeConfig</h4>
<pre>public&nbsp;java.lang.String&nbsp;getServerLanguageCodeConfig()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the serverLanguageCodeConfig.</dd></dl>
</li>
</ul>
<a name="getServerTimeZoneConfig()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerTimeZoneConfig</h4>
<pre>public&nbsp;java.lang.String&nbsp;getServerTimeZoneConfig()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the serverTimeZoneConfig.</dd></dl>
</li>
</ul>
<a name="getShortMonthNamesConfig()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShortMonthNamesConfig</h4>
<pre>public&nbsp;java.lang.String&nbsp;getShortMonthNamesConfig()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the shortMonthNamesConfig.</dd></dl>
</li>
</ul>
<a name="setTimestampGranularity(org.apache.tools.ant.taskdefs.optional.net.FTP.Granularity)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimestampGranularity</h4>
<pre>public&nbsp;void&nbsp;setTimestampGranularity(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Granularity.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTP.Granularity</a>&nbsp;timestampGranularity)</pre>
<div class="block">Sets the timestampGranularity attribute</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestampGranularity</code> - The timestampGranularity to set.</dd></dl>
</li>
</ul>
<a name="setSiteCommand(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSiteCommand</h4>
<pre>public&nbsp;void&nbsp;setSiteCommand(java.lang.String&nbsp;siteCommand)</pre>
<div class="block">Sets the siteCommand attribute.  This attribute
 names the command that will be executed if the action
 is "site".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>siteCommand</code> - The siteCommand to set.</dd></dl>
</li>
</ul>
<a name="setInitialSiteCommand(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialSiteCommand</h4>
<pre>public&nbsp;void&nbsp;setInitialSiteCommand(java.lang.String&nbsp;initialCommand)</pre>
<div class="block">Sets the initialSiteCommand attribute.  This attribute
 names a site command that will be executed immediately
 after connection.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialCommand</code> - The initialSiteCommand to set.</dd></dl>
</li>
</ul>
<a name="setEnableRemoteVerification(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnableRemoteVerification</h4>
<pre>public&nbsp;void&nbsp;setEnableRemoteVerification(boolean&nbsp;b)</pre>
<div class="block">Whether to verify that data and control connections are
 connected to the same remote host.</div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.8.0</dd></dl>
</li>
</ul>
<a name="checkAttributes()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAttributes</h4>
<pre>protected&nbsp;void&nbsp;checkAttributes()
                        throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Checks to see that all required parameters are set.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if the configuration is not valid.</dd></dl>
</li>
</ul>
<a name="executeRetryable(org.apache.tools.ant.util.RetryHandler, org.apache.tools.ant.util.Retryable, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeRetryable</h4>
<pre>protected&nbsp;void&nbsp;executeRetryable(<a href="../../../../../../../org/apache/tools/ant/util/RetryHandler.html" title="class in org.apache.tools.ant.util">RetryHandler</a>&nbsp;h,
                    <a href="../../../../../../../org/apache/tools/ant/util/Retryable.html" title="interface in org.apache.tools.ant.util">Retryable</a>&nbsp;r,
                    java.lang.String&nbsp;descr)
                         throws java.io.IOException</pre>
<div class="block">Executable a retryable object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - the retry hander.</dd><dd><code>r</code> - the object that should be retried until it succeeds
          or the number of retrys is reached.</dd><dd><code>descr</code> - a description of the command that is being run.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there is a problem.</dd></dl>
</li>
</ul>
<a name="transferFiles(org.apache.commons.net.ftp.FTPClient, org.apache.tools.ant.types.FileSet)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transferFiles</h4>
<pre>protected&nbsp;int&nbsp;transferFiles(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
                <a href="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a>&nbsp;fs)
                     throws java.io.IOException,
                            <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">For each file in the fileset, do the appropriate action: send, get,
 delete, or list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - the FTPClient instance used to perform FTP actions</dd><dd><code>fs</code> - the fileset on which the actions are performed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of files to be transferred.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there is a problem reading a file</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if there is a problem in the configuration.</dd></dl>
</li>
</ul>
<a name="transferFiles(org.apache.commons.net.ftp.FTPClient)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transferFiles</h4>
<pre>protected&nbsp;void&nbsp;transferFiles(org.apache.commons.net.ftp.FTPClient&nbsp;ftp)
                      throws java.io.IOException,
                             <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Sends all files specified by the configured filesets to the remote
 server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - the FTPClient instance used to perform FTP actions</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there is a problem reading a file</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if there is a problem in the configuration.</dd></dl>
</li>
</ul>
<a name="resolveFile(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveFile</h4>
<pre>protected&nbsp;java.lang.String&nbsp;resolveFile(java.lang.String&nbsp;file)</pre>
<div class="block">Correct a file path to correspond to the remote host requirements. This
 implementation currently assumes that the remote end can handle
 Unix-style paths with forward-slash separators. This can be overridden
 with the <code>separator</code> task parameter. No attempt is made to
 determine what syntax is appropriate for the remote host.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the remote file name to be resolved</dd>
<dt><span class="strong">Returns:</span></dt><dd>the filename as it will appear on the server.</dd></dl>
</li>
</ul>
<a name="createParents(org.apache.commons.net.ftp.FTPClient, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createParents</h4>
<pre>protected&nbsp;void&nbsp;createParents(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
                 java.lang.String&nbsp;filename)
                      throws java.io.IOException,
                             <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Creates all parent directories specified in a complete relative
 pathname. Attempts to create existing directories will not cause
 errors.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - the FTP client instance to use to execute FTP actions on
        the remote server.</dd><dd><code>filename</code> - the name of the file whose parents should be created.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - under non documented circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if it is impossible to cd to a remote directory</dd></dl>
</li>
</ul>
<a name="isUpToDate(org.apache.commons.net.ftp.FTPClient, java.io.File, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpToDate</h4>
<pre>protected&nbsp;boolean&nbsp;isUpToDate(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
                 java.io.File&nbsp;localFile,
                 java.lang.String&nbsp;remoteFile)
                      throws java.io.IOException,
                             <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Checks to see if the remote file is current as compared with the local
 file. Returns true if the target file is up to date.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - ftpclient</dd><dd><code>localFile</code> - local file</dd><dd><code>remoteFile</code> - remote file</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the target file is up to date</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if the date of the remote files cannot be found and the action is
 GET_FILES</dd></dl>
</li>
</ul>
<a name="doSiteCommand(org.apache.commons.net.ftp.FTPClient, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doSiteCommand</h4>
<pre>protected&nbsp;void&nbsp;doSiteCommand(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
                 java.lang.String&nbsp;theCMD)
                      throws java.io.IOException,
                             <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Sends a site command to the ftp server</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - ftp client</dd><dd><code>theCMD</code> - command to execute</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - in unknown circumstances</dd></dl>
</li>
</ul>
<a name="sendFile(org.apache.commons.net.ftp.FTPClient, java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendFile</h4>
<pre>protected&nbsp;void&nbsp;sendFile(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
            java.lang.String&nbsp;dir,
            java.lang.String&nbsp;filename)
                 throws java.io.IOException,
                        <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Sends a single file to the remote host. <code>filename</code> may
 contain a relative path specification. When this is the case, <code>sendFile</code>
 will attempt to create any necessary parent directories before sending
 the file. The file will then be sent using the entire relative path
 spec - no attempt is made to change directories. It is anticipated that
 this may eventually cause problems with some FTP servers, but it
 simplifies the coding.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - ftp client</dd><dd><code>dir</code> - base directory of the file to be sent (local)</dd><dd><code>filename</code> - relative path of the file to be send
        locally relative to dir
        remotely relative to the remotedir attribute</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - in unknown circumstances</dd></dl>
</li>
</ul>
<a name="delFile(org.apache.commons.net.ftp.FTPClient, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delFile</h4>
<pre>protected&nbsp;void&nbsp;delFile(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
           java.lang.String&nbsp;filename)
                throws java.io.IOException,
                       <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Delete a file from the remote host.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - ftp client</dd><dd><code>filename</code> - file to delete</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if skipFailedTransfers is set to false
 and the deletion could not be done</dd></dl>
</li>
</ul>
<a name="rmDir(org.apache.commons.net.ftp.FTPClient, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rmDir</h4>
<pre>protected&nbsp;void&nbsp;rmDir(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
         java.lang.String&nbsp;dirname)
              throws java.io.IOException,
                     <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Delete a directory, if empty, from the remote host.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - ftp client</dd><dd><code>dirname</code> - directory to delete</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if skipFailedTransfers is set to false
 and the deletion could not be done</dd></dl>
</li>
</ul>
<a name="getFile(org.apache.commons.net.ftp.FTPClient, java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFile</h4>
<pre>protected&nbsp;void&nbsp;getFile(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
           java.lang.String&nbsp;dir,
           java.lang.String&nbsp;filename)
                throws java.io.IOException,
                       <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Retrieve a single file from the remote host. <code>filename</code> may
 contain a relative path specification. <p>

 The file will then be retreived using the entire relative path spec -
 no attempt is made to change directories. It is anticipated that this
 may eventually cause problems with some FTP servers, but it simplifies
 the coding.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - the ftp client</dd><dd><code>dir</code> - local base directory to which the file should go back</dd><dd><code>filename</code> - relative path of the file based upon the ftp remote directory
        and/or the local base directory (dir)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if skipFailedTransfers is false
 and the file cannot be retrieved.</dd></dl>
</li>
</ul>
<a name="listFile(org.apache.commons.net.ftp.FTPClient, java.io.BufferedWriter, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listFile</h4>
<pre>protected&nbsp;void&nbsp;listFile(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
            java.io.BufferedWriter&nbsp;bw,
            java.lang.String&nbsp;filename)
                 throws java.io.IOException,
                        <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">List information about a single file from the remote host. <code>filename</code>
 may contain a relative path specification. <p>

 The file listing will then be retrieved using the entire relative path
 spec - no attempt is made to change directories. It is anticipated that
 this may eventually cause problems with some FTP servers, but it
 simplifies the coding.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - ftp client</dd><dd><code>bw</code> - buffered writer</dd><dd><code>filename</code> - the directory one wants to list</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - in unknown circumstances</dd></dl>
</li>
</ul>
<a name="makeRemoteDir(org.apache.commons.net.ftp.FTPClient, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeRemoteDir</h4>
<pre>protected&nbsp;void&nbsp;makeRemoteDir(org.apache.commons.net.ftp.FTPClient&nbsp;ftp,
                 java.lang.String&nbsp;dir)
                      throws java.io.IOException,
                             <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Create the specified directory on the remote host.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ftp</code> - The FTP client connection</dd><dd><code>dir</code> - The directory to create (format must be correct for host
      type)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in unknown circumstances</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if ignoreNoncriticalErrors has not been set to true
         and a directory could not be created, for instance because it was
         already existing. Precisely, the codes 521, 550 and 553 will trigger
         a BuildException</dd></dl>
</li>
</ul>
<a name="execute()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute()
             throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Runs the task.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if the task fails or is not configured
         correctly.</dd></dl>
</li>
</ul>
<a name="log(java.lang.String, int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>log</h4>
<pre>public&nbsp;void&nbsp;log(java.lang.String&nbsp;msg,
       int&nbsp;level)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/net/FTP.html" target="_top">Frames</a></li>
<li><a href="FTP.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>