| <!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:40 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UserInteraction (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="UserInteraction (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":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/UserInteraction.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractiveFactory.html" title="class in org.apache.sshd.client.auth.keyboard"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/sshd/client/auth/keyboard/UserInteraction.html" target="_top">Frames</a></li> |
| <li><a href="UserInteraction.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>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.client.auth.keyboard</div> |
| <h2 title="Interface UserInteraction" class="title">Interface UserInteraction</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">UserInteraction</span></pre> |
| <div class="block">Interface used by the ssh client to communicate with the end user.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://www.ietf.org/rfc/rfc4256.txt">RFC 4256</A></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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="../../../../../../org/apache/sshd/client/auth/keyboard/UserInteraction.html" title="interface in org.apache.sshd.client.auth.keyboard">UserInteraction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserInteraction.html#NONE">NONE</a></span></code> |
| <div class="block">A useful "placeholder" that indicates that no interaction is expected.</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="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/client/auth/keyboard/UserInteraction.html#getUpdatedPassword-org.apache.sshd.client.session.ClientSession-java.lang.String-java.lang.String-">getUpdatedPassword</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</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> prompt, |
| <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> lang)</code> |
| <div class="block">Invoked when the server returns an <code>SSH_MSG_USERAUTH_PASSWD_CHANGEREQ</code> |
| response indicating that the password should be changed - e.g., expired or |
| not strong enough (as per the server's policy).</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/client/auth/keyboard/UserInteraction.html#interactive-org.apache.sshd.client.session.ClientSession-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean:A-">interactive</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</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> name, |
| <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> instruction, |
| <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> lang, |
| <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>[] prompt, |
| boolean[] echo)</code> |
| <div class="block">Invoked when "keyboard-interactive" authentication mechanism |
| is used in order to provide responses for the server's challenges |
| (a.k.a.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserInteraction.html#isInteractionAllowed-org.apache.sshd.client.session.ClientSession-">isInteractionAllowed</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a> session)</code> </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/client/auth/keyboard/UserInteraction.html#welcome-org.apache.sshd.client.session.ClientSession-java.lang.String-java.lang.String-">welcome</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</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> banner, |
| <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> lang)</code> |
| <div class="block">Displays the welcome banner to the user.</div> |
| </td> |
| </tr> |
| </table> |
| </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="NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NONE</h4> |
| <pre>static final <a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserInteraction.html" title="interface in org.apache.sshd.client.auth.keyboard">UserInteraction</a> NONE</pre> |
| <div class="block">A useful "placeholder" that indicates that no interaction is expected. |
| <B>Note:</B> throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a> is any of the interaction |
| methods is called</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isInteractionAllowed-org.apache.sshd.client.session.ClientSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInteractionAllowed</h4> |
| <pre>boolean isInteractionAllowed(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a> session)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session"><code>ClientSession</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if user interaction allowed for this session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="welcome-org.apache.sshd.client.session.ClientSession-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>welcome</h4> |
| <pre>void welcome(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</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> banner, |
| <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> lang)</pre> |
| <div class="block">Displays the welcome banner to the user.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session"><code>ClientSession</code></a> through which the banner was received</dd> |
| <dd><code>banner</code> - The welcome banner</dd> |
| <dd><code>lang</code> - The banner language code - may be empty</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="interactive-org.apache.sshd.client.session.ClientSession-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>interactive</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>[] interactive(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</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> name, |
| <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> instruction, |
| <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> lang, |
| <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>[] prompt, |
| boolean[] echo)</pre> |
| <div class="block">Invoked when "keyboard-interactive" authentication mechanism |
| is used in order to provide responses for the server's challenges |
| (a.k.a. prompts)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session"><code>ClientSession</code></a> through which the request was received</dd> |
| <dd><code>name</code> - The interaction name (may be empty)</dd> |
| <dd><code>instruction</code> - The instruction (may be empty)</dd> |
| <dd><code>lang</code> - The language for the data (may be empty)</dd> |
| <dd><code>prompt</code> - The prompts to be displayed (may be empty)</dd> |
| <dd><code>echo</code> - For each prompt whether to echo the user's response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The replies - <B>Note:</B> the protocol states that the number |
| of replies should be <U>exactly</U> the same as the number of prompts, |
| however we do not enforce it since it is defined as the <U>server's</U> |
| job to check and manage this violation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdatedPassword-org.apache.sshd.client.session.ClientSession-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUpdatedPassword</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> getUpdatedPassword(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</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> prompt, |
| <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> lang)</pre> |
| <div class="block">Invoked when the server returns an <code>SSH_MSG_USERAUTH_PASSWD_CHANGEREQ</code> |
| response indicating that the password should be changed - e.g., expired or |
| not strong enough (as per the server's policy).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session"><code>ClientSession</code></a> through which the request was received</dd> |
| <dd><code>prompt</code> - The server's prompt (may be empty)</dd> |
| <dd><code>lang</code> - The prompt's language (may be empty)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The password to use - if <code>null</code>/empty then no updated |
| password was provided - thus failing the authentication via passwords |
| (<B>Note:</B> authentication might still succeed via some other means - |
| be it other passwords, public keys, etc...)</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/UserInteraction.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractiveFactory.html" title="class in org.apache.sshd.client.auth.keyboard"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/sshd/client/auth/keyboard/UserInteraction.html" target="_top">Frames</a></li> |
| <li><a href="UserInteraction.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>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> |
