blob: 6aa657827b1c39f8015ed9f5ef2c81057d5b5d36 [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_92) on Thu Jun 07 14:26:35 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BasicAuthModule (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<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="BasicAuthModule (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":42,"i1":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/BasicAuthModule.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/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/ClientCertAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.html" target="_top">Frames</a></li>
<li><a href="BasicAuthModule.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="#fields.inherited.from.class.org.eclipse.jetty.security.jaspi.modules.BaseAuthModule">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>Field&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.eclipse.jetty.security.jaspi.modules</div>
<h2 title="Class BasicAuthModule" class="title">Class BasicAuthModule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules">org.eclipse.jetty.security.jaspi.modules.BaseAuthModule</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.security.jaspi.modules.BasicAuthModule</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>javax.security.auth.message.config.ServerAuthContext, javax.security.auth.message.module.ServerAuthModule, javax.security.auth.message.ServerAuth</dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<br>
<pre>@Deprecated
public class <span class="typeNameLabel">BasicAuthModule</span>
extends <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules">BaseAuthModule</a></pre>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.security.jaspi.modules.BaseAuthModule">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.security.jaspi.modules.<a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules">BaseAuthModule</a></h3>
<code><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#callbackHandler">callbackHandler</a>, <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#LOGIN_SERVICE_KEY">LOGIN_SERVICE_KEY</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/eclipse/jetty/security/jaspi/modules/BasicAuthModule.html#BasicAuthModule--">BasicAuthModule</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.html#BasicAuthModule-javax.security.auth.callback.CallbackHandler-java.lang.String-">BasicAuthModule</a></span>(javax.security.auth.callback.CallbackHandler&nbsp;callbackHandler,
java.lang.String&nbsp;realmName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.html#initialize-javax.security.auth.message.MessagePolicy-javax.security.auth.message.MessagePolicy-javax.security.auth.callback.CallbackHandler-java.util.Map-">initialize</a></span>(javax.security.auth.message.MessagePolicy&nbsp;requestPolicy,
javax.security.auth.message.MessagePolicy&nbsp;responsePolicy,
javax.security.auth.callback.CallbackHandler&nbsp;handler,
java.util.Map&nbsp;options)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>javax.security.auth.message.AuthStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.html#validateRequest-javax.security.auth.message.MessageInfo-javax.security.auth.Subject-javax.security.auth.Subject-">validateRequest</a></span>(javax.security.auth.message.MessageInfo&nbsp;messageInfo,
javax.security.auth.Subject&nbsp;clientSubject,
javax.security.auth.Subject&nbsp;serviceSubject)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.security.jaspi.modules.BaseAuthModule">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.security.jaspi.modules.<a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules">BaseAuthModule</a></h3>
<code><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#cleanSubject-javax.security.auth.message.MessageInfo-javax.security.auth.Subject-">cleanSubject</a>, <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#getSupportedMessageTypes--">getSupportedMessageTypes</a>, <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#isMandatory-javax.security.auth.message.MessageInfo-">isMandatory</a>, <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#login-javax.security.auth.Subject-java.lang.String-org.eclipse.jetty.util.security.Credential-java.lang.String-javax.security.auth.message.MessageInfo-">login</a>, <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#login-javax.security.auth.Subject-java.lang.String-java.lang.String-javax.security.auth.message.MessageInfo-">login</a>, <a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#secureResponse-javax.security.auth.message.MessageInfo-javax.security.auth.Subject-">secureResponse</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BasicAuthModule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BasicAuthModule</h4>
<pre>public&nbsp;BasicAuthModule()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="BasicAuthModule-javax.security.auth.callback.CallbackHandler-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BasicAuthModule</h4>
<pre>public&nbsp;BasicAuthModule(javax.security.auth.callback.CallbackHandler&nbsp;callbackHandler,
java.lang.String&nbsp;realmName)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initialize-javax.security.auth.message.MessagePolicy-javax.security.auth.message.MessagePolicy-javax.security.auth.callback.CallbackHandler-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(javax.security.auth.message.MessagePolicy&nbsp;requestPolicy,
javax.security.auth.message.MessagePolicy&nbsp;responsePolicy,
javax.security.auth.callback.CallbackHandler&nbsp;handler,
java.util.Map&nbsp;options)
throws javax.security.auth.message.AuthException</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>initialize</code>&nbsp;in interface&nbsp;<code>javax.security.auth.message.module.ServerAuthModule</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#initialize-javax.security.auth.message.MessagePolicy-javax.security.auth.message.MessagePolicy-javax.security.auth.callback.CallbackHandler-java.util.Map-">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules">BaseAuthModule</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.security.auth.message.AuthException</code></dd>
</dl>
</li>
</ul>
<a name="validateRequest-javax.security.auth.message.MessageInfo-javax.security.auth.Subject-javax.security.auth.Subject-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validateRequest</h4>
<pre>public&nbsp;javax.security.auth.message.AuthStatus&nbsp;validateRequest(javax.security.auth.message.MessageInfo&nbsp;messageInfo,
javax.security.auth.Subject&nbsp;clientSubject,
javax.security.auth.Subject&nbsp;serviceSubject)
throws javax.security.auth.message.AuthException</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>validateRequest</code>&nbsp;in interface&nbsp;<code>javax.security.auth.message.ServerAuth</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html#validateRequest-javax.security.auth.message.MessageInfo-javax.security.auth.Subject-javax.security.auth.Subject-">validateRequest</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules">BaseAuthModule</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.security.auth.message.AuthException</code></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/BasicAuthModule.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/eclipse/jetty/security/jaspi/modules/BaseAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/jetty/security/jaspi/modules/ClientCertAuthModule.html" title="class in org.eclipse.jetty.security.jaspi.modules"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/jetty/security/jaspi/modules/BasicAuthModule.html" target="_top">Frames</a></li>
<li><a href="BasicAuthModule.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="#fields.inherited.from.class.org.eclipse.jetty.security.jaspi.modules.BaseAuthModule">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>Field&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; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>