????

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/FTPTaskMirrorImpl.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>FTPTaskMirrorImpl (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="FTPTaskMirrorImpl (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><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html" title="interface in org.apache.tools.ant.taskdefs.optional.net"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.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/FTPTaskMirrorImpl.html" target="_top">Frames</a></li>
<li><a href="FTPTaskMirrorImpl.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>Field&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>Field&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 FTPTaskMirrorImpl" class="title">Class FTPTaskMirrorImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html" title="interface in org.apache.tools.ant.taskdefs.optional.net">FTPTaskMirror</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FTPTaskMirrorImpl</span>
extends java.lang.Object
implements <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html" title="interface in org.apache.tools.ant.taskdefs.optional.net">FTPTaskMirror</a></pre>
</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>protected class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTPTaskMirrorImpl.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="rowColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPFileProxy.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTPTaskMirrorImpl.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>
</table>
</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/FTPTaskMirrorImpl.html#FTPTaskMirrorImpl(org.apache.tools.ant.taskdefs.optional.net.FTPTask)">FTPTaskMirrorImpl</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTPTask</a>&nbsp;task)</code>
<div class="block">Constructor.</div>
</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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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/FTPTaskMirrorImpl.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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.html#doFTP()">doFTP</a></strong>()</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/FTPTaskMirrorImpl.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="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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/FTPTaskMirrorImpl.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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.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/FTPTaskMirrorImpl.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_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, 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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="FTPTaskMirrorImpl(org.apache.tools.ant.taskdefs.optional.net.FTPTask)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FTPTaskMirrorImpl</h4>
<pre>public&nbsp;FTPTaskMirrorImpl(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">FTPTask</a>&nbsp;task)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - the FTPTask that uses this mirror.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<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="doFTP()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doFTP</h4>
<pre>public&nbsp;void&nbsp;doFTP()
           throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html#doFTP()">doFTP</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html" title="interface in org.apache.tools.ant.taskdefs.optional.net">FTPTaskMirror</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></dd></dl>
</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><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html" title="interface in org.apache.tools.ant.taskdefs.optional.net"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.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/FTPTaskMirrorImpl.html" target="_top">Frames</a></li>
<li><a href="FTPTaskMirrorImpl.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>Field&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>Field&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>