| <!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:43 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Session (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="Session (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}; |
| 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/Session.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/common/session/PendingWriteFuture.html" title="class in org.apache.sshd.common.session"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/session/Session.html" target="_top">Frames</a></li> |
| <li><a href="Session.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.common.session</div> |
| <h2 title="Interface Session" class="title">Interface Session</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="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/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 Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>, <a href="../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</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/server/session/AbstractServerSession.html" title="class in org.apache.sshd.server.session">AbstractServerSession</a>, <a href="../../../../../org/apache/sshd/common/session/AbstractSession.html" title="class in org.apache.sshd.common.session">AbstractSession</a>, <a href="../../../../../org/apache/sshd/client/session/ClientSessionImpl.html" title="class in org.apache.sshd.client.session">ClientSessionImpl</a>, <a href="../../../../../org/apache/sshd/server/session/ServerSessionImpl.html" title="class in org.apache.sshd.server.session">ServerSessionImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Session</span> |
| extends <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/session/SessionListenerManager.html" title="interface in org.apache.sshd.common.session">SessionListenerManager</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/common/PropertyResolver.html" title="interface in org.apache.sshd.common">PropertyResolver</a>, <a href="../../../../../org/apache/sshd/common/Closeable.html" title="interface in org.apache.sshd.common">Closeable</a>, <a href="../../../../../org/apache/sshd/common/auth/MutableUserHolder.html" title="interface in org.apache.sshd.common.auth">MutableUserHolder</a></pre> |
| <div class="block">Represents an SSH session. <B>Note:</B> the associated username for the session |
| may be <code>null</code>/empty if the session is not yet authenticated</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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session">Session.AttributeKey</a><<a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="type parameter in Session.AttributeKey">T</a>></span></code> |
| <div class="block"> |
| Type safe key for storage within the user attributes of <a href="../../../../../org/apache/sshd/common/session/AbstractSession.html" title="class in org.apache.sshd.common.session"><code>AbstractSession</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.TimeoutStatus.html" title="enum in org.apache.sshd.common.session">Session.TimeoutStatus</a></span></code> |
| <div class="block">Timeout status.</div> |
| </td> |
| </tr> |
| </table> |
| <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 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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#DEFAULT_SSH_VERSION_PREFIX">DEFAULT_SSH_VERSION_PREFIX</a></span></code> |
| <div class="block">Default prefix expected for the client / server identification string</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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#createBuffer-byte-">createBuffer</a></span>(byte cmd)</code> |
| <div class="block">Create a new buffer for the specified SSH packet and reserve the needed space |
| (5 bytes) for the packet header.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#createBuffer-byte-int-">createBuffer</a></span>(byte cmd, |
| int estimatedSize)</code> |
| <div class="block">Create a new buffer for the specified SSH packet and reserve the needed space |
| (5 bytes) for the packet header.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#disconnect-int-java.lang.String-">disconnect</a></span>(int reason, |
| <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> msg)</code> |
| <div class="block">Send a disconnect packet with the given reason and message.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#exceptionCaught-java.lang.Throwable-">exceptionCaught</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</code> |
| <div class="block">Handle any exceptions that occurred on this session.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getAttribute-org.apache.sshd.common.session.Session.AttributeKey-">getAttribute</a></span>(<a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session">Session.AttributeKey</a><T> key)</code> |
| <div class="block">Returns the value of the user-defined attribute of this session.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getAuthTimeout--">getAuthTimeout</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/cipher/CipherInformation.html" title="interface in org.apache.sshd.common.cipher">CipherInformation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getCipherInformation-boolean-">getCipherInformation</a></span>(boolean incoming)</code> |
| <div class="block">Retrieves current cipher information - <B>Note:</B> may change if |
| key re-exchange executed</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getClientVersion--">getClientVersion</a></span>()</code> |
| <div class="block">Retrieve the client version for this session.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/compression/CompressionInformation.html" title="interface in org.apache.sshd.common.compression">CompressionInformation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getCompressionInformation-boolean-">getCompressionInformation</a></span>(boolean incoming)</code> |
| <div class="block">Retrieves current compression information - <B>Note:</B> may change if |
| key re-exchange executed</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getFactoryManager--">getFactoryManager</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getIdleTimeout--">getIdleTimeout</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getIoSession--">getIoSession</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/kex/KeyExchange.html" title="interface in org.apache.sshd.common.kex">KeyExchange</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getKex--">getKex</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/mac/MacInformation.html" title="interface in org.apache.sshd.common.mac">MacInformation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getMacInformation-boolean-">getMacInformation</a></span>(boolean incoming)</code> |
| <div class="block">Retrieves current MAC information - <B>Note:</B> may change if |
| key re-exchange executed</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getNegotiatedKexParameter-org.apache.sshd.common.kex.KexProposalOption-">getNegotiatedKexParameter</a></span>(<a href="../../../../../org/apache/sshd/common/kex/KexProposalOption.html" title="enum in org.apache.sshd.common.kex">KexProposalOption</a> paramType)</code> |
| <div class="block">Retrieve one of the negotiated values during the KEX stage</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getServerVersion--">getServerVersion</a></span>()</code> |
| <div class="block">Retrieve the server version for this session.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../../../../org/apache/sshd/common/Service.html" title="interface in org.apache.sshd.common">Service</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getService-java.lang.Class-">getService</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> clazz)</code> |
| <div class="block">Get the service of the specified type.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getSessionId--">getSessionId</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/session/Session.TimeoutStatus.html" title="enum in org.apache.sshd.common.session">Session.TimeoutStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#getTimeoutStatus--">getTimeoutStatus</a></span>()</code> |
| <div class="block">Check if timeout has occurred.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#isAuthenticated--">isAuthenticated</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#prepareBuffer-byte-org.apache.sshd.common.util.buffer.Buffer-">prepareBuffer</a></span>(byte cmd, |
| <a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer)</code> |
| <div class="block">Prepare a new "clean" buffer while reserving the needed space |
| (5 bytes) for the packet header.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <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/common/session/Session.html#reExchangeKeys--">reExchangeKeys</a></span>()</code> |
| <div class="block">Initiate a new key exchange.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#request-org.apache.sshd.common.util.buffer.Buffer-long-java.util.concurrent.TimeUnit-">request</a></span>(<a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| long timeout, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">Send a global request and wait for the response.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#resetIdleTimeout--">resetIdleTimeout</a></span>()</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><T,E extends T><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#setAttribute-org.apache.sshd.common.session.Session.AttributeKey-E-">setAttribute</a></span>(<a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session">Session.AttributeKey</a><T> key, |
| E value)</code> |
| <div class="block">Sets a user-defined attribute.</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/common/session/Session.html#setAuthenticated--">setAuthenticated</a></span>()</code> </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/common/session/Session.html#startService-java.lang.String-">startService</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> name)</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#writePacket-org.apache.sshd.common.util.buffer.Buffer-">writePacket</a></span>(<a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer)</code> |
| <div class="block">Encode and send the given buffer.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/session/Session.html#writePacket-org.apache.sshd.common.util.buffer.Buffer-long-java.util.concurrent.TimeUnit-">writePacket</a></span>(<a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| long timeout, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">Encode and send the given buffer with the specified timeout.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.kex.KexFactoryManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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 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 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 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 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 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 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 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 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 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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_SSH_VERSION_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_SSH_VERSION_PREFIX</h4> |
| <pre>static final <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> DEFAULT_SSH_VERSION_PREFIX</pre> |
| <div class="block">Default prefix expected for the client / server identification string</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.sshd.common.session.Session.DEFAULT_SSH_VERSION_PREFIX">Constant Field Values</a></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="getAttribute-org.apache.sshd.common.session.Session.AttributeKey-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre><T> T getAttribute(<a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session">Session.AttributeKey</a><T> key)</pre> |
| <div class="block">Returns the value of the user-defined attribute of this session.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The generic attribute type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the attribute; must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>null</tt> if there is no attribute with the specified key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttribute-org.apache.sshd.common.session.Session.AttributeKey-java.lang.Object-"> |
| <!-- --> |
| </a><a name="setAttribute-org.apache.sshd.common.session.Session.AttributeKey-E-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre><T,E extends T> T setAttribute(<a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session">Session.AttributeKey</a><T> key, |
| E value)</pre> |
| <div class="block">Sets a user-defined attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The generic attribute type</dd> |
| <dd><code>E</code> - The generic value type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key of the attribute; must not be <code>null</code>.</dd> |
| <dd><code>value</code> - The value of the attribute; must not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The old value of the attribute. <code>null</code> if it is new.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientVersion</h4> |
| <pre><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> getClientVersion()</pre> |
| <div class="block">Retrieve the client version for this session.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the client version.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerVersion</h4> |
| <pre><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> getServerVersion()</pre> |
| <div class="block">Retrieve the server version for this session.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the server version.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFactoryManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFactoryManager</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a> getFactoryManager()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common"><code>FactoryManager</code></a> that has created this session, can not be <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNegotiatedKexParameter-org.apache.sshd.common.kex.KexProposalOption-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNegotiatedKexParameter</h4> |
| <pre><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> getNegotiatedKexParameter(<a href="../../../../../org/apache/sshd/common/kex/KexProposalOption.html" title="enum in org.apache.sshd.common.kex">KexProposalOption</a> paramType)</pre> |
| <div class="block">Retrieve one of the negotiated values during the KEX stage</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>paramType</code> - The request <a href="../../../../../org/apache/sshd/common/kex/KexProposalOption.html" title="enum in org.apache.sshd.common.kex"><code>KexProposalOption</code></a> value - ignored |
| if <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The negotiated parameter value - <code>null</code> if invalid |
| parameter or no negotiated value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCipherInformation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCipherInformation</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/cipher/CipherInformation.html" title="interface in org.apache.sshd.common.cipher">CipherInformation</a> getCipherInformation(boolean incoming)</pre> |
| <div class="block">Retrieves current cipher information - <B>Note:</B> may change if |
| key re-exchange executed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>incoming</code> - If <code>true</code> then the cipher for the incoming data, |
| otherwise for the outgoing data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../../org/apache/sshd/common/cipher/CipherInformation.html" title="interface in org.apache.sshd.common.cipher"><code>CipherInformation</code></a> - or <code>null</code> if not negotiated yet.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompressionInformation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompressionInformation</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/compression/CompressionInformation.html" title="interface in org.apache.sshd.common.compression">CompressionInformation</a> getCompressionInformation(boolean incoming)</pre> |
| <div class="block">Retrieves current compression information - <B>Note:</B> may change if |
| key re-exchange executed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>incoming</code> - If <code>true</code> then the compression for the incoming data, |
| otherwise for the outgoing data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../../org/apache/sshd/common/compression/CompressionInformation.html" title="interface in org.apache.sshd.common.compression"><code>CompressionInformation</code></a> - or <code>null</code> if not negotiated yet.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMacInformation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMacInformation</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/mac/MacInformation.html" title="interface in org.apache.sshd.common.mac">MacInformation</a> getMacInformation(boolean incoming)</pre> |
| <div class="block">Retrieves current MAC information - <B>Note:</B> may change if |
| key re-exchange executed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>incoming</code> - If <code>true</code> then the MAC for the incoming data, |
| otherwise for the outgoing data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../../org/apache/sshd/common/mac/MacInformation.html" title="interface in org.apache.sshd.common.mac"><code>MacInformation</code></a> - or <code>null</code> if not negotiated yet.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createBuffer-byte-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBuffer</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> createBuffer(byte cmd)</pre> |
| <div class="block">Create a new buffer for the specified SSH packet and reserve the needed space |
| (5 bytes) for the packet header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cmd</code> - the SSH command</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new buffer ready for write</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createBuffer-byte-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBuffer</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> createBuffer(byte cmd, |
| int estimatedSize)</pre> |
| <div class="block">Create a new buffer for the specified SSH packet and reserve the needed space |
| (5 bytes) for the packet header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cmd</code> - The SSH command to initialize the buffer with</dd> |
| <dd><code>estimatedSize</code> - Estimated number of bytes the buffer will hold, 0 if unknown.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new buffer ready for write</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/sshd/common/session/Session.html#prepareBuffer-byte-org.apache.sshd.common.util.buffer.Buffer-"><code>prepareBuffer(byte, Buffer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareBuffer-byte-org.apache.sshd.common.util.buffer.Buffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareBuffer</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> prepareBuffer(byte cmd, |
| <a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer)</pre> |
| <div class="block">Prepare a new "clean" buffer while reserving the needed space |
| (5 bytes) for the packet header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cmd</code> - The SSH command to initialize the buffer with</dd> |
| <dd><code>buffer</code> - The <a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer"><code>Buffer</code></a> instance to initialize</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The initialized buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writePacket-org.apache.sshd.common.util.buffer.Buffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writePacket</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a> writePacket(<a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer) |
| 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">Encode and send the given buffer. |
| The buffer has to have 5 bytes free at the beginning to allow the encoding to take place. |
| Also, the write position of the buffer has to be set to the position of the last byte to write.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer to encode and send</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a future that can be used to check when the packet has actually been sent</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 an error occurred when encoding sending the packet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writePacket-org.apache.sshd.common.util.buffer.Buffer-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writePacket</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a> writePacket(<a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| long timeout, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit) |
| 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">Encode and send the given buffer with the specified timeout. |
| If the buffer could not be written before the timeout elapses, the returned |
| <a href="../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io"><code>IoWriteFuture</code></a> will be set with a |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeoutException</code></a> exception to indicate a timeout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer to encode and spend</dd> |
| <dd><code>timeout</code> - the timeout</dd> |
| <dd><code>unit</code> - the time unit of the timeout parameter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a future that can be used to check when the packet has actually been sent</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 an error occurred when encoding sending the packet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="request-org.apache.sshd.common.util.buffer.Buffer-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> request(<a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| long timeout, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit) |
| 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">Send a global request and wait for the response. This must only be used when sending |
| a <code>SSH_MSG_GLOBAL_REQUEST</code> with a result expected, else it will time out</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer containing the global request</dd> |
| <dd><code>timeout</code> - The number of time units to wait - must be <U>positive</U></dd> |
| <dd><code>unit</code> - The <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a> to wait for the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the return buffer if the request was successful, <code>null</code> otherwise.</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 an error occurred when encoding sending the packet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exceptionCaught-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exceptionCaught</h4> |
| <pre>void exceptionCaught(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> t)</pre> |
| <div class="block">Handle any exceptions that occurred on this session. |
| The session will be closed and a disconnect packet will be |
| sent before if the given exception is an |
| <a href="../../../../../org/apache/sshd/common/SshException.html" title="class in org.apache.sshd.common"><code>SshException</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>t</code> - the exception to process</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reExchangeKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reExchangeKeys</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/future/KeyExchangeFuture.html" title="interface in org.apache.sshd.common.future">KeyExchangeFuture</a> reExchangeKeys() |
| 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">Initiate a new key exchange.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../org/apache/sshd/common/future/KeyExchangeFuture.html" title="interface in org.apache.sshd.common.future"><code>KeyExchangeFuture</code></a> for awaiting the completion of the exchange</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 request keys re-negotiation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getService-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getService</h4> |
| <pre><T extends <a href="../../../../../org/apache/sshd/common/Service.html" title="interface in org.apache.sshd.common">Service</a>> T getService(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> clazz)</pre> |
| <div class="block">Get the service of the specified type. |
| If the service is not of the specified class, |
| an IllegalStateException will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The generic <a href="../../../../../org/apache/sshd/common/Service.html" title="interface in org.apache.sshd.common"><code>Service</code></a> type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - The service class</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The service instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If failed to find a matching service</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIoSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIoSession</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a> getIoSession()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io"><code>IoSession</code></a> associated to this session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetIdleTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetIdleTimeout</h4> |
| <pre>void resetIdleTimeout()</pre> |
| </li> |
| </ul> |
| <a name="getTimeoutStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeoutStatus</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/session/Session.TimeoutStatus.html" title="enum in org.apache.sshd.common.session">Session.TimeoutStatus</a> getTimeoutStatus()</pre> |
| <div class="block">Check if timeout has occurred.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeout status, never <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthTimeout</h4> |
| <pre>long getAuthTimeout()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Timeout value in milliseconds for authentication stage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdleTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeout</h4> |
| <pre>long getIdleTimeout()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Timeout value in milliseconds for communication</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAuthenticated--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAuthenticated</h4> |
| <pre>boolean isAuthenticated()</pre> |
| </li> |
| </ul> |
| <a name="setAuthenticated--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticated</h4> |
| <pre>void setAuthenticated() |
| 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="getSessionId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionId</h4> |
| <pre>byte[] getSessionId()</pre> |
| </li> |
| </ul> |
| <a name="getKex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKex</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/kex/KeyExchange.html" title="interface in org.apache.sshd.common.kex">KeyExchange</a> getKex()</pre> |
| </li> |
| </ul> |
| <a name="disconnect-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disconnect</h4> |
| <pre>void disconnect(int reason, |
| <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> msg) |
| 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">Send a disconnect packet with the given reason and message. |
| Once the packet has been sent, the session will be closed |
| asynchronously.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reason</code> - the reason code for this disconnect</dd> |
| <dd><code>msg</code> - the text message</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 an error occurred sending the packet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startService-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>startService</h4> |
| <pre>void startService(<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> name) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Service name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - If failed to start it</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/Session.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/common/session/PendingWriteFuture.html" title="class in org.apache.sshd.common.session"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/session/Session.AttributeKey.html" title="class in org.apache.sshd.common.session"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/session/Session.html" target="_top">Frames</a></li> |
| <li><a href="Session.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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 © 2008–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
