????
Your IP : 216.73.216.152
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:54 CEST 2012 -->
<title>Scp (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Scp (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/ssh/Scp.html" target="_top">Frames</a></li>
<li><a href="Scp.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.tools.ant.Task">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs.optional.ssh</div>
<h2 title="Class Scp" class="title">Class Scp</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</a></li>
<li>
<ul class="inheritance">
<li><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></li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.ssh.Scp</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Scp</span>
extends <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">SSHBase</a></pre>
<div class="block">Ant task for sending files to remote machine over ssh/scp.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>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></h3>
<code><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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#Scp()">Scp</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</a></strong>(<a href="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a> set)</code>
<div class="block">Adds a FileSet tranfer to remote host.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#execute()">execute</a></strong>()</code>
<div class="block">Execute this task.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#init()">init</a></strong>()</code>
<div class="block">Initialize this task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setFile(java.lang.String)">setFile</a></strong>(java.lang.String aFromUri)</code>
<div class="block">Sets the file to be transferred.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setLocalFile(java.lang.String)">setLocalFile</a></strong>(java.lang.String aFromUri)</code>
<div class="block">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
the file is a local file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setLocalTodir(java.lang.String)">setLocalTodir</a></strong>(java.lang.String aToUri)</code>
<div class="block">Similiar to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><code>setTodir</code></a> but explicitly states
that the directory is a local.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setLocalTofile(java.lang.String)">setLocalTofile</a></strong>(java.lang.String aToUri)</code>
<div class="block">Changes the file name to the given name while receiving it,
only useful if receiving a single file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setPreservelastmodified(boolean)">setPreservelastmodified</a></strong>(boolean yesOrNo)</code>
<div class="block">Sets flag to determine if file timestamp from
remote system is to be preserved during copy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setRemoteFile(java.lang.String)">setRemoteFile</a></strong>(java.lang.String aFromUri)</code>
<div class="block">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
the file is a remote file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setRemoteTodir(java.lang.String)">setRemoteTodir</a></strong>(java.lang.String aToUri)</code>
<div class="block">Similiar to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><code>setTodir</code></a> but explicitly states
that the directory is a remote.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setRemoteTofile(java.lang.String)">setRemoteTofile</a></strong>(java.lang.String aToUri)</code>
<div class="block">Changes the file name to the given name while sending it,
only useful if sending a single file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setSftp(boolean)">setSftp</a></strong>(boolean yesOrNo)</code>
<div class="block">Setting this to true to use sftp protocol.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)">setTodir</a></strong>(java.lang.String aToUri)</code>
<div class="block">Sets the location where files will be transferred to.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.SSHBase">
<!-- -->
</a>
<h3>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></h3>
<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/Task.html#bindToOwner(org.apache.tools.ant.Task)">bindToOwner</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#log(java.lang.String, java.lang.Throwable, int)">log</a>, <a href="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.Throwable, 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#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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</a>, <a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.LogListener">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html#log(java.lang.String)">log</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Scp()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Scp</h4>
<pre>public Scp()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFile</h4>
<pre>public void setFile(java.lang.String aFromUri)</pre>
<div class="block">Sets the file to be transferred. This can either be a remote
file or a local file. Remote files take the form:<br>
<i>user:password@host:/directory/path/file.example</i><br>
Files to transfer can also include a wildcard to include all
files in a remote directory. For example:<br>
<i>user:password@host:/directory/path/*</i><br></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aFromUri</code> - a string representing the file to transfer.</dd></dl>
</li>
</ul>
<a name="setTodir(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTodir</h4>
<pre>public void setTodir(java.lang.String aToUri)</pre>
<div class="block">Sets the location where files will be transferred to.
This can either be a remote directory or a local directory.
Remote directories take the form of:<br>
<i>user:password@host:/directory/path/</i><br>
This parameter is required.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aToUri</code> - a string representing the target of the copy.</dd></dl>
</li>
</ul>
<a name="setLocalFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalFile</h4>
<pre>public void setLocalFile(java.lang.String aFromUri)</pre>
<div class="block">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
the file is a local file. This is the only way to specify a
local file with a @ character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aFromUri</code> - a string representing the source of the copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="setRemoteFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemoteFile</h4>
<pre>public void setRemoteFile(java.lang.String aFromUri)</pre>
<div class="block">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
the file is a remote file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aFromUri</code> - a string representing the source of the copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="setLocalTodir(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalTodir</h4>
<pre>public void setLocalTodir(java.lang.String aToUri)</pre>
<div class="block">Similiar to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><code>setTodir</code></a> but explicitly states
that the directory is a local. This is the only way to specify
a local directory with a @ character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aToUri</code> - a string representing the target of the copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="setPreservelastmodified(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreservelastmodified</h4>
<pre>public void setPreservelastmodified(boolean yesOrNo)</pre>
<div class="block">Sets flag to determine if file timestamp from
remote system is to be preserved during copy.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.8.0</dd></dl>
</li>
</ul>
<a name="setRemoteTodir(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemoteTodir</h4>
<pre>public void setRemoteTodir(java.lang.String aToUri)</pre>
<div class="block">Similiar to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Scp.html#setTodir(java.lang.String)"><code>setTodir</code></a> but explicitly states
that the directory is a remote.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aToUri</code> - a string representing the target of the copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="setLocalTofile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalTofile</h4>
<pre>public void setLocalTofile(java.lang.String aToUri)</pre>
<div class="block">Changes the file name to the given name while receiving it,
only useful if receiving a single file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aToUri</code> - a string representing the target of the copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="setRemoteTofile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemoteTofile</h4>
<pre>public void setRemoteTofile(java.lang.String aToUri)</pre>
<div class="block">Changes the file name to the given name while sending it,
only useful if sending a single file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aToUri</code> - a string representing the target of the copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="setSftp(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSftp</h4>
<pre>public void setSftp(boolean yesOrNo)</pre>
<div class="block">Setting this to true to use sftp protocol.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>yesOrNo</code> - if true sftp protocol will be used.</dd></dl>
</li>
</ul>
<a name="addFileset(org.apache.tools.ant.types.FileSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFileset</h4>
<pre>public void addFileset(<a href="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a> set)</pre>
<div class="block">Adds a FileSet tranfer to remote host. NOTE: Either
addFileSet() or setFile() are required. But, not both.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>set</code> - FileSet to send to remote host.</dd></dl>
</li>
</ul>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init()
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Initialize this task.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<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></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - on error</dd></dl>
</li>
</ul>
<a name="execute()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Execute this task.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<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></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - on error</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/ssh/Scp.html" target="_top">Frames</a></li>
<li><a href="Scp.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.tools.ant.Task">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>