????

Your IP : 216.73.216.152

Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/
Upload File :
Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html

<!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>AbstractSshMessage (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="AbstractSshMessage (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>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.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/AbstractSshMessage.html" target="_top">Frames</a></li>
<li><a href="AbstractSshMessage.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 AbstractSshMessage" class="title">Class AbstractSshMessage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage</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/ScpFromMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">ScpFromMessage</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">ScpToMessage</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractSshMessage</span>
extends java.lang.Object</pre>
<div class="block">Abstract class for ssh upload and download</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">&nbsp;</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/AbstractSshMessage.html#AbstractSshMessage(boolean, com.jcraft.jsch.Session)">AbstractSshMessage</a></strong>(boolean&nbsp;verbose,
                  com.jcraft.jsch.Session&nbsp;session)</code>
<div class="block">Constructor for AbstractSshMessage</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#AbstractSshMessage(com.jcraft.jsch.Session)">AbstractSshMessage</a></strong>(com.jcraft.jsch.Session&nbsp;session)</code>
<div class="block">Constructor for AbstractSshMessage</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">&nbsp;</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>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#execute()">execute</a></strong>()</code>
<div class="block">Carry out the transfer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected com.jcraft.jsch.SftpProgressMonitor</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#getProgressMonitor()">getProgressMonitor</a></strong>()</code>
<div class="block">Get the progress monitor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#getVerbose()">getVerbose</a></strong>()</code>
<div class="block">Is the verbose attribute set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#log(java.lang.String)">log</a></strong>(java.lang.String&nbsp;message)</code>
<div class="block">Log a message to the log listener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#logStats(long, long, long)">logStats</a></strong>(long&nbsp;timeStarted,
        long&nbsp;timeEnded,
        long&nbsp;totalLength)</code>
<div class="block">Log transfer stats to the log listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected com.jcraft.jsch.Channel</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#openExecChannel(java.lang.String)">openExecChannel</a></strong>(java.lang.String&nbsp;command)</code>
<div class="block">Open an ssh channel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected com.jcraft.jsch.ChannelSftp</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#openSftpChannel()">openSftpChannel</a></strong>()</code>
<div class="block">Open an ssh sftp channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#sendAck(java.io.OutputStream)">sendAck</a></strong>(java.io.OutputStream&nbsp;out)</code>
<div class="block">Send an ack.</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/AbstractSshMessage.html#setLogListener(org.apache.tools.ant.taskdefs.optional.ssh.LogListener)">setLogListener</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</a>&nbsp;aListener)</code>
<div class="block">Set a log listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#trackProgress(long, long, int)">trackProgress</a></strong>(long&nbsp;filesize,
             long&nbsp;totalLength,
             int&nbsp;percentTransmitted)</code>
<div class="block">Track progress every 10% if 100kb < filesize < 1mb.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html#waitForAck(java.io.InputStream)">waitForAck</a></strong>(java.io.InputStream&nbsp;in)</code>
<div class="block">Reads the response, throws a BuildException if the response
 indicates an error.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;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="AbstractSshMessage(com.jcraft.jsch.Session)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractSshMessage</h4>
<pre>public&nbsp;AbstractSshMessage(com.jcraft.jsch.Session&nbsp;session)</pre>
<div class="block">Constructor for AbstractSshMessage</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the ssh session to use</dd></dl>
</li>
</ul>
<a name="AbstractSshMessage(boolean, com.jcraft.jsch.Session)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractSshMessage</h4>
<pre>public&nbsp;AbstractSshMessage(boolean&nbsp;verbose,
                  com.jcraft.jsch.Session&nbsp;session)</pre>
<div class="block">Constructor for AbstractSshMessage</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.6.2</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="openExecChannel(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openExecChannel</h4>
<pre>protected&nbsp;com.jcraft.jsch.Channel&nbsp;openExecChannel(java.lang.String&nbsp;command)
                                           throws com.jcraft.jsch.JSchException</pre>
