| <!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:42 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UserAuthInstance (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="UserAuthInstance (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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/UserAuthInstance.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/auth/MutableUserHolder.html" title="interface in org.apache.sshd.common.auth"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/auth/UserAuthMethodFactory.html" title="interface in org.apache.sshd.common.auth"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/auth/UserAuthInstance.html" target="_top">Frames</a></li> |
| <li><a href="UserAuthInstance.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.auth</div> |
| <h2 title="Interface UserAuthInstance" class="title">Interface UserAuthInstance<S extends <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - The type of session being tracked by the instance</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/sshd/client/auth/UserAuth.html" title="interface in org.apache.sshd.client.auth">UserAuth</a>, <a href="../../../../../org/apache/sshd/server/auth/UserAuth.html" title="interface in org.apache.sshd.server.auth">UserAuth</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.auth">AbstractUserAuth</a>, <a href="../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html" title="class in org.apache.sshd.server.auth">AbstractUserAuth</a>, <a href="../../../../../org/apache/sshd/server/auth/gss/UserAuthGSS.html" title="class in org.apache.sshd.server.auth.gss">UserAuthGSS</a>, <a href="../../../../../org/apache/sshd/client/auth/hostbased/UserAuthHostBased.html" title="class in org.apache.sshd.client.auth.hostbased">UserAuthHostBased</a>, <a href="../../../../../org/apache/sshd/server/auth/hostbased/UserAuthHostBased.html" title="class in org.apache.sshd.server.auth.hostbased">UserAuthHostBased</a>, <a href="../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html" title="class in org.apache.sshd.client.auth.keyboard">UserAuthKeyboardInteractive</a>, <a href="../../../../../org/apache/sshd/server/auth/keyboard/UserAuthKeyboardInteractive.html" title="class in org.apache.sshd.server.auth.keyboard">UserAuthKeyboardInteractive</a>, <a href="../../../../../org/apache/sshd/server/auth/UserAuthNone.html" title="class in org.apache.sshd.server.auth">UserAuthNone</a>, <a href="../../../../../org/apache/sshd/client/auth/password/UserAuthPassword.html" title="class in org.apache.sshd.client.auth.password">UserAuthPassword</a>, <a href="../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html" title="class in org.apache.sshd.server.auth.password">UserAuthPassword</a>, <a href="../../../../../org/apache/sshd/client/auth/pubkey/UserAuthPublicKey.html" title="class in org.apache.sshd.client.auth.pubkey">UserAuthPublicKey</a>, <a href="../../../../../org/apache/sshd/server/auth/pubkey/UserAuthPublicKey.html" title="class in org.apache.sshd.server.auth.pubkey">UserAuthPublicKey</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">UserAuthInstance<S extends <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a>></span> |
| extends <a href="../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></pre> |
| <div class="block">Represents an authentication-in-progress tracker for a specific session</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.sshd.common.NamedResource"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.sshd.common.<a href="../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/NamedResource.Utils.html" title="class in org.apache.sshd.common">NamedResource.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.NamedResource"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.sshd.common.<a href="../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/NamedResource.html#BY_NAME_COMPARATOR">BY_NAME_COMPARATOR</a>, <a href="../../../../../org/apache/sshd/common/NamedResource.html#NAME_EXTRACTOR">NAME_EXTRACTOR</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"> </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/auth/UserAuthInstance.html" title="type parameter in UserAuthInstance">S</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/auth/UserAuthInstance.html#getSession--">getSession</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.NamedResource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.sshd.common.<a href="../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/NamedResource.html#getName--">getName</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="getSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/auth/UserAuthInstance.html" title="type parameter in UserAuthInstance">S</a> getSession()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The current session for which the authentication is being |
| tracked. <B>Note:</B> may be <code>null</code> if the instance has not |
| been initialized yet</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/UserAuthInstance.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/auth/MutableUserHolder.html" title="interface in org.apache.sshd.common.auth"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/auth/UserAuthMethodFactory.html" title="interface in org.apache.sshd.common.auth"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/auth/UserAuthInstance.html" target="_top">Frames</a></li> |
| <li><a href="UserAuthInstance.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
