source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/net/FTP.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 65.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:28 NZST 2007 -->
6<TITLE>
7FTP (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.FTP class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="FTP (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="FTP.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.net</FONT>
85<BR>
86Class FTP</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.net.FTP</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>FTP</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Basic FTP client. Performs the following actions:
99 <ul>
100 <li> <strong>send</strong> - send files to a remote server. This is the
101 default action.</li>
102 <li> <strong>get</strong> - retrieve files from a remote server.</li>
103 <li> <strong>del</strong> - delete files from a remote server.</li>
104 <li> <strong>list</strong> - create a file listing.</li>
105 <li> <strong>chmod</strong> - change unix file permissions.</li>
106 <li> <strong>rmdir</strong> - remove directories, if empty, from a
107 remote server.</li>
108 </ul>
109 <strong>Note:</strong> Some FTP servers - notably the Solaris server - seem
110 to hold data ports open after a "retr" operation, allowing them to timeout
111 instead of shutting them down cleanly. This happens in active or passive
112 mode, and the ports will remain open even after ending the FTP session. FTP
113 "send" operations seem to close ports immediately. This behavior may cause
114 problems on some systems when downloading large sets of files.
115<P>
116
117<P>
118<DL>
119<DT><B>Since:</B></DT>
120 <DD>Ant 1.3</DD>
121</DL>
122<HR>
123
124<P>
125<!-- ======== NESTED CLASS SUMMARY ======== -->
126
127<A NAME="nested_class_summary"><!-- --></A>
128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130<TD COLSPAN=2><FONT SIZE="+2">
131<B>Nested Class Summary</B></FONT></TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>static&nbsp;class</CODE></FONT></TD>
136<TD><CODE><B><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></B></CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;an action to perform, one of
140 "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod",
141 "rmdir"</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>protected &nbsp;class</CODE></FONT></TD>
146<TD><CODE><B><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></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;internal class allowing to read the contents of a remote file system
150 using the FTP protocol
151 used in particular for ftp get operations
152 differences with DirectoryScanner
153 "" (the root of the fileset) is never included in the included directories
154 followSymlinks defaults to false</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- =========== FIELD SUMMARY =========== -->
159
160<A NAME="field_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TD COLSPAN=2><FONT SIZE="+2">
164<B>Field Summary</B></FONT></TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>protected static&nbsp;java.lang.String[]</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#ACTION_STRS">ACTION_STRS</A></B></CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>protected static&nbsp;java.lang.String[]</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#ACTION_TARGET_STRS">ACTION_TARGET_STRS</A></B></CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>protected static&nbsp;int</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#CHMOD">CHMOD</A></B></CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>protected static&nbsp;java.lang.String[]</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#COMPLETED_ACTION_STRS">COMPLETED_ACTION_STRS</A></B></CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>static&nbsp;int</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#DEFAULT_FTP_PORT">DEFAULT_FTP_PORT</A></B></CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default port for FTP</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>protected static&nbsp;int</CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#DEL_FILES">DEL_FILES</A></B></CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>protected static&nbsp;int</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#GET_FILES">GET_FILES</A></B></CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>protected static&nbsp;int</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#LIST_FILES">LIST_FILES</A></B></CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>protected static&nbsp;int</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#MK_DIR">MK_DIR</A></B></CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>protected static&nbsp;int</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#RM_DIR">RM_DIR</A></B></CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>protected static&nbsp;int</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#SEND_FILES">SEND_FILES</A></B></CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
253</TR>
254</TABLE>
255&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
256<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
257<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
258<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <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></TD>
262</TR>
263</TABLE>
264&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
265<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
266<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
267<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
271</TR>
272</TABLE>
273&nbsp;
274<!-- ======== CONSTRUCTOR SUMMARY ======== -->
275
276<A NAME="constructor_summary"><!-- --></A>
277<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
278<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
279<TD COLSPAN=2><FONT SIZE="+2">
280<B>Constructor Summary</B></FONT></TD>
281</TR>
282<TR BGCOLOR="white" CLASS="TableRowColor">
283<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#FTP()">FTP</A></B>()</CODE>
284
285<BR>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
287</TR>
288</TABLE>
289&nbsp;
290<!-- ========== METHOD SUMMARY =========== -->
291
292<A NAME="method_summary"><!-- --></A>
293<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
294<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
295<TD COLSPAN=2><FONT SIZE="+2">
296<B>Method Summary</B></FONT></TD>
297</TR>
298<TR BGCOLOR="white" CLASS="TableRowColor">
299<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
300<CODE>&nbsp;void</CODE></FONT></TD>
301<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</CODE>
302
303<BR>
304&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A set of files to upload or download</TD>
305</TR>
306<TR BGCOLOR="white" CLASS="TableRowColor">
307<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
308<CODE>protected &nbsp;void</CODE></FONT></TD>
309<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#checkConfiguration()">checkConfiguration</A></B>()</CODE>
310
311<BR>
312&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks to see that all required parameters are set.</TD>
313</TR>
314<TR BGCOLOR="white" CLASS="TableRowColor">
315<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
316<CODE>protected &nbsp;void</CODE></FONT></TD>
317<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#createParents(FTPClient, java.lang.String)">createParents</A></B>(FTPClient&nbsp;ftp,
318 java.lang.String&nbsp;filename)</CODE>
319
320<BR>
321&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates all parent directories specified in a complete relative
322 pathname.</TD>
323</TR>
324<TR BGCOLOR="white" CLASS="TableRowColor">
325<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
326<CODE>protected &nbsp;void</CODE></FONT></TD>
327<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#delFile(FTPClient, java.lang.String)">delFile</A></B>(FTPClient&nbsp;ftp,
328 java.lang.String&nbsp;filename)</CODE>
329
330<BR>
331&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete a file from the remote host.</TD>
332</TR>
333<TR BGCOLOR="white" CLASS="TableRowColor">
334<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
335<CODE>protected &nbsp;void</CODE></FONT></TD>
336<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#doSiteCommand(FTPClient, java.lang.String)">doSiteCommand</A></B>(FTPClient&nbsp;ftp,
337 java.lang.String&nbsp;theCMD)</CODE>
338
339<BR>
340&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a site command to the ftp server</TD>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344<CODE>&nbsp;void</CODE></FONT></TD>
345<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#execute()">execute</A></B>()</CODE>
346
347<BR>
348&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Runs the task.</TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352<CODE>protected &nbsp;void</CODE></FONT></TD>
353<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#getFile(FTPClient, java.lang.String, java.lang.String)">getFile</A></B>(FTPClient&nbsp;ftp,
354 java.lang.String&nbsp;dir,
355 java.lang.String&nbsp;filename)</CODE>
356
357<BR>
358&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a single file from the remote host.</TD>
359</TR>
360<TR BGCOLOR="white" CLASS="TableRowColor">
361<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
362<CODE>protected &nbsp;boolean</CODE></FONT></TD>
363<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#isUpToDate(FTPClient, java.io.File, java.lang.String)">isUpToDate</A></B>(FTPClient&nbsp;ftp,
364 java.io.File&nbsp;localFile,
365 java.lang.String&nbsp;remoteFile)</CODE>
366
367<BR>
368&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks to see if the remote file is current as compared with the local
369 file.</TD>
370</TR>
371<TR BGCOLOR="white" CLASS="TableRowColor">
372<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373<CODE>protected &nbsp;void</CODE></FONT></TD>
374<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#listFile(FTPClient, java.io.BufferedWriter, java.lang.String)">listFile</A></B>(FTPClient&nbsp;ftp,
375 java.io.BufferedWriter&nbsp;bw,
376 java.lang.String&nbsp;filename)</CODE>
377
378<BR>
379&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List information about a single file from the remote host.</TD>
380</TR>
381<TR BGCOLOR="white" CLASS="TableRowColor">
382<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383<CODE>protected &nbsp;void</CODE></FONT></TD>
384<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#makeRemoteDir(FTPClient, java.lang.String)">makeRemoteDir</A></B>(FTPClient&nbsp;ftp,
385 java.lang.String&nbsp;dir)</CODE>
386
387<BR>
388&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create the specified directory on the remote host.</TD>
389</TR>
390<TR BGCOLOR="white" CLASS="TableRowColor">
391<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
392<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
393<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#resolveFile(java.lang.String)">resolveFile</A></B>(java.lang.String&nbsp;file)</CODE>
394
395<BR>
396&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Correct a file path to correspond to the remote host requirements.</TD>
397</TR>
398<TR BGCOLOR="white" CLASS="TableRowColor">
399<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
400<CODE>protected &nbsp;void</CODE></FONT></TD>
401<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#rmDir(FTPClient, java.lang.String)">rmDir</A></B>(FTPClient&nbsp;ftp,
402 java.lang.String&nbsp;dirname)</CODE>
403
404<BR>
405&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete a directory, if empty, from the remote host.</TD>
406</TR>
407<TR BGCOLOR="white" CLASS="TableRowColor">
408<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
409<CODE>protected &nbsp;void</CODE></FONT></TD>
410<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#sendFile(FTPClient, java.lang.String, java.lang.String)">sendFile</A></B>(FTPClient&nbsp;ftp,
411 java.lang.String&nbsp;dir,
412 java.lang.String&nbsp;filename)</CODE>
413
414<BR>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a single file to the remote host.</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>&nbsp;void</CODE></FONT></TD>
420<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setAction(org.apache.tools.ant.taskdefs.optional.net.FTP.Action)">setAction</A></B>(<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>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the FTP action to be taken.</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>&nbsp;void</CODE></FONT></TD>
428<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setAction(java.lang.String)">setAction</A></B>(java.lang.String&nbsp;action)</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>setAction(String) is deprecated and is replaced with
432 setAction(FTP.Action) to make Ant's Introspection mechanism do the
433 work and also to encapsulate operations on the type in its own
434 class.</I></TD>
435</TR>
436<TR BGCOLOR="white" CLASS="TableRowColor">
437<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
438<CODE>&nbsp;void</CODE></FONT></TD>
439<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setBinary(boolean)">setBinary</A></B>(boolean&nbsp;binary)</CODE>
440
441<BR>
442&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, uses binary mode, otherwise text mode (default is binary).</TD>
443</TR>
444<TR BGCOLOR="white" CLASS="TableRowColor">
445<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
446<CODE>&nbsp;void</CODE></FONT></TD>
447<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setChmod(java.lang.String)">setChmod</A></B>(java.lang.String&nbsp;theMode)</CODE>
448
449<BR>
450&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the file permission mode (Unix only) for files sent to the
451 server.</TD>
452</TR>
453<TR BGCOLOR="white" CLASS="TableRowColor">
454<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
455<CODE>&nbsp;void</CODE></FONT></TD>
456<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setDepends(boolean)">setDepends</A></B>(boolean&nbsp;depends)</CODE>
457
458<BR>
459&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to true to transmit only files that are new or changed from their
460 remote counterparts.</TD>
461</TR>
462<TR BGCOLOR="white" CLASS="TableRowColor">
463<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
464<CODE>&nbsp;void</CODE></FONT></TD>
465<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setIgnoreNoncriticalErrors(boolean)">setIgnoreNoncriticalErrors</A></B>(boolean&nbsp;ignoreNoncriticalErrors)</CODE>
466
467<BR>
468&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the flag to skip errors on directory creation.</TD>
469</TR>
470<TR BGCOLOR="white" CLASS="TableRowColor">
471<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
472<CODE>&nbsp;void</CODE></FONT></TD>
473<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setListing(java.io.File)">setListing</A></B>(java.io.File&nbsp;listing)</CODE>
474
475<BR>
476&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The output file for the "list" action.</TD>
477</TR>
478<TR BGCOLOR="white" CLASS="TableRowColor">
479<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
480<CODE>&nbsp;void</CODE></FONT></TD>
481<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setNewer(boolean)">setNewer</A></B>(boolean&nbsp;newer)</CODE>
482
483<BR>
484&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A synonym for <tt>depends</tt>.</TD>
485</TR>
486<TR BGCOLOR="white" CLASS="TableRowColor">
487<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
488<CODE>&nbsp;void</CODE></FONT></TD>
489<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPassive(boolean)">setPassive</A></B>(boolean&nbsp;passive)</CODE>
490
491<BR>
492&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies whether to use passive mode.</TD>
493</TR>
494<TR BGCOLOR="white" CLASS="TableRowColor">
495<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
496<CODE>&nbsp;void</CODE></FONT></TD>
497<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String&nbsp;password)</CODE>
498
499<BR>
500&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the login password for the given user id.</TD>
501</TR>
502<TR BGCOLOR="white" CLASS="TableRowColor">
503<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
504<CODE>&nbsp;void</CODE></FONT></TD>
505<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPort(int)">setPort</A></B>(int&nbsp;port)</CODE>
506
507<BR>
508&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the FTP port used by the remote server.</TD>
509</TR>
510<TR BGCOLOR="white" CLASS="TableRowColor">
511<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
512<CODE>&nbsp;void</CODE></FONT></TD>
513<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setPreserveLastModified(boolean)">setPreserveLastModified</A></B>(boolean&nbsp;preserveLastModified)</CODE>
514
515<BR>
516&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to true to preserve modification times for "gotten" files.</TD>
517</TR>
518<TR BGCOLOR="white" CLASS="TableRowColor">
519<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
520<CODE>&nbsp;void</CODE></FONT></TD>
521<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setRemotedir(java.lang.String)">setRemotedir</A></B>(java.lang.String&nbsp;dir)</CODE>
522
523<BR>
524&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the remote directory where files will be placed.</TD>
525</TR>
526<TR BGCOLOR="white" CLASS="TableRowColor">
527<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
528<CODE>&nbsp;void</CODE></FONT></TD>
529<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setSeparator(java.lang.String)">setSeparator</A></B>(java.lang.String&nbsp;separator)</CODE>
530
531<BR>
532&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the remote file separator character.</TD>
533</TR>
534<TR BGCOLOR="white" CLASS="TableRowColor">
535<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
536<CODE>&nbsp;void</CODE></FONT></TD>
537<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setServer(java.lang.String)">setServer</A></B>(java.lang.String&nbsp;server)</CODE>
538
539<BR>
540&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the FTP server to send files to.</TD>
541</TR>
542<TR BGCOLOR="white" CLASS="TableRowColor">
543<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
544<CODE>&nbsp;void</CODE></FONT></TD>
545<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setSkipFailedTransfers(boolean)">setSkipFailedTransfers</A></B>(boolean&nbsp;skipFailedTransfers)</CODE>
546
547<BR>
548&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, enables unsuccessful file put, delete and get
549 operations to be skipped with a warning and the remainder
550 of the files still transferred.</TD>
551</TR>
552<TR BGCOLOR="white" CLASS="TableRowColor">
553<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
554<CODE>&nbsp;void</CODE></FONT></TD>
555<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setTimeDiffAuto(boolean)">setTimeDiffAuto</A></B>(boolean&nbsp;timeDiffAuto)</CODE>
556
557<BR>
558&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&quot;true&quot; to find out automatically the time difference
559 between local and remote machine.</TD>
560</TR>
561<TR BGCOLOR="white" CLASS="TableRowColor">
562<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
563<CODE>&nbsp;void</CODE></FONT></TD>
564<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setTimeDiffMillis(long)">setTimeDiffMillis</A></B>(long&nbsp;timeDiffMillis)</CODE>
565
566<BR>
567&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of milliseconds to add to the time on the remote machine
568 to get the time on the local machine.</TD>
569</TR>
570<TR BGCOLOR="white" CLASS="TableRowColor">
571<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
572<CODE>&nbsp;void</CODE></FONT></TD>
573<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setUmask(java.lang.String)">setUmask</A></B>(java.lang.String&nbsp;theUmask)</CODE>
574
575<BR>
576&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the default mask for file creation on a unix server.</TD>
577</TR>
578<TR BGCOLOR="white" CLASS="TableRowColor">
579<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
580<CODE>&nbsp;void</CODE></FONT></TD>
581<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setUserid(java.lang.String)">setUserid</A></B>(java.lang.String&nbsp;userid)</CODE>
582
583<BR>
584&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the login user id to use on the specified server.</TD>
585</TR>
586<TR BGCOLOR="white" CLASS="TableRowColor">
587<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
588<CODE>&nbsp;void</CODE></FONT></TD>
589<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#setVerbose(boolean)">setVerbose</A></B>(boolean&nbsp;verbose)</CODE>
590
591<BR>
592&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to true to receive notification about each file as it is
593 transferred.</TD>
594</TR>
595<TR BGCOLOR="white" CLASS="TableRowColor">
596<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
597<CODE>protected &nbsp;void</CODE></FONT></TD>
598<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#transferFiles(FTPClient)">transferFiles</A></B>(FTPClient&nbsp;ftp)</CODE>
599
600<BR>
601&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends all files specified by the configured filesets to the remote
602 server.</TD>
603</TR>
604<TR BGCOLOR="white" CLASS="TableRowColor">
605<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
606<CODE>protected &nbsp;int</CODE></FONT></TD>
607<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.html#transferFiles(FTPClient, org.apache.tools.ant.types.FileSet)">transferFiles</A></B>(FTPClient&nbsp;ftp,
608 <A HREF="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;fs)</CODE>
609
610<BR>
611&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For each file in the fileset, do the appropriate action: send, get,
612 delete, or list.</TD>
613</TR>
614</TABLE>
615&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
616<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
617<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
618<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
619</TR>
620<TR BGCOLOR="white" CLASS="TableRowColor">
621<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</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#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#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</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></TD>
622</TR>
623</TABLE>
624&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
625<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
626<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
627<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
628</TR>
629<TR BGCOLOR="white" CLASS="TableRowColor">
630<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
631</TR>
632</TABLE>
633&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
634<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
635<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
636<TD><B>Methods inherited from class java.lang.Object</B></TD>
637</TR>
638<TR BGCOLOR="white" CLASS="TableRowColor">
639<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
640</TR>
641</TABLE>
642&nbsp;
643<P>
644
645<!-- ============ FIELD DETAIL =========== -->
646
647<A NAME="field_detail"><!-- --></A>
648<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
649<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
650<TD COLSPAN=1><FONT SIZE="+2">
651<B>Field Detail</B></FONT></TD>
652</TR>
653</TABLE>
654
655<A NAME="SEND_FILES"><!-- --></A><H3>
656SEND_FILES</H3>
657<PRE>
658protected static final int <B>SEND_FILES</B></PRE>
659<DL>
660<DL>
661<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.SEND_FILES">Constant Field Values</A></DL>
662</DL>
663<HR>
664
665<A NAME="GET_FILES"><!-- --></A><H3>
666GET_FILES</H3>
667<PRE>
668protected static final int <B>GET_FILES</B></PRE>
669<DL>
670<DL>
671<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.GET_FILES">Constant Field Values</A></DL>
672</DL>
673<HR>
674
675<A NAME="DEL_FILES"><!-- --></A><H3>
676DEL_FILES</H3>
677<PRE>
678protected static final int <B>DEL_FILES</B></PRE>
679<DL>
680<DL>
681<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.DEL_FILES">Constant Field Values</A></DL>
682</DL>
683<HR>
684
685<A NAME="LIST_FILES"><!-- --></A><H3>
686LIST_FILES</H3>
687<PRE>
688protected static final int <B>LIST_FILES</B></PRE>
689<DL>
690<DL>
691<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.LIST_FILES">Constant Field Values</A></DL>
692</DL>
693<HR>
694
695<A NAME="MK_DIR"><!-- --></A><H3>
696MK_DIR</H3>
697<PRE>
698protected static final int <B>MK_DIR</B></PRE>
699<DL>
700<DL>
701<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.MK_DIR">Constant Field Values</A></DL>
702</DL>
703<HR>
704
705<A NAME="CHMOD"><!-- --></A><H3>
706CHMOD</H3>
707<PRE>
708protected static final int <B>CHMOD</B></PRE>
709<DL>
710<DL>
711<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.CHMOD">Constant Field Values</A></DL>
712</DL>
713<HR>
714
715<A NAME="RM_DIR"><!-- --></A><H3>
716RM_DIR</H3>
717<PRE>
718protected static final int <B>RM_DIR</B></PRE>
719<DL>
720<DL>
721<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.RM_DIR">Constant Field Values</A></DL>
722</DL>
723<HR>
724
725<A NAME="DEFAULT_FTP_PORT"><!-- --></A><H3>
726DEFAULT_FTP_PORT</H3>
727<PRE>
728public static final int <B>DEFAULT_FTP_PORT</B></PRE>
729<DL>
730<DD>Default port for FTP
731<P>
732<DL>
733<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.net.FTP.DEFAULT_FTP_PORT">Constant Field Values</A></DL>
734</DL>
735<HR>
736
737<A NAME="ACTION_STRS"><!-- --></A><H3>
738ACTION_STRS</H3>
739<PRE>
740protected static final java.lang.String[] <B>ACTION_STRS</B></PRE>
741<DL>
742<DL>
743</DL>
744</DL>
745<HR>
746
747<A NAME="COMPLETED_ACTION_STRS"><!-- --></A><H3>
748COMPLETED_ACTION_STRS</H3>
749<PRE>
750protected static final java.lang.String[] <B>COMPLETED_ACTION_STRS</B></PRE>
751<DL>
752<DL>
753</DL>
754</DL>
755<HR>
756
757<A NAME="ACTION_TARGET_STRS"><!-- --></A><H3>
758ACTION_TARGET_STRS</H3>
759<PRE>
760protected static final java.lang.String[] <B>ACTION_TARGET_STRS</B></PRE>
761<DL>
762<DL>
763</DL>
764</DL>
765
766<!-- ========= CONSTRUCTOR DETAIL ======== -->
767
768<A NAME="constructor_detail"><!-- --></A>
769<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
770<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
771<TD COLSPAN=1><FONT SIZE="+2">
772<B>Constructor Detail</B></FONT></TD>
773</TR>
774</TABLE>
775
776<A NAME="FTP()"><!-- --></A><H3>
777FTP</H3>
778<PRE>
779public <B>FTP</B>()</PRE>
780<DL>
781</DL>
782
783<!-- ============ METHOD DETAIL ========== -->
784
785<A NAME="method_detail"><!-- --></A>
786<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
787<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
788<TD COLSPAN=1><FONT SIZE="+2">
789<B>Method Detail</B></FONT></TD>
790</TR>
791</TABLE>
792
793<A NAME="setRemotedir(java.lang.String)"><!-- --></A><H3>
794setRemotedir</H3>
795<PRE>
796public void <B>setRemotedir</B>(java.lang.String&nbsp;dir)</PRE>
797<DL>
798<DD>Sets the remote directory where files will be placed. This may be a
799 relative or absolute path, and must be in the path syntax expected by
800 the remote server. No correction of path syntax will be performed.
801<P>
802<DD><DL>
803<DT><B>Parameters:</B><DD><CODE>dir</CODE> - the remote directory name.</DL>
804</DD>
805</DL>
806<HR>
807
808<A NAME="setServer(java.lang.String)"><!-- --></A><H3>
809setServer</H3>
810<PRE>
811public void <B>setServer</B>(java.lang.String&nbsp;server)</PRE>
812<DL>
813<DD>Sets the FTP server to send files to.
814<P>
815<DD><DL>
816<DT><B>Parameters:</B><DD><CODE>server</CODE> - the remote server name.</DL>
817</DD>
818</DL>
819<HR>
820
821<A NAME="setPort(int)"><!-- --></A><H3>
822setPort</H3>
823<PRE>
824public void <B>setPort</B>(int&nbsp;port)</PRE>
825<DL>
826<DD>Sets the FTP port used by the remote server.
827<P>
828<DD><DL>
829<DT><B>Parameters:</B><DD><CODE>port</CODE> - the port on which the remote server is listening.</DL>
830</DD>
831</DL>
832<HR>
833
834<A NAME="setUserid(java.lang.String)"><!-- --></A><H3>
835setUserid</H3>
836<PRE>
837public void <B>setUserid</B>(java.lang.String&nbsp;userid)</PRE>
838<DL>
839<DD>Sets the login user id to use on the specified server.
840<P>
841<DD><DL>
842<DT><B>Parameters:</B><DD><CODE>userid</CODE> - remote system userid.</DL>
843</DD>
844</DL>
845<HR>
846
847<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
848setPassword</H3>
849<PRE>
850public void <B>setPassword</B>(java.lang.String&nbsp;password)</PRE>
851<DL>
852<DD>Sets the login password for the given user id.
853<P>
854<DD><DL>
855<DT><B>Parameters:</B><DD><CODE>password</CODE> - the password on the remote system.</DL>
856</DD>
857</DL>
858<HR>
859
860<A NAME="setBinary(boolean)"><!-- --></A><H3>
861setBinary</H3>
862<PRE>
863public void <B>setBinary</B>(boolean&nbsp;binary)</PRE>
864<DL>
865<DD>If true, uses binary mode, otherwise text mode (default is binary).
866<P>
867<DD><DL>
868<DT><B>Parameters:</B><DD><CODE>binary</CODE> - if true use binary mode in transfers.</DL>
869</DD>
870</DL>
871<HR>
872
873<A NAME="setPassive(boolean)"><!-- --></A><H3>
874setPassive</H3>
875<PRE>
876public void <B>setPassive</B>(boolean&nbsp;passive)</PRE>
877<DL>
878<DD>Specifies whether to use passive mode. Set to true if you are behind a
879 firewall and cannot connect without it. Passive mode is disabled by
880 default.
881<P>
882<DD><DL>
883<DT><B>Parameters:</B><DD><CODE>passive</CODE> - true is passive mode should be used.</DL>
884</DD>
885</DL>
886<HR>
887
888<A NAME="setVerbose(boolean)"><!-- --></A><H3>
889setVerbose</H3>
890<PRE>
891public void <B>setVerbose</B>(boolean&nbsp;verbose)</PRE>
892<DL>
893<DD>Set to true to receive notification about each file as it is
894 transferred.
895<P>
896<DD><DL>
897<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - true if verbose notifications are required.</DL>
898</DD>
899</DL>
900<HR>
901
902<A NAME="setNewer(boolean)"><!-- --></A><H3>
903setNewer</H3>
904<PRE>
905public void <B>setNewer</B>(boolean&nbsp;newer)</PRE>
906<DL>
907<DD>A synonym for <tt>depends</tt>. Set to true to transmit only new
908 or changed files.
909
910 See the related attributes timediffmillis and timediffauto.
911<P>
912<DD><DL>
913<DT><B>Parameters:</B><DD><CODE>newer</CODE> - if true only transfer newer files.</DL>
914</DD>
915</DL>
916<HR>
917
918<A NAME="setTimeDiffMillis(long)"><!-- --></A><H3>
919setTimeDiffMillis</H3>
920<PRE>
921public void <B>setTimeDiffMillis</B>(long&nbsp;timeDiffMillis)</PRE>
922<DL>
923<DD>number of milliseconds to add to the time on the remote machine
924 to get the time on the local machine.
925
926 use in conjunction with <code>newer</code>
927<P>
928<DD><DL>
929<DT><B>Parameters:</B><DD><CODE>timeDiffMillis</CODE> - number of milliseconds<DT><B>Since:</B></DT>
930 <DD>ant 1.6</DD>
931</DL>
932</DD>
933</DL>
934<HR>
935
936<A NAME="setTimeDiffAuto(boolean)"><!-- --></A><H3>
937setTimeDiffAuto</H3>
938<PRE>
939public void <B>setTimeDiffAuto</B>(boolean&nbsp;timeDiffAuto)</PRE>
940<DL>
941<DD>&quot;true&quot; to find out automatically the time difference
942 between local and remote machine.
943
944 This requires right to create
945 and delete a temporary file in the remote directory.
946<P>
947<DD><DL>
948<DT><B>Parameters:</B><DD><CODE>timeDiffAuto</CODE> - true = find automatically the time diff<DT><B>Since:</B></DT>
949 <DD>ant 1.6</DD>
950</DL>
951</DD>
952</DL>
953<HR>
954
955<A NAME="setPreserveLastModified(boolean)"><!-- --></A><H3>
956setPreserveLastModified</H3>
957<PRE>
958public void <B>setPreserveLastModified</B>(boolean&nbsp;preserveLastModified)</PRE>
959<DL>
960<DD>Set to true to preserve modification times for "gotten" files.
961<P>
962<DD><DL>
963<DT><B>Parameters:</B><DD><CODE>preserveLastModified</CODE> - if true preserver modification times.</DL>
964</DD>
965</DL>
966<HR>
967
968<A NAME="setDepends(boolean)"><!-- --></A><H3>
969setDepends</H3>
970<PRE>
971public void <B>setDepends</B>(boolean&nbsp;depends)</PRE>
972<DL>
973<DD>Set to true to transmit only files that are new or changed from their
974 remote counterparts. The default is to transmit all files.
975<P>
976<DD><DL>
977<DT><B>Parameters:</B><DD><CODE>depends</CODE> - if true only transfer newer files.</DL>
978</DD>
979</DL>
980<HR>
981
982<A NAME="setSeparator(java.lang.String)"><!-- --></A><H3>
983setSeparator</H3>
984<PRE>
985public void <B>setSeparator</B>(java.lang.String&nbsp;separator)</PRE>
986<DL>
987<DD>Sets the remote file separator character. This normally defaults to the
988 Unix standard forward slash, but can be manually overridden using this
989 call if the remote server requires some other separator. Only the first
990 character of the string is used.
991<P>
992<DD><DL>
993<DT><B>Parameters:</B><DD><CODE>separator</CODE> - the file separator on the remote system.</DL>
994</DD>
995</DL>
996<HR>
997
998<A NAME="setChmod(java.lang.String)"><!-- --></A><H3>
999setChmod</H3>
1000<PRE>
1001public void <B>setChmod</B>(java.lang.String&nbsp;theMode)</PRE>
1002<DL>
1003<DD>Sets the file permission mode (Unix only) for files sent to the
1004 server.
1005<P>
1006<DD><DL>
1007<DT><B>Parameters:</B><DD><CODE>theMode</CODE> - unix style file mode for the files sent to the remote
1008 system.</DL>
1009</DD>
1010</DL>
1011<HR>
1012
1013<A NAME="setUmask(java.lang.String)"><!-- --></A><H3>
1014setUmask</H3>
1015<PRE>
1016public void <B>setUmask</B>(java.lang.String&nbsp;theUmask)</PRE>
1017<DL>
1018<DD>Sets the default mask for file creation on a unix server.
1019<P>
1020<DD><DL>
1021<DT><B>Parameters:</B><DD><CODE>theUmask</CODE> - unix style umask for files created on the remote server.</DL>
1022</DD>
1023</DL>
1024<HR>
1025
1026<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
1027addFileset</H3>
1028<PRE>
1029public void <B>addFileset</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</PRE>
1030<DL>
1031<DD>A set of files to upload or download
1032<P>
1033<DD><DL>
1034<DT><B>Parameters:</B><DD><CODE>set</CODE> - the set of files to be added to the list of files to be
1035 transferred.</DL>
1036</DD>
1037</DL>
1038<HR>
1039
1040<A NAME="setAction(java.lang.String)"><!-- --></A><H3>
1041setAction</H3>
1042<PRE>
1043public void <B>setAction</B>(java.lang.String&nbsp;action)
1044 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1045<DL>
1046<DD><B>Deprecated.</B>&nbsp;<I>setAction(String) is deprecated and is replaced with
1047 setAction(FTP.Action) to make Ant's Introspection mechanism do the
1048 work and also to encapsulate operations on the type in its own
1049 class.</I>
1050<P>
1051<DD>Sets the FTP action to be taken. Currently accepts "put", "get", "del",
1052 "mkdir" and "list".
1053<P>
1054<DD><DL>
1055<DT><B>Parameters:</B><DD><CODE>action</CODE> - the FTP action to be performed.
1056<DT><B>Throws:</B>
1057<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.</DL>
1058</DD>
1059</DL>
1060<HR>
1061
1062<A NAME="setAction(org.apache.tools.ant.taskdefs.optional.net.FTP.Action)"><!-- --></A><H3>
1063setAction</H3>
1064<PRE>
1065public void <B>setAction</B>(<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)
1066 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1067<DL>
1068<DD>Sets the FTP action to be taken. Currently accepts "put", "get", "del",
1069 "mkdir", "chmod" and "list".
1070<P>
1071<DD><DL>
1072<DT><B>Parameters:</B><DD><CODE>action</CODE> - the FTP action to be performed.
1073<DT><B>Throws:</B>
1074<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.</DL>
1075</DD>
1076</DL>
1077<HR>
1078
1079<A NAME="setListing(java.io.File)"><!-- --></A><H3>
1080setListing</H3>
1081<PRE>
1082public void <B>setListing</B>(java.io.File&nbsp;listing)</PRE>
1083<DL>
1084<DD>The output file for the "list" action. This attribute is ignored for
1085 any other actions.
1086<P>
1087<DD><DL>
1088<DT><B>Parameters:</B><DD><CODE>listing</CODE> - file in which to store the listing.</DL>
1089</DD>
1090</DL>
1091<HR>
1092
1093<A NAME="setSkipFailedTransfers(boolean)"><!-- --></A><H3>
1094setSkipFailedTransfers</H3>
1095<PRE>
1096public void <B>setSkipFailedTransfers</B>(boolean&nbsp;skipFailedTransfers)</PRE>
1097<DL>
1098<DD>If true, enables unsuccessful file put, delete and get
1099 operations to be skipped with a warning and the remainder
1100 of the files still transferred.
1101<P>
1102<DD><DL>
1103<DT><B>Parameters:</B><DD><CODE>skipFailedTransfers</CODE> - true if failures in transfers are ignored.</DL>
1104</DD>
1105</DL>
1106<HR>
1107
1108<A NAME="setIgnoreNoncriticalErrors(boolean)"><!-- --></A><H3>
1109setIgnoreNoncriticalErrors</H3>
1110<PRE>
1111public void <B>setIgnoreNoncriticalErrors</B>(boolean&nbsp;ignoreNoncriticalErrors)</PRE>
1112<DL>
1113<DD>set the flag to skip errors on directory creation.
1114 (and maybe later other server specific errors)
1115<P>
1116<DD><DL>
1117<DT><B>Parameters:</B><DD><CODE>ignoreNoncriticalErrors</CODE> - true if non-critical errors should not
1118 cause a failure.</DL>
1119</DD>
1120</DL>
1121<HR>
1122
1123<A NAME="checkConfiguration()"><!-- --></A><H3>
1124checkConfiguration</H3>
1125<PRE>
1126protected void <B>checkConfiguration</B>()
1127 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1128<DL>
1129<DD>Checks to see that all required parameters are set.
1130<P>
1131<DD><DL>
1132
1133<DT><B>Throws:</B>
1134<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.</DL>
1135</DD>
1136</DL>
1137<HR>
1138
1139<A NAME="transferFiles(FTPClient, org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
1140transferFiles</H3>
1141<PRE>
1142protected int <B>transferFiles</B>(FTPClient&nbsp;ftp,
1143 <A HREF="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;fs)
1144 throws java.io.IOException,
1145 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1146<DL>
1147<DD>For each file in the fileset, do the appropriate action: send, get,
1148 delete, or list.
1149<P>
1150<DD><DL>
1151<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - the FTPClient instance used to perform FTP actions<DD><CODE>fs</CODE> - the fileset on which the actions are performed.
1152<DT><B>Returns:</B><DD>the number of files to be transferred.
1153<DT><B>Throws:</B>
1154<DD><CODE>java.io.IOException</CODE> - if there is a problem reading a file
1155<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.</DL>
1156</DD>
1157</DL>
1158<HR>
1159
1160<A NAME="transferFiles(FTPClient)"><!-- --></A><H3>
1161transferFiles</H3>
1162<PRE>
1163protected void <B>transferFiles</B>(FTPClient&nbsp;ftp)
1164 throws java.io.IOException,
1165 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1166<DL>
1167<DD>Sends all files specified by the configured filesets to the remote
1168 server.
1169<P>
1170<DD><DL>
1171<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - the FTPClient instance used to perform FTP actions
1172<DT><B>Throws:</B>
1173<DD><CODE>java.io.IOException</CODE> - if there is a problem reading a file
1174<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.</DL>
1175</DD>
1176</DL>
1177<HR>
1178
1179<A NAME="resolveFile(java.lang.String)"><!-- --></A><H3>
1180resolveFile</H3>
1181<PRE>
1182protected java.lang.String <B>resolveFile</B>(java.lang.String&nbsp;file)</PRE>
1183<DL>
1184<DD>Correct a file path to correspond to the remote host requirements. This
1185 implementation currently assumes that the remote end can handle
1186 Unix-style paths with forward-slash separators. This can be overridden
1187 with the <code>separator</code> task parameter. No attempt is made to
1188 determine what syntax is appropriate for the remote host.
1189<P>
1190<DD><DL>
1191<DT><B>Parameters:</B><DD><CODE>file</CODE> - the remote file name to be resolved
1192<DT><B>Returns:</B><DD>the filename as it will appear on the server.</DL>
1193</DD>
1194</DL>
1195<HR>
1196
1197<A NAME="createParents(FTPClient, java.lang.String)"><!-- --></A><H3>
1198createParents</H3>
1199<PRE>
1200protected void <B>createParents</B>(FTPClient&nbsp;ftp,
1201 java.lang.String&nbsp;filename)
1202 throws java.io.IOException,
1203 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1204<DL>
1205<DD>Creates all parent directories specified in a complete relative
1206 pathname. Attempts to create existing directories will not cause
1207 errors.
1208<P>
1209<DD><DL>
1210<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - the FTP client instance to use to execute FTP actions on
1211 the remote server.<DD><CODE>filename</CODE> - the name of the file whose parents should be created.
1212<DT><B>Throws:</B>
1213<DD><CODE>java.io.IOException</CODE> - under non documented circumstances
1214<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</DL>
1215</DD>
1216</DL>
1217<HR>
1218
1219<A NAME="isUpToDate(FTPClient, java.io.File, java.lang.String)"><!-- --></A><H3>
1220isUpToDate</H3>
1221<PRE>
1222protected boolean <B>isUpToDate</B>(FTPClient&nbsp;ftp,
1223 java.io.File&nbsp;localFile,
1224 java.lang.String&nbsp;remoteFile)
1225 throws java.io.IOException,
1226 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1227<DL>
1228<DD>Checks to see if the remote file is current as compared with the local
1229 file. Returns true if the target file is up to date.
1230<P>
1231<DD><DL>
1232<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - ftpclient<DD><CODE>localFile</CODE> - local file<DD><CODE>remoteFile</CODE> - remote file
1233<DT><B>Returns:</B><DD>true if the target file is up to date
1234<DT><B>Throws:</B>
1235<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1236<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
1237 GET_FILES</DL>
1238</DD>
1239</DL>
1240<HR>
1241
1242<A NAME="doSiteCommand(FTPClient, java.lang.String)"><!-- --></A><H3>
1243doSiteCommand</H3>
1244<PRE>
1245protected void <B>doSiteCommand</B>(FTPClient&nbsp;ftp,
1246 java.lang.String&nbsp;theCMD)
1247 throws java.io.IOException,
1248 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1249<DL>
1250<DD>Sends a site command to the ftp server
1251<P>
1252<DD><DL>
1253<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - ftp client<DD><CODE>theCMD</CODE> - command to execute
1254<DT><B>Throws:</B>
1255<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1256<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - in unknown circumstances</DL>
1257</DD>
1258</DL>
1259<HR>
1260
1261<A NAME="sendFile(FTPClient, java.lang.String, java.lang.String)"><!-- --></A><H3>
1262sendFile</H3>
1263<PRE>
1264protected void <B>sendFile</B>(FTPClient&nbsp;ftp,
1265 java.lang.String&nbsp;dir,
1266 java.lang.String&nbsp;filename)
1267 throws java.io.IOException,
1268 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1269<DL>
1270<DD>Sends a single file to the remote host. <code>filename</code> may
1271 contain a relative path specification. When this is the case, <code>sendFile</code>
1272 will attempt to create any necessary parent directories before sending
1273 the file. The file will then be sent using the entire relative path
1274 spec - no attempt is made to change directories. It is anticipated that
1275 this may eventually cause problems with some FTP servers, but it
1276 simplifies the coding.
1277<P>
1278<DD><DL>
1279<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - ftp client<DD><CODE>dir</CODE> - base directory of the file to be sent (local)<DD><CODE>filename</CODE> - relative path of the file to be send
1280 locally relative to dir
1281 remotely relative to the remotedir attribute
1282<DT><B>Throws:</B>
1283<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1284<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - in unknown circumstances</DL>
1285</DD>
1286</DL>
1287<HR>
1288
1289<A NAME="delFile(FTPClient, java.lang.String)"><!-- --></A><H3>
1290delFile</H3>
1291<PRE>
1292protected void <B>delFile</B>(FTPClient&nbsp;ftp,
1293 java.lang.String&nbsp;filename)
1294 throws java.io.IOException,
1295 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1296<DL>
1297<DD>Delete a file from the remote host.
1298<P>
1299<DD><DL>
1300<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - ftp client<DD><CODE>filename</CODE> - file to delete
1301<DT><B>Throws:</B>
1302<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1303<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
1304 and the deletion could not be done</DL>
1305</DD>
1306</DL>
1307<HR>
1308
1309<A NAME="rmDir(FTPClient, java.lang.String)"><!-- --></A><H3>
1310rmDir</H3>
1311<PRE>
1312protected void <B>rmDir</B>(FTPClient&nbsp;ftp,
1313 java.lang.String&nbsp;dirname)
1314 throws java.io.IOException,
1315 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1316<DL>
1317<DD>Delete a directory, if empty, from the remote host.
1318<P>
1319<DD><DL>
1320<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - ftp client<DD><CODE>dirname</CODE> - directory to delete
1321<DT><B>Throws:</B>
1322<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1323<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
1324 and the deletion could not be done</DL>
1325</DD>
1326</DL>
1327<HR>
1328
1329<A NAME="getFile(FTPClient, java.lang.String, java.lang.String)"><!-- --></A><H3>
1330getFile</H3>
1331<PRE>
1332protected void <B>getFile</B>(FTPClient&nbsp;ftp,
1333 java.lang.String&nbsp;dir,
1334 java.lang.String&nbsp;filename)
1335 throws java.io.IOException,
1336 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1337<DL>
1338<DD>Retrieve a single file from the remote host. <code>filename</code> may
1339 contain a relative path specification. <p>
1340
1341 The file will then be retreived using the entire relative path spec -
1342 no attempt is made to change directories. It is anticipated that this
1343 may eventually cause problems with some FTP servers, but it simplifies
1344 the coding.</p>
1345<P>
1346<DD><DL>
1347<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - the ftp client<DD><CODE>dir</CODE> - local base directory to which the file should go back<DD><CODE>filename</CODE> - relative path of the file based upon the ftp remote directory
1348 and/or the local base directory (dir)
1349<DT><B>Throws:</B>
1350<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1351<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if skipFailedTransfers is false
1352 and the file cannot be retrieved.</DL>
1353</DD>
1354</DL>
1355<HR>
1356
1357<A NAME="listFile(FTPClient, java.io.BufferedWriter, java.lang.String)"><!-- --></A><H3>
1358listFile</H3>
1359<PRE>
1360protected void <B>listFile</B>(FTPClient&nbsp;ftp,
1361 java.io.BufferedWriter&nbsp;bw,
1362 java.lang.String&nbsp;filename)
1363 throws java.io.IOException,
1364 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1365<DL>
1366<DD>List information about a single file from the remote host. <code>filename</code>
1367 may contain a relative path specification. <p>
1368
1369 The file listing will then be retrieved using the entire relative path
1370 spec - no attempt is made to change directories. It is anticipated that
1371 this may eventually cause problems with some FTP servers, but it
1372 simplifies the coding.</p>
1373<P>
1374<DD><DL>
1375<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - ftp client<DD><CODE>bw</CODE> - buffered writer<DD><CODE>filename</CODE> - the directory one wants to list
1376<DT><B>Throws:</B>
1377<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1378<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - in unknown circumstances</DL>
1379</DD>
1380</DL>
1381<HR>
1382
1383<A NAME="makeRemoteDir(FTPClient, java.lang.String)"><!-- --></A><H3>
1384makeRemoteDir</H3>
1385<PRE>
1386protected void <B>makeRemoteDir</B>(FTPClient&nbsp;ftp,
1387 java.lang.String&nbsp;dir)
1388 throws java.io.IOException,
1389 <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1390<DL>
1391<DD>Create the specified directory on the remote host.
1392<P>
1393<DD><DL>
1394<DT><B>Parameters:</B><DD><CODE>ftp</CODE> - The FTP client connection<DD><CODE>dir</CODE> - The directory to create (format must be correct for host
1395 type)
1396<DT><B>Throws:</B>
1397<DD><CODE>java.io.IOException</CODE> - in unknown circumstances
1398<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
1399 and a directory could not be created, for instance because it was
1400 already existing. Precisely, the codes 521, 550 and 553 will trigger
1401 a BuildException</DL>
1402</DD>
1403</DL>
1404<HR>
1405
1406<A NAME="execute()"><!-- --></A><H3>
1407execute</H3>
1408<PRE>
1409public void <B>execute</B>()
1410 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1411<DL>
1412<DD>Runs the task.
1413<P>
1414<DD><DL>
1415<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
1416</DD>
1417<DD><DL>
1418
1419<DT><B>Throws:</B>
1420<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
1421 correctly.</DL>
1422</DD>
1423</DL>
1424<!-- ========= END OF CLASS DATA ========= -->
1425<HR>
1426
1427
1428<!-- ======= START OF BOTTOM NAVBAR ====== -->
1429<A NAME="navbar_bottom"><!-- --></A>
1430<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1431<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1432<TR>
1433<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1434<A NAME="navbar_bottom_firstrow"><!-- --></A>
1435<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1436 <TR ALIGN="center" VALIGN="top">
1437 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1438 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1439 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1440 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1441 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1442 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1443 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1444 </TR>
1445</TABLE>
1446</TD>
1447<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1448</EM>
1449</TD>
1450</TR>
1451
1452<TR>
1453<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1454&nbsp;PREV CLASS&nbsp;
1455&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
1456<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1457 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
1458&nbsp;<A HREF="FTP.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1459&nbsp;<SCRIPT type="text/javascript">
1460 <!--
1461 if(window==top) {
1462 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1463 }
1464 //-->
1465</SCRIPT>
1466<NOSCRIPT>
1467 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1468</NOSCRIPT>
1469
1470</FONT></TD>
1471</TR>
1472<TR>
1473<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1474 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1475<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1476DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1477</TR>
1478</TABLE>
1479<A NAME="skip-navbar_bottom"></A>
1480<!-- ======== END OF BOTTOM NAVBAR ======= -->
1481
1482<HR>
1483Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
1484</BODY>
1485</HTML>
Note: See TracBrowser for help on using the repository browser.