Google Git
Sign in
apache / mina-site / refs/heads/sshd-apidocs / . / org / apache / sshd / client / session / ClientSession.html
blob: 4693a85ef70982e650bfc4275c20b9951fde84f3 [file] [log] [blame]
<!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 (1.8.0_66) on Fri Jan 15 14:33:41 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientSession (Apache Mina SSHD :: Core 1.1.0 API)</title>
<meta name="date" content="2016-01-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClientSession (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="class-use/ClientSession.html">Use</a></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/sshd/client/session/ClientConnectionServiceFactory.html" title="class in org.apache.sshd.client.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/client/session/ClientSession.html" target="_top">Frames</a></li>
<li><a href="ClientSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.sshd.client.session</div>
<h2 title="Interface ClientSession" class="title">Interface ClientSession</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a>, <a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html" title="interface in org.apache.sshd.common.channel">ChannelListenerManager</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html" title="interface in org.apache.sshd.client">ClientAuthenticationManager</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html" title="interface in org.apache.sshd.common.kex">KexFactoryManager</a>, <a href="../../../../../org/apache/sshd/common/keyprovider/KeyPairProviderHolder.html" title="interface in org.apache.sshd.common.keyprovider">KeyPairProviderHolder</a>, <a href="../../../../../org/apache/sshd/common/auth/MutableUserHolder.html" title="interface in org.apache.sshd.common.auth">MutableUserHolder</a>, <a href="../../../../../org/apache/sshd/common/PropertyResolver.html" title="interface in org.apache.sshd.common">PropertyResolver</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a>, <a href="../../../../../org/apache/sshd/common/session/SessionListenerManager.html" title="interface in org.apache.sshd.common.session">SessionListenerManager</a>, <a href="../../../../../org/apache/sshd/common/signature/SignatureFactoriesManager.html" title="interface in org.apache.sshd.common.signature">SignatureFactoriesManager</a>, <a href="../../../../../org/apache/sshd/common/auth/UsernameHolder.html" title="interface in org.apache.sshd.common.auth">UsernameHolder</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/sshd/client/session/AbstractClientSession.html" title="class in org.apache.sshd.client.session">AbstractClientSession</a>, <a href="../../../../../org/apache/sshd/client/session/ClientSessionImpl.html" title="class in org.apache.sshd.client.session">ClientSessionImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClientSession</span>
extends <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html" title="interface in org.apache.sshd.client">ClientAuthenticationManager</a></pre>
<div class="block"><P>An authenticated session to a given SSH server</P>
<P>
A client session is established using the <a href="../../../../../org/apache/sshd/client/SshClient.html" title="class in org.apache.sshd.client"><code>SshClient</code></a>.
Once the session has been created, the user has to authenticate
using either <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPasswordIdentity-java.lang.String-"><code>ClientAuthenticationManager.addPasswordIdentity(String)</code></a> or
<a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPublicKeyIdentity-java.security.KeyPair-"><code>ClientAuthenticationManager.addPublicKeyIdentity(java.security.KeyPair)</code></a> followed by
a call to {$link #auth()}.
</P>
<P>
From this session, channels can be created using the
<a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createChannel-java.lang.String-"><code>createChannel(String)</code></a> method. Multiple channels can
be created on a given session concurrently.
</P>
<P>
When using the client in an interactive mode, the
<a href="../../../../../org/apache/sshd/client/session/ClientSession.html#waitFor-java.util.Collection-long-"><code>waitFor(Collection, long)</code></a> method can be used to listen to specific
events such as the session being established, authenticated or closed.
</P>
When a given session is no longer used, it must be closed using the
<a href="../../../../../org/apache/sshd/common/Closeable.html#close-boolean-"><code>Closeable.close(boolean)</code></a> method.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session">ClientSession.ClientSessionEvent</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.sshd.common.session.Session">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.sshd.common.session.<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a></h3>
<code><a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session">Session.AttributeKey</a>&lt;<a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="type parameter in Session.AttributeKey">T</a>&gt;, <a href="../../../../../org/apache/sshd/common/session/Session.TimeoutStatus.html" title="enum in org.apache.sshd.common.session">Session.TimeoutStatus</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.sshd.common.signature.SignatureFactoriesManager">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.sshd.common.signature.<a href="../../../../../org/apache/sshd/common/signature/SignatureFactoriesManager.html" title="interface in org.apache.sshd.common.signature">SignatureFactoriesManager</a></h3>
<code><a href="../../../../../org/apache/sshd/common/signature/SignatureFactoriesManager.Utils.html" title="class in org.apache.sshd.common.signature">SignatureFactoriesManager.Utils</a></code></li>
</ul>
</li>
</ul>
<!-- =========== 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.sshd.common.session.Session">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.sshd.common.session.<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a></h3>
<code><a href="../../../../../org/apache/sshd/common/session/Session.html#DEFAULT_SSH_VERSION_PREFIX">DEFAULT_SSH_VERSION_PREFIX</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.client.ClientAuthenticationManager">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.sshd.client.<a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html" title="interface in org.apache.sshd.client">ClientAuthenticationManager</a></h3>
<code><a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#DEFAULT_PASSWORD_PROMPTS">DEFAULT_PASSWORD_PROMPTS</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#PASSWORD_PROMPTS">PASSWORD_PROMPTS</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#PREFERRED_AUTHS">PREFERRED_AUTHS</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/future/AuthFuture.html" title="interface in org.apache.sshd.client.future">AuthFuture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#auth--">auth</a></span>()</code>
<div class="block">Starts the authentication process.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel">ClientChannel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createChannel-java.lang.String-">createChannel</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</code>
<div class="block">Create a channel of the given type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel">ClientChannel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createChannel-java.lang.String-java.lang.String-">createChannel</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subType)</code>
<div class="block">Create a channel of the given type and sub-type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/channel/ChannelDirectTcpip.html" title="class in org.apache.sshd.client.channel">ChannelDirectTcpip</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createDirectTcpipChannel-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.SshdSocketAddress-">createDirectTcpipChannel</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local,
<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote)</code>
<div class="block">Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/channel/ChannelExec.html" title="class in org.apache.sshd.client.channel">ChannelExec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createExecChannel-java.lang.String-">createExecChannel</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;command)</code>
<div class="block">Create a channel to execute a command.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/scp/ScpClient.html" title="interface in org.apache.sshd.client.scp">ScpClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createScpClient--">createScpClient</a></span>()</code>
<div class="block">Create an SCP client from this session.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/scp/ScpClient.html" title="interface in org.apache.sshd.client.scp">ScpClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createScpClient-org.apache.sshd.common.scp.ScpTransferEventListener-">createScpClient</a></span>(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</code>
<div class="block">Create an SCP client from this session.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpClient--">createSftpClient</a></span>()</code>
<div class="block">Create an SFTP client from this session.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpClient-int-">createSftpClient</a></span>(int&nbsp;version)</code>
<div class="block">Creates an SFTP client using the specified version</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpClient-org.apache.sshd.client.subsystem.sftp.SftpVersionSelector-">createSftpClient</a></span>(<a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpVersionSelector</a>&nbsp;selector)</code>
<div class="block">Creates an SFTP client while allowing the selection of a specific version</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpFileSystem--">createSftpFileSystem</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpFileSystem-int-">createSftpFileSystem</a></span>(int&nbsp;version)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpFileSystem-int-int-">createSftpFileSystem</a></span>(int&nbsp;readBufferSize,
int&nbsp;writeBufferSize)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpFileSystem-int-int-int-">createSftpFileSystem</a></span>(int&nbsp;version,
int&nbsp;readBufferSize,
int&nbsp;writeBufferSize)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpFileSystem-org.apache.sshd.client.subsystem.sftp.SftpVersionSelector-">createSftpFileSystem</a></span>(<a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpVersionSelector</a>&nbsp;selector)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSftpFileSystem-org.apache.sshd.client.subsystem.sftp.SftpVersionSelector-int-int-">createSftpFileSystem</a></span>(<a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpVersionSelector</a>&nbsp;selector,
int&nbsp;readBufferSize,
int&nbsp;writeBufferSize)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/channel/ChannelShell.html" title="class in org.apache.sshd.client.channel">ChannelShell</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createShellChannel--">createShellChannel</a></span>()</code>
<div class="block">Create a channel to start a shell.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/channel/ChannelSubsystem.html" title="class in org.apache.sshd.client.channel">ChannelSubsystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createSubsystemChannel-java.lang.String-">createSubsystemChannel</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subsystem)</code>
<div class="block">Create a subsystem channel.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/client/ClientFactoryManager.html" title="interface in org.apache.sshd.client">ClientFactoryManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#getFactoryManager--">getFactoryManager</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#getMetadataMap--">getMetadataMap</a></span>()</code>
<div class="block">Access to the metadata.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#getScpTransferEventListener--">getScpTransferEventListener</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#setScpTransferEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-">setScpTransferEventListener</a></span>(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#startDynamicPortForwarding-org.apache.sshd.common.SshdSocketAddress-">startDynamicPortForwarding</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)</code>
<div class="block">Start dynamic local port forwarding using a SOCKS proxy.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#startLocalPortForwarding-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.SshdSocketAddress-">startLocalPortForwarding</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local,
<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote)</code>
<div class="block">Start forwarding the given local address on the client to the given address on the server.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#startRemotePortForwarding-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.SshdSocketAddress-">startRemotePortForwarding</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote,
<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)</code>
<div class="block">
Start forwarding tcpip from the given address on the server to the
given address on the client.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#stopDynamicPortForwarding-org.apache.sshd.common.SshdSocketAddress-">stopDynamicPortForwarding</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)</code>
<div class="block">Stop a previously started dynamic port forwarding.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#stopLocalPortForwarding-org.apache.sshd.common.SshdSocketAddress-">stopLocalPortForwarding</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)</code>
<div class="block">Stop forwarding the given local address.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#stopRemotePortForwarding-org.apache.sshd.common.SshdSocketAddress-">stopRemotePortForwarding</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote)</code>
<div class="block">Stop forwarding of the given remote address.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/future/KeyExchangeFuture.html" title="interface in org.apache.sshd.common.future">KeyExchangeFuture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#switchToNoneCipher--">switchToNoneCipher</a></span>()</code>
<div class="block">Switch to a none cipher for performance.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session">ClientSession.ClientSessionEvent</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#waitFor-java.util.Collection-long-">waitFor</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session">ClientSession.ClientSessionEvent</a>&gt;&nbsp;mask,
long&nbsp;timeout)</code>
<div class="block">Wait for any one of a specific state to be signaled.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.session.Session">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.session.<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a></h3>
<code><a href="../../../../../org/apache/sshd/common/session/Session.html#createBuffer-byte-">createBuffer</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#createBuffer-byte-int-">createBuffer</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#disconnect-int-java.lang.String-">disconnect</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#exceptionCaught-java.lang.Throwable-">exceptionCaught</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getAttribute-org.apache.sshd.common.session.Session.AttributeKey-">getAttribute</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getAuthTimeout--">getAuthTimeout</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getCipherInformation-boolean-">getCipherInformation</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getClientVersion--">getClientVersion</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getCompressionInformation-boolean-">getCompressionInformation</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getIdleTimeout--">getIdleTimeout</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getIoSession--">getIoSession</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getKex--">getKex</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getMacInformation-boolean-">getMacInformation</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getNegotiatedKexParameter-org.apache.sshd.common.kex.KexProposalOption-">getNegotiatedKexParameter</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getServerVersion--">getServerVersion</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getService-java.lang.Class-">getService</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getSessionId--">getSessionId</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#getTimeoutStatus--">getTimeoutStatus</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#isAuthenticated--">isAuthenticated</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#prepareBuffer-byte-org.apache.sshd.common.util.buffer.Buffer-">prepareBuffer</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#reExchangeKeys--">reExchangeKeys</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#request-org.apache.sshd.common.util.buffer.Buffer-long-java.util.concurrent.TimeUnit-">request</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#resetIdleTimeout--">resetIdleTimeout</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#setAttribute-org.apache.sshd.common.session.Session.AttributeKey-E-">setAttribute</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#setAuthenticated--">setAuthenticated</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#startService-java.lang.String-">startService</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#writePacket-org.apache.sshd.common.util.buffer.Buffer-">writePacket</a>, <a href="../../../../../org/apache/sshd/common/session/Session.html#writePacket-org.apache.sshd.common.util.buffer.Buffer-long-java.util.concurrent.TimeUnit-">writePacket</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.kex.KexFactoryManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.kex.<a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html" title="interface in org.apache.sshd.common.kex">KexFactoryManager</a></h3>
<code><a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#getCipherFactories--">getCipherFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#getCompressionFactories--">getCompressionFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#getKeyExchangeFactories--">getKeyExchangeFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#getMacFactories--">getMacFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#setCipherFactories-java.util.List-">setCipherFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#setCompressionFactories-java.util.List-">setCompressionFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#setKeyExchangeFactories-java.util.List-">setKeyExchangeFactories</a>, <a href="../../../../../org/apache/sshd/common/kex/KexFactoryManager.html#setMacFactories-java.util.List-">setMacFactories</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.keyprovider.KeyPairProviderHolder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.keyprovider.<a href="../../../../../org/apache/sshd/common/keyprovider/KeyPairProviderHolder.html" title="interface in org.apache.sshd.common.keyprovider">KeyPairProviderHolder</a></h3>
<code><a href="../../../../../org/apache/sshd/common/keyprovider/KeyPairProviderHolder.html#getKeyPairProvider--">getKeyPairProvider</a>, <a href="../../../../../org/apache/sshd/common/keyprovider/KeyPairProviderHolder.html#setKeyPairProvider-org.apache.sshd.common.keyprovider.KeyPairProvider-">setKeyPairProvider</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.signature.SignatureFactoriesManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.signature.<a href="../../../../../org/apache/sshd/common/signature/SignatureFactoriesManager.html" title="interface in org.apache.sshd.common.signature">SignatureFactoriesManager</a></h3>
<code><a href="../../../../../org/apache/sshd/common/signature/SignatureFactoriesManager.html#getSignatureFactories--">getSignatureFactories</a>, <a href="../../../../../org/apache/sshd/common/signature/SignatureFactoriesManager.html#setSignatureFactories-java.util.List-">setSignatureFactories</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.session.SessionListenerManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.session.<a href="../../../../../org/apache/sshd/common/session/SessionListenerManager.html" title="interface in org.apache.sshd.common.session">SessionListenerManager</a></h3>
<code><a href="../../../../../org/apache/sshd/common/session/SessionListenerManager.html#addSessionListener-org.apache.sshd.common.session.SessionListener-">addSessionListener</a>, <a href="../../../../../org/apache/sshd/common/session/SessionListenerManager.html#getSessionListenerProxy--">getSessionListenerProxy</a>, <a href="../../../../../org/apache/sshd/common/session/SessionListenerManager.html#removeSessionListener-org.apache.sshd.common.session.SessionListener-">removeSessionListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.channel.ChannelListenerManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.channel.<a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html" title="interface in org.apache.sshd.common.channel">ChannelListenerManager</a></h3>
<code><a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html#addChannelListener-org.apache.sshd.common.channel.ChannelListener-">addChannelListener</a>, <a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html#getChannelListenerProxy--">getChannelListenerProxy</a>, <a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html#removeChannelListener-org.apache.sshd.common.channel.ChannelListener-">removeChannelListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.PropertyResolver">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.<a href="../../../../../org/apache/sshd/common/PropertyResolver.html" title="interface in org.apache.sshd.common">PropertyResolver</a></h3>
<code><a href="../../../../../org/apache/sshd/common/PropertyResolver.html#getParentPropertyResolver--">getParentPropertyResolver</a>, <a href="../../../../../org/apache/sshd/common/PropertyResolver.html#getProperties--">getProperties</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.Closeable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.<a href="../../../../../org/apache/sshd/common/Closeable.html" title="interface in org.apache.sshd.common">Closeable</a></h3>
<code><a href="../../../../../org/apache/sshd/common/Closeable.html#close-boolean-">close</a>, <a href="../../../../../org/apache/sshd/common/Closeable.html#isClosed--">isClosed</a>, <a href="../../../../../org/apache/sshd/common/Closeable.html#isClosing--">isClosing</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.nio.channels.Channel">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.nio.channels.<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#close--" title="class or interface in java.nio.channels">close</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#isOpen--" title="class or interface in java.nio.channels">isOpen</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.auth.MutableUserHolder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.auth.<a href="../../../../../org/apache/sshd/common/auth/MutableUserHolder.html" title="interface in org.apache.sshd.common.auth">MutableUserHolder</a></h3>
<code><a href="../../../../../org/apache/sshd/common/auth/MutableUserHolder.html#setUsername-java.lang.String-">setUsername</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.auth.UsernameHolder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.auth.<a href="../../../../../org/apache/sshd/common/auth/UsernameHolder.html" title="interface in org.apache.sshd.common.auth">UsernameHolder</a></h3>
<code><a href="../../../../../org/apache/sshd/common/auth/UsernameHolder.html#getUsername--">getUsername</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.client.ClientAuthenticationManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.client.<a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html" title="interface in org.apache.sshd.client">ClientAuthenticationManager</a></h3>
<code><a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPasswordIdentity-java.lang.String-">addPasswordIdentity</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPublicKeyIdentity-java.security.KeyPair-">addPublicKeyIdentity</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#getPasswordIdentityProvider--">getPasswordIdentityProvider</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#getRegisteredIdentities--">getRegisteredIdentities</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#getServerKeyVerifier--">getServerKeyVerifier</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#getUserAuthFactories--">getUserAuthFactories</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#getUserInteraction--">getUserInteraction</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#removePasswordIdentity-java.lang.String-">removePasswordIdentity</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#removePublicKeyIdentity-java.security.KeyPair-">removePublicKeyIdentity</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#setPasswordIdentityProvider-org.apache.sshd.client.auth.password.PasswordIdentityProvider-">setPasswordIdentityProvider</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#setServerKeyVerifier-org.apache.sshd.client.keyverifier.ServerKeyVerifier-">setServerKeyVerifier</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#setUserAuthFactories-java.util.List-">setUserAuthFactories</a>, <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#setUserInteraction-org.apache.sshd.client.auth.keyboard.UserInteraction-">setUserInteraction</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="auth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>auth</h4>
<pre><a href="../../../../../org/apache/sshd/client/future/AuthFuture.html" title="interface in org.apache.sshd.client.future">AuthFuture</a>&nbsp;auth()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Starts the authentication process.
User identities will be tried until the server successfully authenticate the user.
User identities must be provided before calling this method using
<a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPasswordIdentity-java.lang.String-"><code>ClientAuthenticationManager.addPasswordIdentity(String)</code></a> or <a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPublicKeyIdentity-java.security.KeyPair-"><code>ClientAuthenticationManager.addPublicKeyIdentity(java.security.KeyPair)</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authentication future</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if failed to generate the future</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPasswordIdentity-java.lang.String-"><code>ClientAuthenticationManager.addPasswordIdentity(String)</code></a>,
<a href="../../../../../org/apache/sshd/client/ClientAuthenticationManager.html#addPublicKeyIdentity-java.security.KeyPair-"><code>ClientAuthenticationManager.addPublicKeyIdentity(java.security.KeyPair)</code></a></dd>
</dl>
</li>
</ul>
<a name="createChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChannel</h4>
<pre><a href="../../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel">ClientChannel</a>&nbsp;createChannel(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create a channel of the given type.
Same as calling <code>createChannel(type, null)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The channel type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel"><code>ClientChannel</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested channel</dd>
</dl>
</li>
</ul>
<a name="createChannel-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChannel</h4>
<pre><a href="../../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel">ClientChannel</a>&nbsp;createChannel(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subType)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create a channel of the given type and sub-type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The channel type</dd>
<dd><code>subType</code> - The channel sub-type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel"><code>ClientChannel</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested channel</dd>
</dl>
</li>
</ul>
<a name="createShellChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createShellChannel</h4>
<pre><a href="../../../../../org/apache/sshd/client/channel/ChannelShell.html" title="class in org.apache.sshd.client.channel">ChannelShell</a>&nbsp;createShellChannel()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create a channel to start a shell.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/channel/ChannelShell.html" title="class in org.apache.sshd.client.channel"><code>ChannelShell</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested channel</dd>
</dl>
</li>
</ul>
<a name="createExecChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createExecChannel</h4>
<pre><a href="../../../../../org/apache/sshd/client/channel/ChannelExec.html" title="class in org.apache.sshd.client.channel">ChannelExec</a>&nbsp;createExecChannel(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;command)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create a channel to execute a command.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - The command to execute</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/channel/ChannelExec.html" title="class in org.apache.sshd.client.channel"><code>ChannelExec</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested channel</dd>
</dl>
</li>
</ul>
<a name="createSubsystemChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSubsystemChannel</h4>
<pre><a href="../../../../../org/apache/sshd/client/channel/ChannelSubsystem.html" title="class in org.apache.sshd.client.channel">ChannelSubsystem</a>&nbsp;createSubsystemChannel(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subsystem)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create a subsystem channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subsystem</code> - The subsystem name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/channel/ChannelSubsystem.html" title="class in org.apache.sshd.client.channel"><code>ChannelSubsystem</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested channel</dd>
</dl>
</li>
</ul>
<a name="createDirectTcpipChannel-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDirectTcpipChannel</h4>
<pre><a href="../../../../../org/apache/sshd/client/channel/ChannelDirectTcpip.html" title="class in org.apache.sshd.client.channel">ChannelDirectTcpip</a>&nbsp;createDirectTcpipChannel(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local,
<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>local</code> - The local address</dd>
<dd><code>remote</code> - The remote address</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/channel/ChannelDirectTcpip.html" title="class in org.apache.sshd.client.channel"><code>ChannelDirectTcpip</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested channel</dd>
</dl>
</li>
</ul>
<a name="createScpClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createScpClient</h4>
<pre><a href="../../../../../org/apache/sshd/client/scp/ScpClient.html" title="interface in org.apache.sshd.client.scp">ScpClient</a>&nbsp;createScpClient()</pre>
<div class="block">Create an SCP client from this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="../../../../../org/apache/sshd/client/scp/ScpClient.html" title="interface in org.apache.sshd.client.scp"><code>ScpClient</code></a> instance. <B>Note:</B> uses the currently
registered <a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp"><code>ScpTransferEventListener</code></a> if any</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#setScpTransferEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-"><code>setScpTransferEventListener(ScpTransferEventListener)</code></a></dd>
</dl>
</li>
</ul>
<a name="createScpClient-org.apache.sshd.common.scp.ScpTransferEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createScpClient</h4>
<pre><a href="../../../../../org/apache/sshd/client/scp/ScpClient.html" title="interface in org.apache.sshd.client.scp">ScpClient</a>&nbsp;createScpClient(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</pre>
<div class="block">Create an SCP client from this session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - A <a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp"><code>ScpTransferEventListener</code></a> that can be used
to receive information about the SCP operations - may be <code>null</code>
to indicate no more events are required. <B>Note:</B> this listener
is used <U>instead</U> of any listener set via <a href="../../../../../org/apache/sshd/client/session/ClientSession.html#setScpTransferEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-"><code>setScpTransferEventListener(ScpTransferEventListener)</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="../../../../../org/apache/sshd/client/scp/ScpClient.html" title="interface in org.apache.sshd.client.scp"><code>ScpClient</code></a> instance</dd>
</dl>
</li>
</ul>
<a name="getScpTransferEventListener--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScpTransferEventListener</h4>
<pre><a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;getScpTransferEventListener()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The last <a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp"><code>ScpTransferEventListener</code></a> set via
<a href="../../../../../org/apache/sshd/client/session/ClientSession.html#setScpTransferEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-"><code>setScpTransferEventListener(ScpTransferEventListener)</code></a></dd>
</dl>
</li>
</ul>
<a name="setScpTransferEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScpTransferEventListener</h4>
<pre>void&nbsp;setScpTransferEventListener(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - A default <a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp"><code>ScpTransferEventListener</code></a> that can be used
to receive information about the SCP operations - may be <code>null</code>
to indicate no more events are required</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/client/session/ClientSession.html#createScpClient-org.apache.sshd.common.scp.ScpTransferEventListener-"><code>createScpClient(ScpTransferEventListener)</code></a></dd>
</dl>
</li>
</ul>
<a name="createSftpClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpClient</h4>
<pre><a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpClient</a>&nbsp;createSftpClient()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create an SFTP client from this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp"><code>SftpClient</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if failed to create the client</dd>
</dl>
</li>
</ul>
<a name="createSftpClient-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpClient</h4>
<pre><a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpClient</a>&nbsp;createSftpClient(int&nbsp;version)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates an SFTP client using the specified version</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - The version to use - <B>Note:</B> if the specified
version is not supported by the server then an exception
will occur</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp"><code>SftpClient</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the client or use the specified version</dd>
</dl>
</li>
</ul>
<a name="createSftpClient-org.apache.sshd.client.subsystem.sftp.SftpVersionSelector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpClient</h4>
<pre><a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpClient</a>&nbsp;createSftpClient(<a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpVersionSelector</a>&nbsp;selector)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates an SFTP client while allowing the selection of a specific version</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>selector</code> - The <a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp"><code>SftpVersionSelector</code></a> to use - <B>Note:</B>
if the server does not support versions re-negotiation then the
selector will be presented with only one &quot;choice&quot; - the
current version</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The created <a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpClient.html" title="interface in org.apache.sshd.client.subsystem.sftp"><code>SftpClient</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the client or re-negotiate</dd>
</dl>
</li>
</ul>
<a name="createSftpFileSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpFileSystem</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a>&nbsp;createSftpFileSystem()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="createSftpFileSystem-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpFileSystem</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a>&nbsp;createSftpFileSystem(int&nbsp;version)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="createSftpFileSystem-org.apache.sshd.client.subsystem.sftp.SftpVersionSelector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpFileSystem</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a>&nbsp;createSftpFileSystem(<a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpVersionSelector</a>&nbsp;selector)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="createSftpFileSystem-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpFileSystem</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a>&nbsp;createSftpFileSystem(int&nbsp;readBufferSize,
int&nbsp;writeBufferSize)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="createSftpFileSystem-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpFileSystem</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a>&nbsp;createSftpFileSystem(int&nbsp;version,
int&nbsp;readBufferSize,
int&nbsp;writeBufferSize)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="createSftpFileSystem-org.apache.sshd.client.subsystem.sftp.SftpVersionSelector-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSftpFileSystem</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html?is-external=true" title="class or interface in java.nio.file">FileSystem</a>&nbsp;createSftpFileSystem(<a href="../../../../../org/apache/sshd/client/subsystem/sftp/SftpVersionSelector.html" title="interface in org.apache.sshd.client.subsystem.sftp">SftpVersionSelector</a>&nbsp;selector,
int&nbsp;readBufferSize,
int&nbsp;writeBufferSize)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="startLocalPortForwarding-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startLocalPortForwarding</h4>
<pre><a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;startLocalPortForwarding(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local,
<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Start forwarding the given local address on the client to the given address on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>local</code> - The local address</dd>
<dd><code>remote</code> - The remote address</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bound <a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common"><code>SshdSocketAddress</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested binding</dd>
</dl>
</li>
</ul>
<a name="stopLocalPortForwarding-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopLocalPortForwarding</h4>
<pre>void&nbsp;stopLocalPortForwarding(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Stop forwarding the given local address.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>local</code> - The local address</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to cancel the requested binding</dd>
</dl>
</li>
</ul>
<a name="startRemotePortForwarding-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startRemotePortForwarding</h4>
<pre><a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;startRemotePortForwarding(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote,
<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><P>
Start forwarding tcpip from the given address on the server to the
given address on the client.
</P>
The remote host name is the address to bind to on the server:
<ul>
<li>"" means that connections are to be accepted on all protocol families
supported by the SSH implementation</li>
<li>"0.0.0.0" means to listen on all IPv4 addresses</li>
<li>"::" means to listen on all IPv6 addresses</li>
<li>"localhost" means to listen on all protocol families supported by the SSH
implementation on loopback addresses only, [RFC3330] and RFC3513]</li>
<li>"127.0.0.1" and "::1" indicate listening on the loopback interfaces for
IPv4 and IPv6 respectively</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>local</code> - The local address</dd>
<dd><code>remote</code> - The remote address</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bound <a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common"><code>SshdSocketAddress</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested binding</dd>
</dl>
</li>
</ul>
<a name="stopRemotePortForwarding-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopRemotePortForwarding</h4>
<pre>void&nbsp;stopRemotePortForwarding(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;remote)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Stop forwarding of the given remote address.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>remote</code> - The remote address</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to cancel the requested binding</dd>
</dl>
</li>
</ul>
<a name="startDynamicPortForwarding-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startDynamicPortForwarding</h4>
<pre><a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;startDynamicPortForwarding(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Start dynamic local port forwarding using a SOCKS proxy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>local</code> - The local address</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bound <a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common"><code>SshdSocketAddress</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the requested binding</dd>
</dl>
</li>
</ul>
<a name="stopDynamicPortForwarding-org.apache.sshd.common.SshdSocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopDynamicPortForwarding</h4>
<pre>void&nbsp;stopDynamicPortForwarding(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a>&nbsp;local)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Stop a previously started dynamic port forwarding.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>local</code> - The local address</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to cancel the requested binding</dd>
</dl>
</li>
</ul>
<a name="waitFor-java.util.Collection-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitFor</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session">ClientSession.ClientSessionEvent</a>&gt;&nbsp;waitFor(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session">ClientSession.ClientSessionEvent</a>&gt;&nbsp;mask,
long&nbsp;timeout)</pre>
<div class="block">Wait for any one of a specific state to be signaled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mask</code> - The request <a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session"><code>ClientSession.ClientSessionEvent</code></a>s mask</dd>
<dd><code>timeout</code> - Wait time in milliseconds - non-positive means forever</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The actual state that was detected either due to the mask
yielding one of the states or due to timeout (in which case the <a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html#TIMEOUT"><code>ClientSession.ClientSessionEvent.TIMEOUT</code></a>
value is set)</dd>
</dl>
</li>
</ul>
<a name="getMetadataMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadataMap</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getMetadataMap()</pre>
<div class="block">Access to the metadata.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The metadata <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a></dd>
</dl>
</li>
</ul>
<a name="getFactoryManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactoryManager</h4>
<pre><a href="../../../../../org/apache/sshd/client/ClientFactoryManager.html" title="interface in org.apache.sshd.client">ClientFactoryManager</a>&nbsp;getFactoryManager()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/session/Session.html#getFactoryManager--">getFactoryManager</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The ClientFactoryManager for this session.</dd>
</dl>
</li>
</ul>
<a name="switchToNoneCipher--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>switchToNoneCipher</h4>
<pre><a href="../../../../../org/apache/sshd/common/future/KeyExchangeFuture.html" title="interface in org.apache.sshd.common.future">KeyExchangeFuture</a>&nbsp;switchToNoneCipher()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><P>Switch to a none cipher for performance.</P>
<P>
This should be done after the authentication phase has been performed.
After such a switch, interactive channels are not allowed anymore.
Both client and server must have been configured to support the none cipher.
If that's not the case, the returned future will be set with an exception.
</P></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="../../../../../org/apache/sshd/common/future/KeyExchangeFuture.html" title="interface in org.apache.sshd.common.future"><code>KeyExchangeFuture</code></a> that can be used to wait for the exchange
to be finished</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if a key exchange is already running</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="class-use/ClientSession.html">Use</a></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/sshd/client/session/ClientConnectionServiceFactory.html" title="class in org.apache.sshd.client.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/client/session/ClientSession.ClientSessionEvent.html" title="enum in org.apache.sshd.client.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/client/session/ClientSession.html" target="_top">Frames</a></li>
<li><a href="ClientSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>