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

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

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