<div class="block">Open an ssh channel.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - the command to use</dd>
<dt><span class="strong">Returns:</span></dt><dd>the channel</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.jcraft.jsch.JSchException</code> - on error</dd></dl>
</li>
</ul>
<a name="openSftpChannel()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openSftpChannel</h4>
<pre>protected&nbsp;com.jcraft.jsch.ChannelSftp&nbsp;openSftpChannel()
                                               throws com.jcraft.jsch.JSchException</pre>
<div class="block">Open an ssh sftp channel.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the channel</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.jcraft.jsch.JSchException</code> - on error</dd></dl>
</li>
</ul>
<a name="sendAck(java.io.OutputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendAck</h4>
<pre>protected&nbsp;void&nbsp;sendAck(java.io.OutputStream&nbsp;out)
                throws java.io.IOException</pre>
<div class="block">Send an ack.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the output stream to use</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on error</dd></dl>
</li>
</ul>
<a name="waitForAck(java.io.InputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitForAck</h4>
<pre>protected&nbsp;void&nbsp;waitForAck(java.io.InputStream&nbsp;in)
                   throws java.io.IOException,
                          <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Reads the response, throws a BuildException if the response
 indicates an error.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the input stream to use</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on I/O error</dd>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - on other errors</dd></dl>
</li>
</ul>
<a name="execute()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public abstract&nbsp;void&nbsp;execute()
                      throws java.io.IOException,
                             com.jcraft.jsch.JSchException</pre>
<div class="block">Carry out the transfer.</div>
<dl><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 ssh errors</dd></dl>
</li>
</ul>
<a name="setLogListener(org.apache.tools.ant.taskdefs.optional.ssh.LogListener)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogListener</h4>
<pre>public&nbsp;void&nbsp;setLogListener(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh">LogListener</a>&nbsp;aListener)</pre>
<div class="block">Set a log listener.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aListener</code> - the log listener</dd></dl>
</li>
</ul>
<a name="log(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>protected&nbsp;void&nbsp;log(java.lang.String&nbsp;message)</pre>
<div class="block">Log a message to the log listener.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd></dl>
</li>
</ul>
<a name="logStats(long, long, long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logStats</h4>
<pre>protected&nbsp;void&nbsp;logStats(long&nbsp;timeStarted,
            long&nbsp;timeEnded,
            long&nbsp;totalLength)</pre>
<div class="block">Log transfer stats to the log listener.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeStarted</code> - the time started</dd><dd><code>timeEnded</code> - the finishing time</dd><dd><code>totalLength</code> - the total length</dd></dl>
</li>
</ul>
<a name="getVerbose()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerbose</h4>
<pre>protected final&nbsp;boolean&nbsp;getVerbose()</pre>
<div class="block">Is the verbose attribute set.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the verbose attribute is set</dd><dt><span class="strong">Since:</span></dt>
  <dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="trackProgress(long, long, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trackProgress</h4>
<pre>protected final&nbsp;int&nbsp;trackProgress(long&nbsp;filesize,
                long&nbsp;totalLength,
                int&nbsp;percentTransmitted)</pre>
<div class="block">Track progress every 10% if 100kb < filesize < 1mb. For larger
 files track progress for every percent transmitted.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filesize</code> - the size of the file been transmitted</dd><dd><code>totalLength</code> - the total transmission size</dd><dd><code>percentTransmitted</code> - the current percent transmitted</dd>
<dt><span class="strong">Returns:</span></dt><dd>the percent that the file is of the total</dd></dl>
</li>
</ul>
<a name="getProgressMonitor()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProgressMonitor</h4>
<pre>protected&nbsp;com.jcraft.jsch.SftpProgressMonitor&nbsp;getProgressMonitor()</pre>
<div class="block">Get the progress monitor.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the progress monitor.</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>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.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/AbstractSshMessage.html" target="_top">Frames</a></li>
<li><a href="AbstractSshMessage.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>