source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 13.7 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>
7ScpFromMessage (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage 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="ScpFromMessage (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/Scp.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/ScpToMessage.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="ScpFromMessage.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;FIELD&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 ScpFromMessage</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage</B>
91</PRE>
92<HR>
93<DL>
94<DT>public class <B>ScpFromMessage</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">AbstractSshMessage</A></DL>
95
96<P>
97<HR>
98
99<P>
100<!-- ======== NESTED CLASS SUMMARY ======== -->
101
102
103<!-- =========== FIELD SUMMARY =========== -->
104
105
106<!-- ======== CONSTRUCTOR SUMMARY ======== -->
107
108<A NAME="constructor_summary"><!-- --></A>
109<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
110<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
111<TD COLSPAN=2><FONT SIZE="+2">
112<B>Constructor Summary</B></FONT></TD>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
115<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#ScpFromMessage(boolean, Session, java.lang.String, java.io.File, boolean)">ScpFromMessage</A></B>(boolean&nbsp;verbose,
116 Session&nbsp;session,
117 java.lang.String&nbsp;aRemoteFile,
118 java.io.File&nbsp;aLocalFile,
119 boolean&nbsp;recursive)</CODE>
120
121<BR>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#ScpFromMessage(Session, java.lang.String, java.io.File, boolean)">ScpFromMessage</A></B>(Session&nbsp;session,
126 java.lang.String&nbsp;aRemoteFile,
127 java.io.File&nbsp;aLocalFile,
128 boolean&nbsp;recursive)</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
132</TR>
133</TABLE>
134&nbsp;
135<!-- ========== METHOD SUMMARY =========== -->
136
137<A NAME="method_summary"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140<TD COLSPAN=2><FONT SIZE="+2">
141<B>Method Summary</B></FONT></TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;void</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#execute()">execute</A></B>()</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150</TR>
151</TABLE>
152&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage"><!-- --></A>
153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
155<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">AbstractSshMessage</A></B></TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#getVerbose()">getVerbose</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#logStats(long, long, int)">logStats</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#openExecChannel(java.lang.String)">openExecChannel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#sendAck(java.io.OutputStream)">sendAck</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#setLogListener(org.apache.tools.ant.taskdefs.optional.ssh.LogListener)">setLogListener</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#trackProgress(int, int, int)">trackProgress</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#waitForAck(java.io.InputStream)">waitForAck</A></CODE></TD>
159</TR>
160</TABLE>
161&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164<TD><B>Methods inherited from class java.lang.Object</B></TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
168</TR>
169</TABLE>
170&nbsp;
171<P>
172
173<!-- ============ FIELD DETAIL =========== -->
174
175
176<!-- ========= CONSTRUCTOR DETAIL ======== -->
177
178<A NAME="constructor_detail"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181<TD COLSPAN=1><FONT SIZE="+2">
182<B>Constructor Detail</B></FONT></TD>
183</TR>
184</TABLE>
185
186<A NAME="ScpFromMessage(boolean, Session, java.lang.String, java.io.File, boolean)"><!-- --></A><H3>
187ScpFromMessage</H3>
188<PRE>
189public <B>ScpFromMessage</B>(boolean&nbsp;verbose,
190 Session&nbsp;session,
191 java.lang.String&nbsp;aRemoteFile,
192 java.io.File&nbsp;aLocalFile,
193 boolean&nbsp;recursive)</PRE>
194<DL>
195<DT><B>Since:</B></DT>
196 <DD>Ant 1.6.2</DD>
197</DL>
198<HR>
199
200<A NAME="ScpFromMessage(Session, java.lang.String, java.io.File, boolean)"><!-- --></A><H3>
201ScpFromMessage</H3>
202<PRE>
203public <B>ScpFromMessage</B>(Session&nbsp;session,
204 java.lang.String&nbsp;aRemoteFile,
205 java.io.File&nbsp;aLocalFile,
206 boolean&nbsp;recursive)</PRE>
207<DL>
208</DL>
209
210<!-- ============ METHOD DETAIL ========== -->
211
212<A NAME="method_detail"><!-- --></A>
213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
214<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
215<TD COLSPAN=1><FONT SIZE="+2">
216<B>Method Detail</B></FONT></TD>
217</TR>
218</TABLE>
219
220<A NAME="execute()"><!-- --></A><H3>
221execute</H3>
222<PRE>
223public void <B>execute</B>()
224 throws java.io.IOException,
225 JSchException</PRE>
226<DL>
227<DD><DL>
228<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">AbstractSshMessage</A></CODE></DL>
229</DD>
230<DD><DL>
231
232<DT><B>Throws:</B>
233<DD><CODE>java.io.IOException</CODE>
234<DD><CODE>JSchException</CODE></DL>
235</DD>
236</DL>
237<!-- ========= END OF CLASS DATA ========= -->
238<HR>
239
240
241<!-- ======= START OF BOTTOM NAVBAR ====== -->
242<A NAME="navbar_bottom"><!-- --></A>
243<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
244<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
245<TR>
246<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
247<A NAME="navbar_bottom_firstrow"><!-- --></A>
248<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
249 <TR ALIGN="center" VALIGN="top">
250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
251 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
252 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
253 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
254 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
255 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
256 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
257 </TR>
258</TABLE>
259</TD>
260<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
261</EM>
262</TD>
263</TR>
264
265<TR>
266<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
267&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>PREV CLASS</B></A>&nbsp;
268&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>NEXT CLASS</B></A></FONT></TD>
269<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
270 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
271&nbsp;<A HREF="ScpFromMessage.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
272&nbsp;<SCRIPT type="text/javascript">
273 <!--
274 if(window==top) {
275 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
276 }
277 //-->
278</SCRIPT>
279<NOSCRIPT>
280 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
281</NOSCRIPT>
282
283</FONT></TD>
284</TR>
285<TR>
286<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
287 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
288<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
289DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
290</TR>
291</TABLE>
292<A NAME="skip-navbar_bottom"></A>
293<!-- ======== END OF BOTTOM NAVBAR ======= -->
294
295<HR>
296Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
297</BODY>
298</HTML>
Note: See TracBrowser for help on using the repository browser.