blob: 405e0f05444fab1c4aee477a6249e8a3a21851e0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_66) on Fri Jan 15 14:33:40 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UserAuthKeyboardInteractive (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="UserAuthKeyboardInteractive (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/UserAuthKeyboardInteractive.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractiveFactory.html" title="class in org.apache.sshd.client.auth.keyboard"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html" target="_top">Frames</a></li>
<li><a href="UserAuthKeyboardInteractive.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.sshd.client.auth.keyboard</div>
<h2 title="Class UserAuthKeyboardInteractive" class="title">Class UserAuthKeyboardInteractive</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/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.auth">org.apache.sshd.client.auth.AbstractUserAuth</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive</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/client/auth/UserAuth.html" title="interface in org.apache.sshd.client.auth">UserAuth</a>, <a href="../../../../../../org/apache/sshd/client/session/ClientSessionHolder.html" title="interface in org.apache.sshd.client.session">ClientSessionHolder</a>, <a href="../../../../../../org/apache/sshd/common/auth/UserAuthInstance.html" title="interface in org.apache.sshd.common.auth">UserAuthInstance</a>&lt;<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&gt;, <a href="../../../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">UserAuthKeyboardInteractive</span>
extends <a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.auth">AbstractUserAuth</a></pre>
<div class="block">Manages a &quot;keyboard-interactive&quot; exchange according to
<A HREF="https://www.ietf.org/rfc/rfc4256.txt">RFC4256</A></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&nbsp;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">&nbsp;</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/client/auth/keyboard/UserAuthKeyboardInteractive.html#DEFAULT_INTERACTIVE_LANGUAGE_TAG">DEFAULT_INTERACTIVE_LANGUAGE_TAG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<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/client/auth/keyboard/UserAuthKeyboardInteractive.html#DEFAULT_INTERACTIVE_SUBMETHODS">DEFAULT_INTERACTIVE_SUBMETHODS</a></span></code>&nbsp;</td>
</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/client/auth/keyboard/UserAuthKeyboardInteractive.html#INTERACTIVE_LANGUAGE_TAG">INTERACTIVE_LANGUAGE_TAG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<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/client/auth/keyboard/UserAuthKeyboardInteractive.html#INTERACTIVE_SUBMETHODS">INTERACTIVE_SUBMETHODS</a></span></code>&nbsp;</td>
</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/client/auth/keyboard/UserAuthKeyboardInteractive.html#NAME">NAME</a></span></code>&nbsp;</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&nbsp;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&nbsp;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">&nbsp;</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/client/auth/keyboard/UserAuthKeyboardInteractive.html#UserAuthKeyboardInteractive--">UserAuthKeyboardInteractive</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>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/client/auth/keyboard/UserAuthKeyboardInteractive.html#getAuthCommandName-int-">getAuthCommandName</a></span>(int&nbsp;cmd)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <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/UserAuthKeyboardInteractive.html#getCurrentPasswordCandidate--">getCurrentPasswordCandidate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <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/UserAuthKeyboardInteractive.html#getExchangeLanguageTag-org.apache.sshd.client.session.ClientSession-">getExchangeLanguageTag</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <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/UserAuthKeyboardInteractive.html#getExchangeSubMethods-org.apache.sshd.client.session.ClientSession-">getExchangeSubMethods</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <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/UserAuthKeyboardInteractive.html#getUserResponses-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean:A-">getUserResponses</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;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>&nbsp;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>[]&nbsp;prompt,
boolean[]&nbsp;echo)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html#init-org.apache.sshd.client.session.ClientSession-java.lang.String-">init</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html#processAuthDataRequest-org.apache.sshd.client.session.ClientSession-java.lang.String-org.apache.sshd.common.util.buffer.Buffer-">processAuthDataRequest</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service,
<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a>&nbsp;buffer)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html#sendAuthDataRequest-org.apache.sshd.client.session.ClientSession-java.lang.String-">sendAuthDataRequest</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html#useCurrentPassword-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean:A-">useCurrentPassword</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;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>&nbsp;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>[]&nbsp;prompt,
boolean[]&nbsp;echo)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html#verifyTrialsCount-org.apache.sshd.client.session.ClientSession-java.lang.String-int-int-int-">verifyTrialsCount</a></span>(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service,
int&nbsp;cmd,
int&nbsp;nbTrials,
int&nbsp;maxAllowed)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.client.auth.AbstractUserAuth">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sshd.client.auth.<a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.auth">AbstractUserAuth</a></h3>
<code><a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#destroy--">destroy</a>, <a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#getClientSession--">getClientSession</a>, <a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#getName--">getName</a>, <a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#getService--">getService</a>, <a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#getSession--">getSession</a>, <a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#process-org.apache.sshd.common.util.buffer.Buffer-">process</a>, <a href="../../../../../../org/apache/sshd/client/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&nbsp;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="blockList">
<li class="blockList">
<h4>NAME</h4>
<pre>public static final&nbsp;<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.client.auth.keyboard.UserAuthKeyboardInteractive.NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INTERACTIVE_LANGUAGE_TAG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INTERACTIVE_LANGUAGE_TAG</h4>
<pre>public static final&nbsp;<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_LANGUAGE_TAG</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive.INTERACTIVE_LANGUAGE_TAG">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_INTERACTIVE_LANGUAGE_TAG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_INTERACTIVE_LANGUAGE_TAG</h4>
<pre>public static final&nbsp;<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_INTERACTIVE_LANGUAGE_TAG</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive.DEFAULT_INTERACTIVE_LANGUAGE_TAG">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INTERACTIVE_SUBMETHODS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INTERACTIVE_SUBMETHODS</h4>
<pre>public static final&nbsp;<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_SUBMETHODS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive.INTERACTIVE_SUBMETHODS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_INTERACTIVE_SUBMETHODS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_INTERACTIVE_SUBMETHODS</h4>
<pre>public static final&nbsp;<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_INTERACTIVE_SUBMETHODS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive.DEFAULT_INTERACTIVE_SUBMETHODS">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="UserAuthKeyboardInteractive--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UserAuthKeyboardInteractive</h4>
<pre>public&nbsp;UserAuthKeyboardInteractive()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-org.apache.sshd.client.session.ClientSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service)
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/client/auth/UserAuth.html#init-org.apache.sshd.client.session.ClientSession-java.lang.String-">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/sshd/client/auth/UserAuth.html" title="interface in org.apache.sshd.client.auth">UserAuth</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html#init-org.apache.sshd.client.session.ClientSession-java.lang.String-">init</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.auth">AbstractUserAuth</a></code></dd>
<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>
<dd><code>service</code> - The requesting 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 initialize the mechanism</dd>
</dl>
</li>
</ul>
<a name="sendAuthDataRequest-org.apache.sshd.client.session.ClientSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendAuthDataRequest</h4>
<pre>protected&nbsp;boolean&nbsp;sendAuthDataRequest(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service)
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/client/auth/AbstractUserAuth.html#sendAuthDataRequest-org.apache.sshd.client.session.ClientSession-java.lang.String-">sendAuthDataRequest</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.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="processAuthDataRequest-org.apache.sshd.client.session.ClientSession-java.lang.String-org.apache.sshd.common.util.buffer.Buffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processAuthDataRequest</h4>
<pre>protected&nbsp;boolean&nbsp;processAuthDataRequest(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service,
<a href="../../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a>&nbsp;buffer)
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/client/auth/AbstractUserAuth.html#processAuthDataRequest-org.apache.sshd.client.session.ClientSession-java.lang.String-org.apache.sshd.common.util.buffer.Buffer-">processAuthDataRequest</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/sshd/client/auth/AbstractUserAuth.html" title="class in org.apache.sshd.client.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="getExchangeLanguageTag-org.apache.sshd.client.session.ClientSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExchangeLanguageTag</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getExchangeLanguageTag(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;session)</pre>
</li>
</ul>
<a name="getExchangeSubMethods-org.apache.sshd.client.session.ClientSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExchangeSubMethods</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getExchangeSubMethods(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;session)</pre>
</li>
</ul>
<a name="getCurrentPasswordCandidate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentPasswordCandidate</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCurrentPasswordCandidate()</pre>
</li>
</ul>
<a name="verifyTrialsCount-org.apache.sshd.client.session.ClientSession-java.lang.String-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyTrialsCount</h4>
<pre>protected&nbsp;boolean&nbsp;verifyTrialsCount(<a href="../../../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>&nbsp;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>&nbsp;service,
int&nbsp;cmd,
int&nbsp;nbTrials,
int&nbsp;maxAllowed)</pre>
</li>
</ul>
<a name="getUserResponses-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserResponses</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getUserResponses(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;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>&nbsp;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>[]&nbsp;prompt,
boolean[]&nbsp;echo)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<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 tag - may be empty</dd>
<dd><code>prompt</code> - The prompts - may be empty</dd>
<dd><code>echo</code> - Whether to echo the response for the prompt or not - same
length as the prompts</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The response for each prompt - if <code>null</code> then the assumption
is that some internal error occurred and no response is sent. <B>Note:</B>
according to <A HREF="https://www.ietf.org/rfc/rfc4256.txt">RFC4256</A>
the number of responses should be <U>exactly</U> the same as the number
of prompts. However, since it is the <U>server's</U> responsibility to
enforce this we do not validate the response (other than logging it as
a warning...)</dd>
</dl>
</li>
</ul>
<a name="useCurrentPassword-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String:A-boolean:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useCurrentPassword</h4>
<pre>protected&nbsp;boolean&nbsp;useCurrentPassword(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;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>&nbsp;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>[]&nbsp;prompt,
boolean[]&nbsp;echo)</pre>
</li>
</ul>
<a name="getAuthCommandName-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAuthCommandName</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAuthCommandName(int&nbsp;cmd)</pre>
</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/UserAuthKeyboardInteractive.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractiveFactory.html" title="class in org.apache.sshd.client.auth.keyboard"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sshd/client/auth/keyboard/UserAuthKeyboardInteractive.html" target="_top">Frames</a></li>
<li><a href="UserAuthKeyboardInteractive.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>