source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.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: 29.2 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>
7SSHBase (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ssh.SSHBase 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="SSHBase (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/ScpToMessage.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/SSHExec.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="SSHBase.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 SSHBase</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.ssh.SSHBase</B>
92</PRE>
93<DL>
94<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>
95</DL>
96<DL>
97<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Scp</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHExec</A></DD>
98</DL>
99<HR>
100<DL>
101<DT>public abstract class <B>SSHBase</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A><DT>implements <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</A></DL>
102
103<P>
104Base class for Ant tasks using jsch.
105<P>
106
107<P>
108<DL>
109<DT><B>Since:</B></DT>
110 <DD>Ant 1.6</DD>
111</DL>
112<HR>
113
114<P>
115<!-- ======== NESTED CLASS SUMMARY ======== -->
116
117
118<!-- =========== FIELD SUMMARY =========== -->
119
120<A NAME="field_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TD COLSPAN=2><FONT SIZE="+2">
124<B>Field Summary</B></FONT></TD>
125</TR>
126</TABLE>
127&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
130<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>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<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>
134</TR>
135</TABLE>
136&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
139<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>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
143</TR>
144</TABLE>
145&nbsp;
146<!-- ======== CONSTRUCTOR SUMMARY ======== -->
147
148<A NAME="constructor_summary"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
151<TD COLSPAN=2><FONT SIZE="+2">
152<B>Constructor Summary</B></FONT></TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#SSHBase()">SSHBase</A></B>()</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for SSHBase.</TD>
159</TR>
160</TABLE>
161&nbsp;
162<!-- ========== METHOD SUMMARY =========== -->
163
164<A NAME="method_summary"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TD COLSPAN=2><FONT SIZE="+2">
168<B>Method Summary</B></FONT></TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE>&nbsp;boolean</CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getFailonerror()">getFailonerror</A></B>()</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getHost()">getHost</A></B>()</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>&nbsp;int</CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getPort()">getPort</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>protected &nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHUserInfo</A></CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getUserInfo()">getUserInfo</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;boolean</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#getVerbose()">getVerbose</A></B>()</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;void</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#init()">init</A></B>()</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the project to let the task initialize properly.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>protected &nbsp;Session</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#openSession()">openSession</A></B>()</CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;void</CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setFailonerror(boolean)">setFailonerror</A></B>(boolean&nbsp;failure)</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>&nbsp;void</CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setHost(java.lang.String)">setHost</A></B>(java.lang.String&nbsp;host)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remote host, either DNS name or IP.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;void</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setKeyfile(java.lang.String)">setKeyfile</A></B>(java.lang.String&nbsp;keyfile)</CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the keyfile for the user.</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>&nbsp;void</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setKnownhosts(java.lang.String)">setKnownhosts</A></B>(java.lang.String&nbsp;knownHosts)</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the path to the file that has the identities of
257 all known hosts.</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>&nbsp;void</CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPassphrase(java.lang.String)">setPassphrase</A></B>(java.lang.String&nbsp;passphrase)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the passphrase for the users key.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>&nbsp;void</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String&nbsp;password)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the password for the user.</TD>
274</TR>
275<TR BGCOLOR="white" CLASS="TableRowColor">
276<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277<CODE>&nbsp;void</CODE></FONT></TD>
278<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setPort(int)">setPort</A></B>(int&nbsp;port)</CODE>
279
280<BR>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Changes the port used to connect to the remote host.</TD>
282</TR>
283<TR BGCOLOR="white" CLASS="TableRowColor">
284<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285<CODE>&nbsp;void</CODE></FONT></TD>
286<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setTrust(boolean)">setTrust</A></B>(boolean&nbsp;yesOrNo)</CODE>
287
288<BR>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Setting this to true trusts hosts whose identity is unknown.</TD>
290</TR>
291<TR BGCOLOR="white" CLASS="TableRowColor">
292<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293<CODE>&nbsp;void</CODE></FONT></TD>
294<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setUsername(java.lang.String)">setUsername</A></B>(java.lang.String&nbsp;username)</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Username known to remote host.</TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301<CODE>&nbsp;void</CODE></FONT></TD>
302<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html#setVerbose(boolean)">setVerbose</A></B>(boolean&nbsp;failure)</CODE>
303
304<BR>
305&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
306</TR>
307</TABLE>
308&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
311<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>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A>, <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>
315</TR>
316</TABLE>
317&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
318<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
319<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
320<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>
321</TR>
322<TR BGCOLOR="white" CLASS="TableRowColor">
323<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>
324</TR>
325</TABLE>
326&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
327<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
328<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
329<TD><B>Methods inherited from class java.lang.Object</B></TD>
330</TR>
331<TR BGCOLOR="white" CLASS="TableRowColor">
332<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
333</TR>
334</TABLE>
335&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.LogListener"><!-- --></A>
336<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
337<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
338<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>
339</TR>
340<TR BGCOLOR="white" CLASS="TableRowColor">
341<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html#log(java.lang.String)">log</A></CODE></TD>
342</TR>
343</TABLE>
344&nbsp;
345<P>
346
347<!-- ============ FIELD DETAIL =========== -->
348
349
350<!-- ========= CONSTRUCTOR DETAIL ======== -->
351
352<A NAME="constructor_detail"><!-- --></A>
353<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
354<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
355<TD COLSPAN=1><FONT SIZE="+2">
356<B>Constructor Detail</B></FONT></TD>
357</TR>
358</TABLE>
359
360<A NAME="SSHBase()"><!-- --></A><H3>
361SSHBase</H3>
362<PRE>
363public <B>SSHBase</B>()</PRE>
364<DL>
365<DD>Constructor for SSHBase.
366<P>
367</DL>
368
369<!-- ============ METHOD DETAIL ========== -->
370
371<A NAME="method_detail"><!-- --></A>
372<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
373<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
374<TD COLSPAN=1><FONT SIZE="+2">
375<B>Method Detail</B></FONT></TD>
376</TR>
377</TABLE>
378
379<A NAME="setHost(java.lang.String)"><!-- --></A><H3>
380setHost</H3>
381<PRE>
382public void <B>setHost</B>(java.lang.String&nbsp;host)</PRE>
383<DL>
384<DD>Remote host, either DNS name or IP.
385<P>
386<DD><DL>
387</DL>
388</DD>
389<DD><DL>
390<DT><B>Parameters:</B><DD><CODE>host</CODE> - The new host value</DL>
391</DD>
392</DL>
393<HR>
394
395<A NAME="getHost()"><!-- --></A><H3>
396getHost</H3>
397<PRE>
398public java.lang.String <B>getHost</B>()</PRE>
399<DL>
400<DD><DL>
401</DL>
402</DD>
403<DD><DL>
404</DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="setFailonerror(boolean)"><!-- --></A><H3>
410setFailonerror</H3>
411<PRE>
412public void <B>setFailonerror</B>(boolean&nbsp;failure)</PRE>
413<DL>
414<DD><DL>
415</DL>
416</DD>
417<DD><DL>
418</DL>
419</DD>
420</DL>
421<HR>
422
423<A NAME="getFailonerror()"><!-- --></A><H3>
424getFailonerror</H3>
425<PRE>
426public boolean <B>getFailonerror</B>()</PRE>
427<DL>
428<DD><DL>
429</DL>
430</DD>
431<DD><DL>
432</DL>
433</DD>
434</DL>
435<HR>
436
437<A NAME="setVerbose(boolean)"><!-- --></A><H3>
438setVerbose</H3>
439<PRE>
440public void <B>setVerbose</B>(boolean&nbsp;failure)</PRE>
441<DL>
442<DD><DL>
443</DL>
444</DD>
445<DD><DL>
446<DT><B>Since:</B></DT>
447 <DD>Ant 1.6.2</DD>
448</DL>
449</DD>
450</DL>
451<HR>
452
453<A NAME="getVerbose()"><!-- --></A><H3>
454getVerbose</H3>
455<PRE>
456public boolean <B>getVerbose</B>()</PRE>
457<DL>
458<DD><DL>
459</DL>
460</DD>
461<DD><DL>
462<DT><B>Since:</B></DT>
463 <DD>Ant 1.6.2</DD>
464</DL>
465</DD>
466</DL>
467<HR>
468
469<A NAME="setUsername(java.lang.String)"><!-- --></A><H3>
470setUsername</H3>
471<PRE>
472public void <B>setUsername</B>(java.lang.String&nbsp;username)</PRE>
473<DL>
474<DD>Username known to remote host.
475<P>
476<DD><DL>
477</DL>
478</DD>
479<DD><DL>
480<DT><B>Parameters:</B><DD><CODE>username</CODE> - The new username value</DL>
481</DD>
482</DL>
483<HR>
484
485<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
486setPassword</H3>
487<PRE>
488public void <B>setPassword</B>(java.lang.String&nbsp;password)</PRE>
489<DL>
490<DD>Sets the password for the user.
491<P>
492<DD><DL>
493</DL>
494</DD>
495<DD><DL>
496<DT><B>Parameters:</B><DD><CODE>password</CODE> - The new password value</DL>
497</DD>
498</DL>
499<HR>
500
501<A NAME="setKeyfile(java.lang.String)"><!-- --></A><H3>
502setKeyfile</H3>
503<PRE>
504public void <B>setKeyfile</B>(java.lang.String&nbsp;keyfile)</PRE>
505<DL>
506<DD>Sets the keyfile for the user.
507<P>
508<DD><DL>
509</DL>
510</DD>
511<DD><DL>
512<DT><B>Parameters:</B><DD><CODE>keyfile</CODE> - The new keyfile value</DL>
513</DD>
514</DL>
515<HR>
516
517<A NAME="setPassphrase(java.lang.String)"><!-- --></A><H3>
518setPassphrase</H3>
519<PRE>
520public void <B>setPassphrase</B>(java.lang.String&nbsp;passphrase)</PRE>
521<DL>
522<DD>Sets the passphrase for the users key.
523<P>
524<DD><DL>
525</DL>
526</DD>
527<DD><DL>
528<DT><B>Parameters:</B><DD><CODE>passphrase</CODE> - The new passphrase value</DL>
529</DD>
530</DL>
531<HR>
532
533<A NAME="setKnownhosts(java.lang.String)"><!-- --></A><H3>
534setKnownhosts</H3>
535<PRE>
536public void <B>setKnownhosts</B>(java.lang.String&nbsp;knownHosts)</PRE>
537<DL>
538<DD>Sets the path to the file that has the identities of
539 all known hosts. This is used by SSH protocol to validate
540 the identity of the host. The default is
541 <i>${user.home}/.ssh/known_hosts</i>.
542<P>
543<DD><DL>
544</DL>
545</DD>
546<DD><DL>
547<DT><B>Parameters:</B><DD><CODE>knownHosts</CODE> - a path to the known hosts file.</DL>
548</DD>
549</DL>
550<HR>
551
552<A NAME="setTrust(boolean)"><!-- --></A><H3>
553setTrust</H3>
554<PRE>
555public void <B>setTrust</B>(boolean&nbsp;yesOrNo)</PRE>
556<DL>
557<DD>Setting this to true trusts hosts whose identity is unknown.
558<P>
559<DD><DL>
560</DL>
561</DD>
562<DD><DL>
563<DT><B>Parameters:</B><DD><CODE>yesOrNo</CODE> - if true trust the identity of unknown hosts.</DL>
564</DD>
565</DL>
566<HR>
567
568<A NAME="setPort(int)"><!-- --></A><H3>
569setPort</H3>
570<PRE>
571public void <B>setPort</B>(int&nbsp;port)</PRE>
572<DL>
573<DD>Changes the port used to connect to the remote host.
574<P>
575<DD><DL>
576</DL>
577</DD>
578<DD><DL>
579<DT><B>Parameters:</B><DD><CODE>port</CODE> - port number of remote host.</DL>
580</DD>
581</DL>
582<HR>
583
584<A NAME="getPort()"><!-- --></A><H3>
585getPort</H3>
586<PRE>
587public int <B>getPort</B>()</PRE>
588<DL>
589<DD><DL>
590</DL>
591</DD>
592<DD><DL>
593</DL>
594</DD>
595</DL>
596<HR>
597
598<A NAME="init()"><!-- --></A><H3>
599init</H3>
600<PRE>
601public void <B>init</B>()
602 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
603<DL>
604<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>
605<DD>Called by the project to let the task initialize properly.
606 The default implementation is a no-op.
607<P>
608<DD><DL>
609<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#init()">init</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
610</DD>
611<DD><DL>
612
613<DT><B>Throws:</B>
614<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>
615</DD>
616</DL>
617<HR>
618
619<A NAME="openSession()"><!-- --></A><H3>
620openSession</H3>
621<PRE>
622protected Session <B>openSession</B>()
623 throws JSchException</PRE>
624<DL>
625<DD><DL>
626</DL>
627</DD>
628<DD><DL>
629
630<DT><B>Throws:</B>
631<DD><CODE>JSchException</CODE></DL>
632</DD>
633</DL>
634<HR>
635
636<A NAME="getUserInfo()"><!-- --></A><H3>
637getUserInfo</H3>
638<PRE>
639protected <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHUserInfo</A> <B>getUserInfo</B>()</PRE>
640<DL>
641<DD><DL>
642</DL>
643</DD>
644<DD><DL>
645</DL>
646</DD>
647</DL>
648<!-- ========= END OF CLASS DATA ========= -->
649<HR>
650
651
652<!-- ======= START OF BOTTOM NAVBAR ====== -->
653<A NAME="navbar_bottom"><!-- --></A>
654<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
655<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
656<TR>
657<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
658<A NAME="navbar_bottom_firstrow"><!-- --></A>
659<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
660 <TR ALIGN="center" VALIGN="top">
661 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
662 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
663 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
664 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
665 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
666 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
667 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
668 </TR>
669</TABLE>
670</TD>
671<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
672</EM>
673</TD>
674</TR>
675
676<TR>
677<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
678&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>PREV CLASS</B></A>&nbsp;
679&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>NEXT CLASS</B></A></FONT></TD>
680<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
681 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
682&nbsp;<A HREF="SSHBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
683&nbsp;<SCRIPT type="text/javascript">
684 <!--
685 if(window==top) {
686 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
687 }
688 //-->
689</SCRIPT>
690<NOSCRIPT>
691 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
692</NOSCRIPT>
693
694</FONT></TD>
695</TR>
696<TR>
697<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
698 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>
699<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
700DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
701</TR>
702</TABLE>
703<A NAME="skip-navbar_bottom"></A>
704<!-- ======== END OF BOTTOM NAVBAR ======= -->
705
706<HR>
707Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
708</BODY>
709</HTML>
Note: See TracBrowser for help on using the repository browser.