????
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>ScpToMessage (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="ScpToMessage (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/ScpFromMessageBySftp.html" title="class 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/ScpToMessageBySftp.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/ScpToMessage.html" target="_top">Frames</a></li>
<li><a href="ScpToMessage.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>Field | </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 ScpToMessage" class="title">Class ScpToMessage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><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></li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">ScpToMessageBySftp</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ScpToMessage</span>
extends <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">AbstractSshMessage</a></pre>
<div class="block">Utility class to carry out an upload scp transfer.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/ScpToMessage.html#ScpToMessage(boolean, com.jcraft.jsch.Session)">ScpToMessage</a></strong>(boolean verbose,
com.jcraft.jsch.Session session)</code>
<div class="block">Constructor for ScpToMessage</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#ScpToMessage(boolean, com.jcraft.jsch.Session, java.io.File, java.lang.String)">ScpToMessage</a></strong>(boolean verbose,
com.jcraft.jsch.Session session,
java.io.File aLocalFile,
java.lang.String aRemotePath)</code>
<div class="block">Constructor for a local file to remote.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#ScpToMessage(boolean, com.jcraft.jsch.Session, java.util.List, java.lang.String)">ScpToMessage</a></strong>(boolean verbose,
com.jcraft.jsch.Session session,
java.util.List aDirectoryList,
java.lang.String aRemotePath)</code>
<div class="block">Constructor for a local directories to remote.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#ScpToMessage(com.jcraft.jsch.Session)">ScpToMessage</a></strong>(com.jcraft.jsch.Session session)</code>
<div class="block">Constructor for ScpToMessage</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#ScpToMessage(com.jcraft.jsch.Session, java.io.File, java.lang.String)">ScpToMessage</a></strong>(com.jcraft.jsch.Session session,
java.io.File aLocalFile,
java.lang.String aRemotePath)</code>
<div class="block">Constructor for ScpToMessage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#ScpToMessage(com.jcraft.jsch.Session, java.util.List, java.lang.String)">ScpToMessage</a></strong>(com.jcraft.jsch.Session session,
java.util.List aDirectoryList,
java.lang.String aRemotePath)</code>
<div class="block">Constructor for ScpToMessage.</div>
</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/ScpToMessage.html#execute()">execute</a></strong>()</code>
<div class="block">Carry out the transfer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#getLocalFile()">getLocalFile</a></strong>()</code>
<div class="block">Get the local file</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html#getRemotePath()">getRemotePath</a></strong>()</code>
<div class="block">Get the remote path</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage">
<!-- -->
</a>
<h3>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></h3>
<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></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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="ScpToMessage(com.jcraft.jsch.Session)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScpToMessage</h4>
<pre>public ScpToMessage(com.jcraft.jsch.Session session)</pre>
<div class="block">Constructor for ScpToMessage</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the ssh session to use</dd></dl>
</li>
</ul>
<a name="ScpToMessage(boolean, com.jcraft.jsch.Session)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScpToMessage</h4>
<pre>public ScpToMessage(boolean verbose,
com.jcraft.jsch.Session session)</pre>
<div class="block">Constructor for ScpToMessage</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbose</code> - if true do verbose logging</dd><dd><code>session</code> - the ssh session to use</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="ScpToMessage(boolean, com.jcraft.jsch.Session, java.io.File, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScpToMessage</h4>
<pre>public ScpToMessage(boolean verbose,
com.jcraft.jsch.Session session,
java.io.File aLocalFile,
java.lang.String aRemotePath)</pre>
<div class="block">Constructor for a local file to remote.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbose</code> - if true do verbose logging</dd><dd><code>session</code> - the scp session to use</dd><dd><code>aLocalFile</code> - the local file</dd><dd><code>aRemotePath</code> - the remote path</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="ScpToMessage(boolean, com.jcraft.jsch.Session, java.util.List, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScpToMessage</h4>
<pre>public ScpToMessage(boolean verbose,
com.jcraft.jsch.Session session,
java.util.List aDirectoryList,
java.lang.String aRemotePath)</pre>
<div class="block">Constructor for a local directories to remote.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbose</code> - if true do verbose logging</dd><dd><code>session</code> - the scp session to use</dd><dd><code>aDirectoryList</code> - a list of directories</dd><dd><code>aRemotePath</code> - the remote path</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="ScpToMessage(com.jcraft.jsch.Session, java.io.File, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScpToMessage</h4>
<pre>public ScpToMessage(com.jcraft.jsch.Session session,
java.io.File aLocalFile,
java.lang.String aRemotePath)</pre>
<div class="block">Constructor for ScpToMessage.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the scp session to use</dd><dd><code>aLocalFile</code> - the local file</dd><dd><code>aRemotePath</code> - the remote path</dd></dl>
</li>
</ul>
<a name="ScpToMessage(com.jcraft.jsch.Session, java.util.List, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ScpToMessage</h4>
<pre>public ScpToMessage(com.jcraft.jsch.Session session,
java.util.List aDirectoryList,
java.lang.String aRemotePath)</pre>
<div class="block">Constructor for ScpToMessage.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the scp session to use</dd><dd><code>aDirectoryList</code> - a list of directories</dd><dd><code>aRemotePath</code> - the remote path</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()
throws java.io.IOException,
com.jcraft.jsch.JSchException</pre>
<div class="block">Carry out the transfer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<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></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on i/o errors</dd>
<dd><code>com.jcraft.jsch.JSchException</code> - on errors detected by scp</dd></dl>
</li>
</ul>
<a name="getLocalFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalFile</h4>
<pre>public java.io.File getLocalFile()</pre>
<div class="block">Get the local file</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the local file</dd></dl>
</li>
</ul>
<a name="getRemotePath()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRemotePath</h4>
<pre>public java.lang.String getRemotePath()</pre>
<div class="block">Get the remote path</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote path</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/ScpFromMessageBySftp.html" title="class 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/ScpToMessageBySftp.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/ScpToMessage.html" target="_top">Frames</a></li>
<li><a href="ScpToMessage.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>Field | </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>