| <!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>JaspiAuthenticatorFactory (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="JaspiAuthenticatorFactory (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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"; |
| </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/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"> |
| <li><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticator.html" title="class in org.eclipse.jetty.security.jaspi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiMessageInfo.html" title="class in org.eclipse.jetty.security.jaspi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html" target="_top">Frames</a></li> |
| <li><a href="JaspiAuthenticatorFactory.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>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.jetty.security.jaspi</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="../../../../../org/eclipse/jetty/security/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><a href="../../../../../org/eclipse/jetty/security/Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JaspiAuthenticatorFactory</span> |
| extends <a href="../../../../../org/eclipse/jetty/security/DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">DefaultAuthenticatorFactory</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#JaspiAuthenticatorFactory--">JaspiAuthenticatorFactory</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#findServerName-org.eclipse.jetty.server.Server-javax.security.auth.Subject-">findServerName</a></span>(<a href="../../../../../org/eclipse/jetty/server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server, |
| javax.security.auth.Subject subject)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#findServiceSubject-org.eclipse.jetty.server.Server-">findServiceSubject</a></span>(<a href="../../../../../org/eclipse/jetty/server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server)</code> |
| <div class="block">Find a service Subject.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/security/Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.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></span>(<a href="../../../../../org/eclipse/jetty/server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server, |
| javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/security/Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a> configuration, |
| <a href="../../../../../org/eclipse/jetty/security/IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a> identityService, |
| <a href="../../../../../org/eclipse/jetty/security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a> loginService)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#getServerName--">getServerName</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>javax.security.auth.Subject</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#getServiceSubject--">getServiceSubject</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#setServerName-java.lang.String-">setServerName</a></span>(java.lang.String serverName)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#setServiceSubject-javax.security.auth.Subject-">setServiceSubject</a></span>(javax.security.auth.Subject serviceSubject)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.security.DefaultAuthenticatorFactory"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.security.<a href="../../../../../org/eclipse/jetty/security/DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">DefaultAuthenticatorFactory</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/security/DefaultAuthenticatorFactory.html#getLoginService--">getLoginService</a>, <a href="../../../../../org/eclipse/jetty/security/DefaultAuthenticatorFactory.html#setLoginService-org.eclipse.jetty.security.LoginService-">setLoginService</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.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="JaspiAuthenticatorFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JaspiAuthenticatorFactory</h4> |
| <pre>public JaspiAuthenticatorFactory()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getServiceSubject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceSubject</h4> |
| <pre>public javax.security.auth.Subject getServiceSubject()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the serviceSubject</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setServiceSubject-javax.security.auth.Subject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServiceSubject</h4> |
| <pre>public void setServiceSubject(javax.security.auth.Subject serviceSubject)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceSubject</code> - the serviceSubject to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerName</h4> |
| <pre>public java.lang.String getServerName()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the serverName</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setServerName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServerName</h4> |
| <pre>public void setServerName(java.lang.String serverName)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverName</code> - the serverName to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="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>public <a href="../../../../../org/eclipse/jetty/security/Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a> getAuthenticator(<a href="../../../../../org/eclipse/jetty/server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server, |
| javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/security/Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a> configuration, |
| <a href="../../../../../org/eclipse/jetty/security/IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a> identityService, |
| <a href="../../../../../org/eclipse/jetty/security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a> loginService)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/security/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> in interface <code><a href="../../../../../org/eclipse/jetty/security/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="../../../../../org/eclipse/jetty/security/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> in class <code><a href="../../../../../org/eclipse/jetty/security/DefaultAuthenticatorFactory.html" title="class in org.eclipse.jetty.security">DefaultAuthenticatorFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="findServiceSubject-org.eclipse.jetty.server.Server-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findServiceSubject</h4> |
| <pre>protected javax.security.auth.Subject findServiceSubject(<a href="../../../../../org/eclipse/jetty/server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server)</pre> |
| <div class="block">Find a service Subject. |
| If <a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#setServiceSubject-javax.security.auth.Subject-"><code>setServiceSubject(Subject)</code></a> has not been used to |
| set a subject, then the <a href="../../../../../org/eclipse/jetty/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 name="findServerName-org.eclipse.jetty.server.Server-javax.security.auth.Subject-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>findServerName</h4> |
| <pre>protected java.lang.String findServerName(<a href="../../../../../org/eclipse/jetty/server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server, |
| javax.security.auth.Subject subject)</pre> |
| <div class="block">Find a servername. |
| If <a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html#setServerName-java.lang.String-"><code>setServerName(String)</code></a> has not been called, then |
| use the name of the a principal in the service subject. |
| If not found, return "server".</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>server</code> - not used</dd> |
| <dd><code>subject</code> - the subject to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the server name from the subject (or default value if not found in subject or principals)</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/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"> |
| <li><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiAuthenticator.html" title="class in org.eclipse.jetty.security.jaspi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/security/jaspi/JaspiMessageInfo.html" title="class in org.eclipse.jetty.security.jaspi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/security/jaspi/JaspiAuthenticatorFactory.html" target="_top">Frames</a></li> |
| <li><a href="JaspiAuthenticatorFactory.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>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1995–2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
