source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/ssh/Scp.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: 30.9 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:30 NZST 2007 -->
6<TITLE>
7Scp (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ssh.Scp 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="Scp (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;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><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="Scp.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;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">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;FIELD&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.ssh</FONT>
85<BR>
86Class Scp</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"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">org.apache.tools.ant.taskdefs.optional.ssh.SSHBase</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.ssh.Scp</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public class <B>Scp</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHBase</A></DL>
100
101<P>
102Ant task for sending files to remote machine over ssh/scp.
103<P>
104
105<P>
106<DL>
107<DT><B>Since:</B></DT>
108 <DD>Ant 1.6</DD>
109</DL>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115
116<!-- =========== FIELD SUMMARY =========== -->
117
118<A NAME="field_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Field Summary</B></FONT></TD>
123</TR>
124</TABLE>
125&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
128<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>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<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>
132</TR>
133</TABLE>
134&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
137<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>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
141</TR>
142</TABLE>
143&nbsp;
144<!-- ======== CONSTRUCTOR SUMMARY ======== -->
145
146<A NAME="constructor_summary"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
149<TD COLSPAN=2><FONT SIZE="+2">
150<B>Constructor Summary</B></FONT></TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#Scp()">Scp</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
157</TR>
158</TABLE>
159&nbsp;
160<!-- ========== METHOD SUMMARY =========== -->
161
162<A NAME="method_summary"><!-- --></A>
163<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
164<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
165<TD COLSPAN=2><FONT SIZE="+2">
166<B>Method Summary</B></FONT></TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;void</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.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>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a FileSet tranfer to remote host.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#execute()">execute</A></B>()</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the project to let the task do its work.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;void</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#init()">init</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the project to let the task initialize properly.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;void</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setFile(java.lang.String)">setFile</A></B>(java.lang.String&nbsp;aFromUri)</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the file to be transferred.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;void</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setLocalFile(java.lang.String)">setLocalFile</A></B>(java.lang.String&nbsp;aFromUri)</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setFile(java.lang.String)"><CODE>setFile</CODE></A> but explicitly states that
207 the file is a local file.</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>&nbsp;void</CODE></FONT></TD>
212<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setLocalTodir(java.lang.String)">setLocalTodir</A></B>(java.lang.String&nbsp;aToUri)</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><CODE>setTodir</CODE></A> but explicitly states
216 that the directory is a local.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>&nbsp;void</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setLocalTofile(java.lang.String)">setLocalTofile</A></B>(java.lang.String&nbsp;aToUri)</CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Changes the file name to the given name while receiving it,
225 only useful if receiving a single file.</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;void</CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setRemoteFile(java.lang.String)">setRemoteFile</A></B>(java.lang.String&nbsp;aFromUri)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setFile(java.lang.String)"><CODE>setFile</CODE></A> but explicitly states that
234 the file is a remote file.</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;void</CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setRemoteTodir(java.lang.String)">setRemoteTodir</A></B>(java.lang.String&nbsp;aToUri)</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><CODE>setTodir</CODE></A> but explicitly states
243 that the directory is a remote.</TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247<CODE>&nbsp;void</CODE></FONT></TD>
248<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setRemoteTofile(java.lang.String)">setRemoteTofile</A></B>(java.lang.String&nbsp;aToUri)</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Changes the file name to the given name while sending it,
252 only useful if sending a single file.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)">setTodir</A></B>(java.lang.String&nbsp;aToUri)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the location where files will be transferred to.</TD>
261</TR>
262</TABLE>
263&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.SSHBase"><!-- --></A>
264<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
265<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
266<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHBase</A></B></TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getFailonerror()">getFailonerror</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getHost()">getHost</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getPort()">getPort</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getUserInfo()">getUserInfo</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getVerbose()">getVerbose</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#openSession()">openSession</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setFailonerror(boolean)">setFailonerror</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setHost(java.lang.String)">setHost</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setKeyfile(java.lang.String)">setKeyfile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setKnownhosts(java.lang.String)">setKnownhosts</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPassphrase(java.lang.String)">setPassphrase</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPassword(java.lang.String)">setPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPort(int)">setPort</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setTrust(boolean)">setTrust</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setUsername(java.lang.String)">setUsername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setVerbose(boolean)">setVerbose</A></CODE></TD>
270</TR>
271</TABLE>
272&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
274<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
275<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>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<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#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>
279</TR>
280</TABLE>
281&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
282<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
283<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
284<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>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<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>
288</TR>
289</TABLE>
290&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
291<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
292<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
293<TD><B>Methods inherited from class java.lang.Object</B></TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
297</TR>
298</TABLE>
299&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.LogListener"><!-- --></A>
300<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
302<TD><B>Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</A></B></TD>
303</TR>
304<TR BGCOLOR="white" CLASS="TableRowColor">
305<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html#log(java.lang.String)">log</A></CODE></TD>
306</TR>
307</TABLE>
308&nbsp;
309<P>
310
311<!-- ============ FIELD DETAIL =========== -->
312
313
314<!-- ========= CONSTRUCTOR DETAIL ======== -->
315
316<A NAME="constructor_detail"><!-- --></A>
317<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
318<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
319<TD COLSPAN=1><FONT SIZE="+2">
320<B>Constructor Detail</B></FONT></TD>
321</TR>
322</TABLE>
323
324<A NAME="Scp()"><!-- --></A><H3>
325Scp</H3>
326<PRE>
327public <B>Scp</B>()</PRE>
328<DL>
329</DL>
330
331<!-- ============ METHOD DETAIL ========== -->
332
333<A NAME="method_detail"><!-- --></A>
334<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
335<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
336<TD COLSPAN=1><FONT SIZE="+2">
337<B>Method Detail</B></FONT></TD>
338</TR>
339</TABLE>
340
341<A NAME="setFile(java.lang.String)"><!-- --></A><H3>
342setFile</H3>
343<PRE>
344public void <B>setFile</B>(java.lang.String&nbsp;aFromUri)</PRE>
345<DL>
346<DD>Sets the file to be transferred. This can either be a remote
347 file or a local file. Remote files take the form:<br>
348 <i>user:password@host:/directory/path/file.example</i><br>
349 Files to transfer can also include a wildcard to include all
350 files in a remote directory. For example:<br>
351 <i>user:password@host:/directory/path/*</i><br>
352<P>
353<DD><DL>
354<DT><B>Parameters:</B><DD><CODE>aFromUri</CODE> - a string representing the file to transfer.</DL>
355</DD>
356</DL>
357<HR>
358
359<A NAME="setTodir(java.lang.String)"><!-- --></A><H3>
360setTodir</H3>
361<PRE>
362public void <B>setTodir</B>(java.lang.String&nbsp;aToUri)</PRE>
363<DL>
364<DD>Sets the location where files will be transferred to.
365 This can either be a remote directory or a local directory.
366 Remote directories take the form of:<br>
367 <i>user:password@host:/directory/path/</i><br>
368 This parameter is required.
369<P>
370<DD><DL>
371<DT><B>Parameters:</B><DD><CODE>aToUri</CODE> - a string representing the target of the copy.</DL>
372</DD>
373</DL>
374<HR>
375
376<A NAME="setLocalFile(java.lang.String)"><!-- --></A><H3>
377setLocalFile</H3>
378<PRE>
379public void <B>setLocalFile</B>(java.lang.String&nbsp;aFromUri)</PRE>
380<DL>
381<DD>Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setFile(java.lang.String)"><CODE>setFile</CODE></A> but explicitly states that
382 the file is a local file. This is the only way to specify a
383 local file with a @ character.
384<P>
385<DD><DL>
386<DT><B>Since:</B></DT>
387 <DD>Ant 1.6.2</DD>
388</DL>
389</DD>
390</DL>
391<HR>
392
393<A NAME="setRemoteFile(java.lang.String)"><!-- --></A><H3>
394setRemoteFile</H3>
395<PRE>
396public void <B>setRemoteFile</B>(java.lang.String&nbsp;aFromUri)</PRE>
397<DL>
398<DD>Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setFile(java.lang.String)"><CODE>setFile</CODE></A> but explicitly states that
399 the file is a remote file.
400<P>
401<DD><DL>
402<DT><B>Since:</B></DT>
403 <DD>Ant 1.6.2</DD>
404</DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="setLocalTodir(java.lang.String)"><!-- --></A><H3>
410setLocalTodir</H3>
411<PRE>
412public void <B>setLocalTodir</B>(java.lang.String&nbsp;aToUri)</PRE>
413<DL>
414<DD>Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><CODE>setTodir</CODE></A> but explicitly states
415 that the directory is a local. This is the only way to specify
416 a local directory with a @ character.
417<P>
418<DD><DL>
419<DT><B>Since:</B></DT>
420 <DD>Ant 1.6.2</DD>
421</DL>
422</DD>
423</DL>
424<HR>
425
426<A NAME="setRemoteTodir(java.lang.String)"><!-- --></A><H3>
427setRemoteTodir</H3>
428<PRE>
429public void <B>setRemoteTodir</B>(java.lang.String&nbsp;aToUri)</PRE>
430<DL>
431<DD>Similiar to <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><CODE>setTodir</CODE></A> but explicitly states
432 that the directory is a remote.
433<P>
434<DD><DL>
435<DT><B>Since:</B></DT>
436 <DD>Ant 1.6.2</DD>
437</DL>
438</DD>
439</DL>
440<HR>
441
442<A NAME="setLocalTofile(java.lang.String)"><!-- --></A><H3>
443setLocalTofile</H3>
444<PRE>
445public void <B>setLocalTofile</B>(java.lang.String&nbsp;aToUri)</PRE>
446<DL>
447<DD>Changes the file name to the given name while receiving it,
448 only useful if receiving a single file.
449<P>
450<DD><DL>
451<DT><B>Since:</B></DT>
452 <DD>Ant 1.6.2</DD>
453</DL>
454</DD>
455</DL>
456<HR>
457
458<A NAME="setRemoteTofile(java.lang.String)"><!-- --></A><H3>
459setRemoteTofile</H3>
460<PRE>
461public void <B>setRemoteTofile</B>(java.lang.String&nbsp;aToUri)</PRE>
462<DL>
463<DD>Changes the file name to the given name while sending it,
464 only useful if sending a single file.
465<P>
466<DD><DL>
467<DT><B>Since:</B></DT>
468 <DD>Ant 1.6.2</DD>
469</DL>
470</DD>
471</DL>
472<HR>
473
474<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
475addFileset</H3>
476<PRE>
477public 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>
478<DL>
479<DD>Adds a FileSet tranfer to remote host. NOTE: Either
480 addFileSet() or setFile() are required. But, not both.
481<P>
482<DD><DL>
483<DT><B>Parameters:</B><DD><CODE>set</CODE> - FileSet to send to remote host.</DL>
484</DD>
485</DL>
486<HR>
487
488<A NAME="init()"><!-- --></A><H3>
489init</H3>
490<PRE>
491public void <B>init</B>()
492 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
493<DL>
494<DD><B>Description copied from class: <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></B></DD>
495<DD>Called by the project to let the task initialize properly.
496 The default implementation is a no-op.
497<P>
498<DD><DL>
499<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#init()">init</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHBase</A></CODE></DL>
500</DD>
501<DD><DL>
502
503<DT><B>Throws:</B>
504<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
505</DD>
506</DL>
507<HR>
508
509<A NAME="execute()"><!-- --></A><H3>
510execute</H3>
511<PRE>
512public void <B>execute</B>()
513 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
514<DL>
515<DD><B>Description copied from class: <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></B></DD>
516<DD>Called by the project to let the task do its work. This method may be
517 called more than once, if the task is invoked more than once.
518 For example,
519 if target1 and target2 both depend on target3, then running
520 "ant target1 target2" will run all tasks in target3 twice.
521<P>
522<DD><DL>
523<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>
524</DD>
525<DD><DL>
526
527<DT><B>Throws:</B>
528<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something goes wrong with the build</DL>
529</DD>
530</DL>
531<!-- ========= END OF CLASS DATA ========= -->
532<HR>
533
534
535<!-- ======= START OF BOTTOM NAVBAR ====== -->
536<A NAME="navbar_bottom"><!-- --></A>
537<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
538<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
539<TR>
540<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
541<A NAME="navbar_bottom_firstrow"><!-- --></A>
542<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
543 <TR ALIGN="center" VALIGN="top">
544 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
545 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
546 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
547 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
548 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
549 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
550 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
551 </TR>
552</TABLE>
553</TD>
554<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
555</EM>
556</TD>
557</TR>
558
559<TR>
560<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
561&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>PREV CLASS</B></A>&nbsp;
562&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>NEXT CLASS</B></A></FONT></TD>
563<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
564 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
565&nbsp;<A HREF="Scp.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
566&nbsp;<SCRIPT type="text/javascript">
567 <!--
568 if(window==top) {
569 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
570 }
571 //-->
572</SCRIPT>
573<NOSCRIPT>
574 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
575</NOSCRIPT>
576
577</FONT></TD>
578</TR>
579<TR>
580<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
581 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
582<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
583DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
584</TR>
585</TABLE>
586<A NAME="skip-navbar_bottom"></A>
587<!-- ======== END OF BOTTOM NAVBAR ======= -->
588
589<HR>
590Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
591</BODY>
592</HTML>
Note: See TracBrowser for help on using the repository browser.