Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\taskdefs\optional\ssh\ScpFromMessage.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
ScpFromMessage (Apache Ant API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="ScpFromMessage (Apache Ant API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&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;
&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ScpFromMessage.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>
<FONT SIZE="-1">
org.apache.tools.ant.taskdefs.optional.ssh</FONT>
<BR>
Class ScpFromMessage</H2>
<PRE>
java.lang.Object
  <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>
      <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">ScpFromMessageBySftp</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>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>
</PRE>

<P>
A helper object representing an scp download.
<P>

<P>

<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#ScpFromMessage(boolean, com.jcraft.jsch.Session)">ScpFromMessage</A></B>(boolean&nbsp;verbose,
               com.jcraft.jsch.Session&nbsp;session)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for ScpFromMessage</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#ScpFromMessage(boolean, com.jcraft.jsch.Session, java.lang.String, java.io.File, boolean)">ScpFromMessage</A></B>(boolean&nbsp;verbose,
               com.jcraft.jsch.Session&nbsp;session,
               java.lang.String&nbsp;aRemoteFile,
               java.io.File&nbsp;aLocalFile,
               boolean&nbsp;recursive)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for ScpFromMessage.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#ScpFromMessage(boolean, com.jcraft.jsch.Session, java.lang.String, java.io.File, boolean, boolean)">ScpFromMessage</A></B>(boolean&nbsp;verbose,
               com.jcraft.jsch.Session&nbsp;session,
               java.lang.String&nbsp;aRemoteFile,
               java.io.File&nbsp;aLocalFile,
               boolean&nbsp;recursive,
               boolean&nbsp;preserveLastModified)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for ScpFromMessage</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#ScpFromMessage(com.jcraft.jsch.Session, java.lang.String, java.io.File, boolean)">ScpFromMessage</A></B>(com.jcraft.jsch.Session&nbsp;session,
               java.lang.String&nbsp;aRemoteFile,
               java.io.File&nbsp;aLocalFile,
               boolean&nbsp;recursive)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for ScpFromMessage.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#execute()">execute</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Carry out the transfer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html#getPreserveLastModified()">getPreserveLastModified</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><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></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#getProgressMonitor()">getProgressMonitor</A>, <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, long)">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#openSftpChannel()">openSftpChannel</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(long, long, int)">trackProgress</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#waitForAck(java.io.InputStream)">waitForAck</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ScpFromMessage(com.jcraft.jsch.Session)"></A><H3>
ScpFromMessage</H3>
<PRE>
public <B>ScpFromMessage</B>(com.jcraft.jsch.Session&nbsp;session)</PRE>
<DL>
<DD>Constructor for ScpFromMessage
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the ssh session to use</DL>
</DL>
<HR>

<A NAME="ScpFromMessage(boolean, com.jcraft.jsch.Session)"></A><H3>
ScpFromMessage</H3>
<PRE>
public <B>ScpFromMessage</B>(boolean&nbsp;verbose,
                      com.jcraft.jsch.Session&nbsp;session)</PRE>
<DL>
<DD>Constructor for ScpFromMessage
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - if true do verbose logging<DD><CODE>session</CODE> - the ssh session to use<DT><B>Since:</B></DT>
  <DD>Ant 1.7</DD>
</DL>
</DL>
<HR>

<A NAME="ScpFromMessage(boolean, com.jcraft.jsch.Session, java.lang.String, java.io.File, boolean)"></A><H3>
ScpFromMessage</H3>
<PRE>
public <B>ScpFromMessage</B>(boolean&nbsp;verbose,
                      com.jcraft.jsch.Session&nbsp;session,
                      java.lang.String&nbsp;aRemoteFile,
                      java.io.File&nbsp;aLocalFile,
                      boolean&nbsp;recursive)</PRE>
<DL>
<DD>Constructor for ScpFromMessage.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - if true log extra information<DD><CODE>session</CODE> - the Scp session to use<DD><CODE>aRemoteFile</CODE> - the remote file name<DD><CODE>aLocalFile</CODE> - the local file<DD><CODE>recursive</CODE> - if true use recursion (-r option to scp)<DT><B>Since:</B></DT>
  <DD>Ant 1.6.2</DD>
</DL>
</DL>
<HR>

<A NAME="ScpFromMessage(com.jcraft.jsch.Session, java.lang.String, java.io.File, boolean)"></A><H3>
ScpFromMessage</H3>
<PRE>
public <B>ScpFromMessage</B>(com.jcraft.jsch.Session&nbsp;session,
                      java.lang.String&nbsp;aRemoteFile,
                      java.io.File&nbsp;aLocalFile,
                      boolean&nbsp;recursive)</PRE>
<DL>
<DD>Constructor for ScpFromMessage.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the Scp session to use<DD><CODE>aRemoteFile</CODE> - the remote file name<DD><CODE>aLocalFile</CODE> - the local file<DD><CODE>recursive</CODE> - if true use recursion (-r option to scp)</DL>
</DL>
<HR>

<A NAME="ScpFromMessage(boolean, com.jcraft.jsch.Session, java.lang.String, java.io.File, boolean, boolean)"></A><H3>
ScpFromMessage</H3>
<PRE>
public <B>ScpFromMessage</B>(boolean&nbsp;verbose,
                      com.jcraft.jsch.Session&nbsp;session,
                      java.lang.String&nbsp;aRemoteFile,
                      java.io.File&nbsp;aLocalFile,
                      boolean&nbsp;recursive,
                      boolean&nbsp;preserveLastModified)</PRE>
<DL>
<DD>Constructor for ScpFromMessage.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - if true log extra information<DD><CODE>session</CODE> - the Scp session to use<DD><CODE>aRemoteFile</CODE> - the remote file name<DD><CODE>aLocalFile</CODE> - the local file<DD><CODE>recursive</CODE> - if true use recursion (-r option to scp)<DD><CODE>preserveLastModified</CODE> - whether to preserve file
 modification times<DT><B>Since:</B></DT>
  <DD>Ant 1.8.0</DD>
</DL>
</DL>

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="execute()"></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>()
             throws java.io.IOException,
                    com.jcraft.jsch.JSchException</PRE>
<DL>
<DD>Carry out the transfer.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - on i/o errors
<DD><CODE>com.jcraft.jsch.JSchException</CODE> - on errors detected by scp</DL>
</DD>
</DL>
<HR>

<A NAME="getPreserveLastModified()"></A><H3>
getPreserveLastModified</H3>
<PRE>
protected boolean <B>getPreserveLastModified</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de