blob: 40e295fbabcc470b1a14cfd6aa5986243c8157bd [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.14.1) on Mon Apr 04 09:09:38 CDT 2022 -->
<title>JaspiAuthenticatorFactory (Eclipse Jetty API Doc - v10.0.9)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JaspiAuthenticatorFactory (Eclipse Jetty API Doc - v10.0.9)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JaspiAuthenticatorFactory.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.security.jaspi</a></div>
<h2 title="Class JaspiAuthenticatorFactory" class="title">Class JaspiAuthenticatorFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">org.eclipse.jetty.security.DefaultAuthenticatorFactory</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.security.jaspi.JaspiAuthenticatorFactory</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">JaspiAuthenticatorFactory</span>
extends <a href="../DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">DefaultAuthenticatorFactory</a></pre>
<div class="block">Javax Authentication (JASPI) Authenticator Factory.
This is used to link a jetty-security <a href="../Authenticator.Factory.html" title="interface in org.eclipse.jetty.security"><code>Authenticator.Factory</code></a> to a Javax Authentication <code>AuthConfigFactory</code>.
<p>
This should be initialized with the provided <a href="DefaultAuthConfigFactory.html" title="class in org.eclipse.jetty.security.jaspi"><code>DefaultAuthConfigFactory</code></a> to set up Javax Authentication <code>AuthConfigFactory</code> before use.
(A different <code>AuthConfigFactory</code> may also be provided using the same steps below)
<p>
To initialize either:
<ul>
<li>invoke <code>AuthConfigFactory.setFactory(AuthConfigFactory)</code></li>
<li>Alternatively: set <code>AuthConfigFactory.DEFAULT_FACTORY_SECURITY_PROPERTY</code></li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGE_LAYER">MESSAGE_LAYER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">JaspiAuthenticatorFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findServerName(javax.servlet.ServletContext,org.eclipse.jetty.server.Server)">findServerName</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</code></th>
<td class="colLast">
<div class="block">Find a servername.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected javax.security.auth.Subject</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findServiceSubject(org.eclipse.jetty.server.Server)">findServiceSubject</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</code></th>
<td class="colLast">
<div class="block">Find a service Subject.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticator(org.eclipse.jetty.server.Server,javax.servlet.ServletContext,org.eclipse.jetty.security.Authenticator.AuthConfiguration,org.eclipse.jetty.security.IdentityService,org.eclipse.jetty.security.LoginService)">getAuthenticator</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
javax.servlet.ServletContext&nbsp;context,
<a href="../Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a>&nbsp;configuration,
<a href="../IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a>&nbsp;identityService,
<a href="../LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&nbsp;loginService)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerName()">getServerName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>javax.security.auth.Subject</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServiceSubject()">getServiceSubject</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setServerName(java.lang.String)">setServerName</a></span>&#8203;(java.lang.String&nbsp;serverName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setServiceSubject(javax.security.auth.Subject)">setServiceSubject</a></span>&#8203;(javax.security.auth.Subject&nbsp;serviceSubject)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.security.DefaultAuthenticatorFactory">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.security.<a href="../DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">DefaultAuthenticatorFactory</a></h3>
<code><a href="../DefaultAuthenticatorFactory.html#getLoginService()">getLoginService</a>, <a href="../DefaultAuthenticatorFactory.html#setLoginService(org.eclipse.jetty.security.LoginService)">setLoginService</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="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>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="MESSAGE_LAYER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MESSAGE_LAYER</h4>
<pre>public static final&nbsp;java.lang.String MESSAGE_LAYER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.security.jaspi.JaspiAuthenticatorFactory.MESSAGE_LAYER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JaspiAuthenticatorFactory</h4>
<pre>public&nbsp;JaspiAuthenticatorFactory()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getServiceSubject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceSubject</h4>
<pre class="methodSignature">public&nbsp;javax.security.auth.Subject&nbsp;getServiceSubject()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serviceSubject</dd>
</dl>
</li>
</ul>
<a id="setServiceSubject(javax.security.auth.Subject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServiceSubject</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setServiceSubject&#8203;(javax.security.auth.Subject&nbsp;serviceSubject)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serviceSubject</code> - the serviceSubject to set</dd>
</dl>
</li>
</ul>
<a id="getServerName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getServerName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serverName</dd>
</dl>
</li>
</ul>
<a id="setServerName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServerName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setServerName&#8203;(java.lang.String&nbsp;serverName)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serverName</code> - the serverName to set</dd>
</dl>
</li>
</ul>
<a id="getAuthenticator(org.eclipse.jetty.server.Server,javax.servlet.ServletContext,org.eclipse.jetty.security.Authenticator.AuthConfiguration,org.eclipse.jetty.security.IdentityService,org.eclipse.jetty.security.LoginService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticator</h4>
<pre class="methodSignature">public&nbsp;<a href="../Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a>&nbsp;getAuthenticator&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
javax.servlet.ServletContext&nbsp;context,
<a href="../Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a>&nbsp;configuration,
<a href="../IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a>&nbsp;identityService,
<a href="../LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&nbsp;loginService)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Authenticator.Factory.html#getAuthenticator(org.eclipse.jetty.server.Server,javax.servlet.ServletContext,org.eclipse.jetty.security.Authenticator.AuthConfiguration,org.eclipse.jetty.security.IdentityService,org.eclipse.jetty.security.LoginService)">getAuthenticator</a></code>&nbsp;in interface&nbsp;<code><a href="../Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../DefaultAuthenticatorFactory.html#getAuthenticator(org.eclipse.jetty.server.Server,javax.servlet.ServletContext,org.eclipse.jetty.security.Authenticator.AuthConfiguration,org.eclipse.jetty.security.IdentityService,org.eclipse.jetty.security.LoginService)">getAuthenticator</a></code>&nbsp;in class&nbsp;<code><a href="../DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">DefaultAuthenticatorFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="findServiceSubject(org.eclipse.jetty.server.Server)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findServiceSubject</h4>
<pre class="methodSignature">protected&nbsp;javax.security.auth.Subject&nbsp;findServiceSubject&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</pre>
<div class="block">Find a service Subject. If <a href="#setServiceSubject(javax.security.auth.Subject)"><code>setServiceSubject(Subject)</code></a> has not been
used to set a subject, then the <a href="../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)"><code>ContainerLifeCycle.getBeans(Class)</code></a> method is used
to look for a Subject.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server to pull the Subject from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the subject</dd>
</dl>
</li>
</ul>
<a id="findServerName(javax.servlet.ServletContext,org.eclipse.jetty.server.Server)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>findServerName</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;findServerName&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</pre>
<div class="block">Find a servername. If <a href="#setServerName(java.lang.String)"><code>setServerName(String)</code></a> has not been called,
then use the virtualServerName of the context.
If this is also null, then use the name of the a principal in the service subject.
If none are found, return "server".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - </dd>
<dd><code>server</code> - the server to find the name of</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the server name from the service Subject (or default value if not
found in subject or principals)</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JaspiAuthenticatorFactory.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>