| <!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>UserAuthPassword (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="UserAuthPassword (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/UserAuthPassword.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/server/auth/password/StaticPasswordAuthenticator.html" title="class in org.apache.sshd.server.auth.password"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPasswordFactory.html" title="class in org.apache.sshd.server.auth.password"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/sshd/server/auth/password/UserAuthPassword.html" target="_top">Frames</a></li> |
| <li><a href="UserAuthPassword.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.sshd.server.auth.password</div> |
| <h2 title="Class UserAuthPassword" class="title">Class UserAuthPassword</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">org.apache.sshd.common.util.logging.AbstractLoggingBean</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html" title="class in org.apache.sshd.server.auth">org.apache.sshd.server.auth.AbstractUserAuth</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.sshd.server.auth.password.UserAuthPassword</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/sshd/common/auth/UserAuthInstance.html" title="interface in org.apache.sshd.common.auth">UserAuthInstance</a><<a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a>>, <a href="../../../../../../org/apache/sshd/common/auth/UsernameHolder.html" title="interface in org.apache.sshd.common.auth">UsernameHolder</a>, <a href="../../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a>, <a href="../../../../../../org/apache/sshd/server/auth/UserAuth.html" title="interface in org.apache.sshd.server.auth">UserAuth</a>, <a href="../../../../../../org/apache/sshd/server/session/ServerSessionHolder.html" title="interface in org.apache.sshd.server.session">ServerSessionHolder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">UserAuthPassword</span> |
| extends <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html" title="class in org.apache.sshd.server.auth">AbstractUserAuth</a></pre> |
| <div class="block">TODO Add javadoc</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> |
| <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/server/auth/password/UserAuthPassword.html#NAME">NAME</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.common.util.logging.AbstractLoggingBean"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.sshd.common.util.logging.<a href="../../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">AbstractLoggingBean</a></h3> |
| <code><a href="../../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html#log">log</a></code></li> |
| </ul> |
| <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> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#UserAuthPassword--">UserAuthPassword</a></span>()</code> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#checkPassword-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-">checkPassword</a></span>(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a> session, |
| <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> username, |
| <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> password)</code> |
| <div class="block">Invokes the configured <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordAuthenticator.html" title="interface in org.apache.sshd.server.auth.password"><code>PasswordAuthenticator</code></a> and returns the result.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#doAuth-org.apache.sshd.common.util.buffer.Buffer-boolean-">doAuth</a></span>(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| boolean init)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#handleClientPasswordChangeRequest-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-java.lang.String-">handleClientPasswordChangeRequest</a></span>(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a> session, |
| <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> username, |
| <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> oldPassword, |
| <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> newPassword)</code> |
| <div class="block">Invoked when the client sends a <code>SSH_MSG_USERAUTH_REQUEST</code> indicating |
| a password change.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#handleServerPasswordChangeRequest-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-org.apache.sshd.server.auth.password.PasswordChangeRequiredException-">handleServerPasswordChangeRequest</a></span>(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a> session, |
| <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> username, |
| <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> password, |
| <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordChangeRequiredException.html" title="class in org.apache.sshd.server.auth.password">PasswordChangeRequiredException</a> e)</code> |
| <div class="block">Invoked by <a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#checkPassword-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-"><code>checkPassword(Buffer, ServerSession, String, String)</code></a> |
| when a <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordChangeRequiredException.html" title="class in org.apache.sshd.server.auth.password"><code>PasswordChangeRequiredException</code></a> was thrown by the authenticator.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.server.auth.AbstractUserAuth"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.sshd.server.auth.<a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html" title="class in org.apache.sshd.server.auth">AbstractUserAuth</a></h3> |
| <code><a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#auth-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-org.apache.sshd.common.util.buffer.Buffer-">auth</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#destroy--">destroy</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#getName--">getName</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#getServerSession--">getServerSession</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#getService--">getService</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#getSession--">getSession</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#getUsername--">getUsername</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#next-org.apache.sshd.common.util.buffer.Buffer-">next</a>, <a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</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="NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NAME</h4> |
| <pre>public 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> NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.sshd.server.auth.password.UserAuthPassword.NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="UserAuthPassword--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UserAuthPassword</h4> |
| <pre>public UserAuthPassword()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="doAuth-org.apache.sshd.common.util.buffer.Buffer-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doAuth</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> doAuth(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| boolean init) |
| 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html#doAuth-org.apache.sshd.common.util.buffer.Buffer-boolean-">doAuth</a></code> in class <code><a href="../../../../../../org/apache/sshd/server/auth/AbstractUserAuth.html" title="class in org.apache.sshd.server.auth">AbstractUserAuth</a></code></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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkPassword-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPassword</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> checkPassword(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a> session, |
| <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> username, |
| <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> password) |
| 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> |
| <div class="block">Invokes the configured <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordAuthenticator.html" title="interface in org.apache.sshd.server.auth.password"><code>PasswordAuthenticator</code></a> and returns the result. |
| If <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordChangeRequiredException.html" title="class in org.apache.sshd.server.auth.password"><code>PasswordChangeRequiredException</code></a> thrown by the authenticator then |
| <a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#handleServerPasswordChangeRequest-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-org.apache.sshd.server.auth.password.PasswordChangeRequiredException-"><code>handleServerPasswordChangeRequest(Buffer, ServerSession, String, String, PasswordChangeRequiredException)</code></a> |
| is invoked</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The received <a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer"><code>Buffer</code></a> to be re-used if need to send |
| a password change request</dd> |
| <dd><code>session</code> - The <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session"><code>ServerSession</code></a> through which the request was received</dd> |
| <dd><code>username</code> - The username</dd> |
| <dd><code>password</code> - The password</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The authentication result - if <code>null</code> then exception was handled |
| internally and authentication is still in progress</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 internal error during authentication (exception for |
| <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordChangeRequiredException.html" title="class in org.apache.sshd.server.auth.password"><code>PasswordChangeRequiredException</code></a> which is handled internally)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#handleServerPasswordChangeRequest-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-org.apache.sshd.server.auth.password.PasswordChangeRequiredException-"><code>handleServerPasswordChangeRequest(Buffer, ServerSession, String, String, PasswordChangeRequiredException)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleClientPasswordChangeRequest-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleClientPasswordChangeRequest</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> handleClientPasswordChangeRequest(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a> session, |
| <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> username, |
| <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> oldPassword, |
| <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> newPassword) |
| 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> |
| <div class="block">Invoked when the client sends a <code>SSH_MSG_USERAUTH_REQUEST</code> indicating |
| a password change. Throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a> by default</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <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> to re-use in order to respond</dd> |
| <dd><code>session</code> - The associated <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session"><code>ServerSession</code></a></dd> |
| <dd><code>username</code> - The username</dd> |
| <dd><code>oldPassword</code> - The old password</dd> |
| <dd><code>newPassword</code> - The new password</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Password change and authentication result - <code>null</code> means |
| authentication incomplete - i.e., handler has sent some extra query.</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 handle the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleServerPasswordChangeRequest-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-org.apache.sshd.server.auth.password.PasswordChangeRequiredException-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>handleServerPasswordChangeRequest</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> handleServerPasswordChangeRequest(<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer, |
| <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a> session, |
| <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> username, |
| <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> password, |
| <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordChangeRequiredException.html" title="class in org.apache.sshd.server.auth.password">PasswordChangeRequiredException</a> e) |
| 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> |
| <div class="block">Invoked by <a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPassword.html#checkPassword-org.apache.sshd.common.util.buffer.Buffer-org.apache.sshd.server.session.ServerSession-java.lang.String-java.lang.String-"><code>checkPassword(Buffer, ServerSession, String, String)</code></a> |
| when a <a href="../../../../../../org/apache/sshd/server/auth/password/PasswordChangeRequiredException.html" title="class in org.apache.sshd.server.auth.password"><code>PasswordChangeRequiredException</code></a> was thrown by the authenticator. |
| By default it re-throws the original exception.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The received <a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer"><code>Buffer</code></a> to be re-used if need to send |
| a password change request</dd> |
| <dd><code>session</code> - The <a href="../../../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session"><code>ServerSession</code></a> through which the request was received</dd> |
| <dd><code>username</code> - The username</dd> |
| <dd><code>password</code> - The (rejected) password</dd> |
| <dd><code>e</code> - The original thrown exception</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>null</code> by default to indicate incomplete authentication</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 dispatch the message</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/UserAuthPassword.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/server/auth/password/StaticPasswordAuthenticator.html" title="class in org.apache.sshd.server.auth.password"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/sshd/server/auth/password/UserAuthPasswordFactory.html" title="class in org.apache.sshd.server.auth.password"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/sshd/server/auth/password/UserAuthPassword.html" target="_top">Frames</a></li> |
| <li><a href="UserAuthPassword.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <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> |
