blob: 9bd4fc3f66299addcaeac4bf017bf90d86b7b11f [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>SecurityHandler (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="SecurityHandler (Eclipse Jetty API Doc - v10.0.9)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":6,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":6,"i19":10,"i20":10,"i21":10,"i22":6,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/SecurityHandler.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><a href="#nested.class.summary">Nested</a>&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</a></div>
<h2 title="Class SecurityHandler" class="title">Class SecurityHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li>
<li>
<ul class="inheritance">
<li><a href="../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a></li>
<li>
<ul class="inheritance">
<li><a href="../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandler</a></li>
<li>
<ul class="inheritance">
<li><a href="../server/handler/AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandlerContainer</a></li>
<li>
<ul class="inheritance">
<li><a href="../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.HandlerWrapper</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.security.SecurityHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</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.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code>, <code><a href="../server/Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code>, <code><a href="../server/HandlerContainer.html" title="interface in org.eclipse.jetty.server">HandlerContainer</a></code>, <code><a href="../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code>, <code><a href="../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ConstraintSecurityHandler.html" title="class in org.eclipse.jetty.security">ConstraintSecurityHandler</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">SecurityHandler</span>
extends <a href="../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a>
implements <a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></pre>
<div class="block">Abstract SecurityHandler.
<p>
Select and apply an <a href="Authenticator.html" title="interface in org.eclipse.jetty.security"><code>Authenticator</code></a> to a request.
<p>
The Authenticator may either be directly set on the handler
or will be create during <a href="../util/component/AbstractLifeCycle.html#start()"><code>AbstractLifeCycle.start()</code></a> with a call to
either the default or set AuthenticatorFactory.
<p>
SecurityHandler has a set of initparameters that are used by the
Authentication.Configuration. At startup, any context init parameters
that start with "org.eclipse.jetty.security." that do not have
values in the SecurityHandler init parameters, are copied.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SecurityHandler.NotChecked.html" title="class in org.eclipse.jetty.security">SecurityHandler.NotChecked</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.server.handler.<a href="../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3>
<code><a href="../server/handler/AbstractHandler.ErrorDispatchHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler.ErrorDispatchHandler</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a>, <a href="../util/component/AbstractLifeCycle.StopException.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.StopException</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3>
<code><a href="../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3>
<code><a href="../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== 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.security.Principal</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__NO_USER">__NO_USER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.security.Principal</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__NOBODY">__NOBODY</a></span></code></th>
<td class="colLast">
<div class="block">Nobody user.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.server.handler.HandlerWrapper">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.server.handler.<a href="../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3>
<code><a href="../server/handler/HandlerWrapper.html#_handler">_handler</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../util/component/Dumpable.html#KEY">KEY</a></code></li>
</ul>
</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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SecurityHandler</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="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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 boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkSecurity(org.eclipse.jetty.server.Request)">checkSecurity</a></span>&#8203;(<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkUserDataPermissions(java.lang.String,org.eclipse.jetty.server.Request,org.eclipse.jetty.server.Response,org.eclipse.jetty.security.RoleInfo)">checkUserDataPermissions</a></span>&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request,
<a href="../server/Response.html" title="class in org.eclipse.jetty.server">Response</a>&nbsp;response,
<a href="RoleInfo.html" title="class in org.eclipse.jetty.security">RoleInfo</a>&nbsp;constraintInfo)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkWebResourcePermissions(java.lang.String,org.eclipse.jetty.server.Request,org.eclipse.jetty.server.Response,java.lang.Object,org.eclipse.jetty.server.UserIdentity)">checkWebResourcePermissions</a></span>&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request,
<a href="../server/Response.html" title="class in org.eclipse.jetty.server">Response</a>&nbsp;response,
java.lang.Object&nbsp;constraintInfo,
<a href="../server/UserIdentity.html" title="interface in org.eclipse.jetty.server">UserIdentity</a>&nbsp;userIdentity)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th>
<td class="colLast">
<div class="block">Starts the managed lifecycle beans in the order they were added.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th>
<td class="colLast">
<div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findIdentityService()">findIdentityService</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findLoginService()">findLoginService</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<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()">getAuthenticator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticatorFactory()">getAuthenticatorFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthMethod()">getAuthMethod</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="SecurityHandler.html" title="class in org.eclipse.jetty.security">SecurityHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentSecurityHandler()">getCurrentSecurityHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentityService()">getIdentityService</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the identityService.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitParameter(java.lang.String)">getInitParameter</a></span>&#8203;(java.lang.String&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Get a SecurityHandler init parameter</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitParameterNames()">getInitParameterNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a SecurityHandler init parameter names</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKnownAuthenticatorFactories()">getKnownAuthenticatorFactories</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoginService()">getLoginService</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the loginService.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRealmName()">getRealmName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a></span>&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;baseRequest,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Handle a request.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAuthMandatory(org.eclipse.jetty.server.Request,org.eclipse.jetty.server.Response,java.lang.Object)">isAuthMandatory</a></span>&#8203;(<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;baseRequest,
<a href="../server/Response.html" title="class in org.eclipse.jetty.server">Response</a>&nbsp;baseResponse,
java.lang.Object&nbsp;constraintInfo)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCheckWelcomeFiles()">isCheckWelcomeFiles</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSessionRenewedOnAuthentication()">isSessionRenewedOnAuthentication</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logout(org.eclipse.jetty.server.Authentication.User)">logout</a></span>&#8203;(<a href="../server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a>&nbsp;user)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>protected abstract <a href="RoleInfo.html" title="class in org.eclipse.jetty.security">RoleInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareConstraintInfo(java.lang.String,org.eclipse.jetty.server.Request)">prepareConstraintInfo</a></span>&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthenticator(org.eclipse.jetty.security.Authenticator)">setAuthenticator</a></span>&#8203;(<a href="Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a>&nbsp;authenticator)</code></th>
<td class="colLast">
<div class="block">Set the authenticator.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthenticatorFactory(org.eclipse.jetty.security.Authenticator.Factory)">setAuthenticatorFactory</a></span>&#8203;(<a href="Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a>&nbsp;authenticatorFactory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthMethod(java.lang.String)">setAuthMethod</a></span>&#8203;(java.lang.String&nbsp;authMethod)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCheckWelcomeFiles(boolean)">setCheckWelcomeFiles</a></span>&#8203;(boolean&nbsp;authenticateWelcomeFiles)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdentityService(org.eclipse.jetty.security.IdentityService)">setIdentityService</a></span>&#8203;(<a href="IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a>&nbsp;identityService)</code></th>
<td class="colLast">
<div class="block">Set the identityService.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitParameter(java.lang.String,java.lang.String)">setInitParameter</a></span>&#8203;(java.lang.String&nbsp;key,
java.lang.String&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Set an initialization parameter.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLoginService(org.eclipse.jetty.security.LoginService)">setLoginService</a></span>&#8203;(<a href="LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&nbsp;loginService)</code></th>
<td class="colLast">
<div class="block">Set the loginService.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRealmName(java.lang.String)">setRealmName</a></span>&#8203;(java.lang.String&nbsp;realmName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionRenewedOnAuthentication(boolean)">setSessionRenewedOnAuthentication</a></span>&#8203;(boolean&nbsp;renew)</code></th>
<td class="colLast">
<div class="block">Set renew the session on Authentication.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.HandlerWrapper">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.server.handler.<a href="../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3>
<code><a href="../server/handler/HandlerWrapper.html#destroy()">destroy</a>, <a href="../server/handler/HandlerWrapper.html#expandChildren(java.util.List,java.lang.Class)">expandChildren</a>, <a href="../server/handler/HandlerWrapper.html#getHandler()">getHandler</a>, <a href="../server/handler/HandlerWrapper.html#getHandlers()">getHandlers</a>, <a href="../server/handler/HandlerWrapper.html#insertHandler(org.eclipse.jetty.server.handler.HandlerWrapper)">insertHandler</a>, <a href="../server/handler/HandlerWrapper.html#setHandler(org.eclipse.jetty.server.Handler)">setHandler</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandlerContainer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.server.handler.<a href="../server/handler/AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">AbstractHandlerContainer</a></h3>
<code><a href="../server/handler/AbstractHandlerContainer.html#expandHandler(org.eclipse.jetty.server.Handler,java.util.List,java.lang.Class)">expandHandler</a>, <a href="../server/handler/AbstractHandlerContainer.html#findContainerOf(org.eclipse.jetty.server.HandlerContainer,java.lang.Class,org.eclipse.jetty.server.Handler)">findContainerOf</a>, <a href="../server/handler/AbstractHandlerContainer.html#getChildHandlerByClass(java.lang.Class)">getChildHandlerByClass</a>, <a href="../server/handler/AbstractHandlerContainer.html#getChildHandlers()">getChildHandlers</a>, <a href="../server/handler/AbstractHandlerContainer.html#getChildHandlersByClass(java.lang.Class)">getChildHandlersByClass</a>, <a href="../server/handler/AbstractHandlerContainer.html#setServer(org.eclipse.jetty.server.Server)">setServer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.server.handler.<a href="../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3>
<code><a href="../server/handler/AbstractHandler.html#doError(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doError</a>, <a href="../server/handler/AbstractHandler.html#getServer()">getServer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3>
<code><a href="../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../util/component/ContainerLifeCycle.html#addEventListener(java.util.EventListener)">addEventListener</a>, <a href="../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../util/component/ContainerLifeCycle.html#removeEventListener(java.util.EventListener)">removeEventListener</a>, <a href="../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a>, <a href="../util/component/ContainerLifeCycle.html#updateBeans(java.util.Collection,java.util.Collection)">updateBeans</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../util/component/AbstractLifeCycle.html#getEventListeners()">getEventListeners</a>, <a href="../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../util/component/AbstractLifeCycle.html#setEventListeners(java.util.Collection)">setEventListeners</a>, <a href="../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../util/component/AbstractLifeCycle.html#stop()">stop</a>, <a href="../util/component/AbstractLifeCycle.html#toString()">toString</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, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Container">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3>
<code><a href="../util/component/Container.html#getCachedBeans(java.lang.Class)">getCachedBeans</a>, <a href="../util/component/Container.html#getEventListeners()">getEventListeners</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable.DumpableContainer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></h3>
<code><a href="../util/component/Dumpable.DumpableContainer.html#isDumpable(java.lang.Object)">isDumpable</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3>
<code><a href="../util/component/LifeCycle.html#addEventListener(java.util.EventListener)">addEventListener</a>, <a href="../util/component/LifeCycle.html#isFailed()">isFailed</a>, <a href="../util/component/LifeCycle.html#isRunning()">isRunning</a>, <a href="../util/component/LifeCycle.html#isStarted()">isStarted</a>, <a href="../util/component/LifeCycle.html#isStarting()">isStarting</a>, <a href="../util/component/LifeCycle.html#isStopped()">isStopped</a>, <a href="../util/component/LifeCycle.html#isStopping()">isStopping</a>, <a href="../util/component/LifeCycle.html#removeEventListener(java.util.EventListener)">removeEventListener</a>, <a href="../util/component/LifeCycle.html#start()">start</a>, <a href="../util/component/LifeCycle.html#stop()">stop</a></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="__NO_USER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>__NO_USER</h4>
<pre>public static final&nbsp;java.security.Principal __NO_USER</pre>
</li>
</ul>
<a id="__NOBODY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>__NOBODY</h4>
<pre>public static final&nbsp;java.security.Principal __NOBODY</pre>
<div class="block">Nobody user. The Nobody UserPrincipal is used to indicate a partial state
of authentication. A request with a Nobody UserPrincipal will be allowed
past all authentication constraints - but will not be considered an
authenticated request. It can be used by Authenticators such as
FormAuthenticator to allow access to logon and error pages within an
authenticated URI tree.</div>
</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>SecurityHandler</h4>
<pre>protected&nbsp;SecurityHandler()</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="getIdentityService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentityService</h4>
<pre class="methodSignature">public&nbsp;<a href="IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a>&nbsp;getIdentityService()</pre>
<div class="block">Get the identityService.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#getIdentityService()">getIdentityService</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the identityService</dd>
</dl>
</li>
</ul>
<a id="setIdentityService(org.eclipse.jetty.security.IdentityService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdentityService</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIdentityService&#8203;(<a href="IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a>&nbsp;identityService)</pre>
<div class="block">Set the identityService.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identityService</code> - the identityService to set</dd>
</dl>
</li>
</ul>
<a id="getLoginService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoginService</h4>
<pre class="methodSignature">public&nbsp;<a href="LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&nbsp;getLoginService()</pre>
<div class="block">Get the loginService.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#getLoginService()">getLoginService</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the loginService</dd>
</dl>
</li>
</ul>
<a id="setLoginService(org.eclipse.jetty.security.LoginService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoginService</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setLoginService&#8203;(<a href="LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&nbsp;loginService)</pre>
<div class="block">Set the loginService.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loginService</code> - the loginService to set</dd>
</dl>
</li>
</ul>
<a id="getAuthenticator()">
<!-- -->
</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()</pre>
</li>
</ul>
<a id="setAuthenticator(org.eclipse.jetty.security.Authenticator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthenticator</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAuthenticator&#8203;(<a href="Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a>&nbsp;authenticator)</pre>
<div class="block">Set the authenticator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authenticator</code> - the authenticator</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the SecurityHandler is running</dd>
</dl>
</li>
</ul>
<a id="getAuthenticatorFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticatorFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a>&nbsp;getAuthenticatorFactory()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authenticatorFactory</dd>
</dl>
</li>
</ul>
<a id="setAuthenticatorFactory(org.eclipse.jetty.security.Authenticator.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthenticatorFactory</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAuthenticatorFactory&#8203;(<a href="Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a>&nbsp;authenticatorFactory)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authenticatorFactory</code> - the authenticatorFactory to set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the SecurityHandler is running</dd>
</dl>
</li>
</ul>
<a id="getKnownAuthenticatorFactories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKnownAuthenticatorFactories</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a>&gt;&nbsp;getKnownAuthenticatorFactories()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of discovered authenticatorFactories</dd>
</dl>
</li>
</ul>
<a id="getRealmName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRealmName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getRealmName()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#getRealmName()">getRealmName</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the realmName</dd>
</dl>
</li>
</ul>
<a id="setRealmName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRealmName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRealmName&#8203;(java.lang.String&nbsp;realmName)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>realmName</code> - the realmName to set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the SecurityHandler is running</dd>
</dl>
</li>
</ul>
<a id="getAuthMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthMethod</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getAuthMethod()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#getAuthMethod()">getAuthMethod</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authMethod</dd>
</dl>
</li>
</ul>
<a id="setAuthMethod(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthMethod</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAuthMethod&#8203;(java.lang.String&nbsp;authMethod)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authMethod</code> - the authMethod to set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the SecurityHandler is running</dd>
</dl>
</li>
</ul>
<a id="isCheckWelcomeFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCheckWelcomeFiles</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCheckWelcomeFiles()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if forwards to welcome files are authenticated</dd>
</dl>
</li>
</ul>
<a id="setCheckWelcomeFiles(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCheckWelcomeFiles</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCheckWelcomeFiles&#8203;(boolean&nbsp;authenticateWelcomeFiles)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authenticateWelcomeFiles</code> - True if forwards to welcome files are
authenticated</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the SecurityHandler is running</dd>
</dl>
</li>
</ul>
<a id="getInitParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitParameter</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getInitParameter&#8203;(java.lang.String&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Authenticator.AuthConfiguration.html#getInitParameter(java.lang.String)">Authenticator.AuthConfiguration</a></code></span></div>
<div class="block">Get a SecurityHandler init parameter</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#getInitParameter(java.lang.String)">getInitParameter</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - parameter name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Parameter value or null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getInitParameter(java.lang.String)"><code>getInitParameter(String)</code></a></dd>
</dl>
</li>
</ul>
<a id="getInitParameterNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitParameterNames</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getInitParameterNames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Authenticator.AuthConfiguration.html#getInitParameterNames()">Authenticator.AuthConfiguration</a></code></span></div>
<div class="block">Get a SecurityHandler init parameter names</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#getInitParameterNames()">getInitParameterNames</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Set of parameter names</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getInitParameterNames()"><code>getInitParameterNames()</code></a></dd>
</dl>
</li>
</ul>
<a id="setInitParameter(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitParameter</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;setInitParameter&#8203;(java.lang.String&nbsp;key,
java.lang.String&nbsp;value)</pre>
<div class="block">Set an initialization parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the init key</dd>
<dd><code>value</code> - the init value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>previous value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the SecurityHandler is started</dd>
</dl>
</li>
</ul>
<a id="findLoginService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findLoginService</h4>
<pre class="methodSignature">protected&nbsp;<a href="LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&nbsp;findLoginService()
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="findIdentityService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findIdentityService</h4>
<pre class="methodSignature">protected&nbsp;<a href="IdentityService.html" title="interface in org.eclipse.jetty.security">IdentityService</a>&nbsp;findIdentityService()</pre>
</li>
</ul>
<a id="doStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStart</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;doStart()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../util/component/ContainerLifeCycle.html#doStart()">ContainerLifeCycle</a></code></span></div>
<div class="block">Starts the managed lifecycle beans in the order they were added.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../server/handler/AbstractHandler.html#doStart()">doStart</a></code>&nbsp;in class&nbsp;<code><a href="../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../util/component/AbstractLifeCycle.StopException.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.StopException</a></code> - If thrown, the lifecycle will immediately be stopped.</dd>
<dd><code>java.lang.Exception</code> - If there was a problem starting. Will cause a transition to FAILED state</dd>
</dl>
</li>
</ul>
<a id="doStop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStop</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;doStop()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../util/component/ContainerLifeCycle.html#doStop()">ContainerLifeCycle</a></code></span></div>
<div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../server/handler/AbstractHandler.html#doStop()">doStop</a></code>&nbsp;in class&nbsp;<code><a href="../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - If there was a problem stopping. Will cause a transition to FAILED state</dd>
</dl>
</li>
</ul>
<a id="checkSecurity(org.eclipse.jetty.server.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkSecurity</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;checkSecurity&#8203;(<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</pre>
</li>
</ul>
<a id="isSessionRenewedOnAuthentication()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSessionRenewedOnAuthentication</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSessionRenewedOnAuthentication()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Authenticator.AuthConfiguration.html#isSessionRenewedOnAuthentication()">isSessionRenewedOnAuthentication</a></code>&nbsp;in interface&nbsp;<code><a href="Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a></code></dd>
</dl>
</li>
</ul>
<a id="setSessionRenewedOnAuthentication(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionRenewedOnAuthentication</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSessionRenewedOnAuthentication&#8203;(boolean&nbsp;renew)</pre>
<div class="block">Set renew the session on Authentication.
<p>
If set to true, then on authentication, the session associated with a reqeuest is invalidated and replaced with a new session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>renew</code> - true to renew the authentication on session</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Authenticator.AuthConfiguration.html#isSessionRenewedOnAuthentication()"><code>Authenticator.AuthConfiguration.isSessionRenewedOnAuthentication()</code></a></dd>
</dl>
</li>
</ul>
<a id="handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handle</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handle&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;baseRequest,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws java.io.IOException,
javax.servlet.ServletException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../server/Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">Handler</a></code></span></div>
<div class="block">Handle a request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../server/Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a></code>&nbsp;in interface&nbsp;<code><a href="../server/Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../server/handler/HandlerWrapper.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a></code>&nbsp;in class&nbsp;<code><a href="../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pathInContext</code> - The target of the request - either a URI or a name.</dd>
<dd><code>baseRequest</code> - The original unwrapped request object.</dd>
<dd><code>request</code> - The request either as the <a href="../server/Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object or a wrapper of that request. The
<code><a href="../server/HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../server/HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../server/HttpChannel.html#getRequest()"><code>getRequest()</code></a></code>
method can be used access the Request object if required.</dd>
<dd><code>response</code> - The response as the <a href="../server/Response.html" title="class in org.eclipse.jetty.server"><code>Response</code></a> object or a wrapper of that request. The
<code><a href="../server/HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../server/HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../server/HttpChannel.html#getResponse()"><code>getResponse()</code></a></code>
method can be used access the Response object if required.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to handle the request or response processing</dd>
<dd><code>javax.servlet.ServletException</code> - if unable to handle the request or response due to underlying servlet issue</dd>
</dl>
</li>
</ul>
<a id="getCurrentSecurityHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentSecurityHandler</h4>
<pre class="methodSignature">public static&nbsp;<a href="SecurityHandler.html" title="class in org.eclipse.jetty.security">SecurityHandler</a>&nbsp;getCurrentSecurityHandler()</pre>
</li>
</ul>
<a id="logout(org.eclipse.jetty.server.Authentication.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;logout&#8203;(<a href="../server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a>&nbsp;user)</pre>
</li>
</ul>
<a id="prepareConstraintInfo(java.lang.String,org.eclipse.jetty.server.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareConstraintInfo</h4>
<pre class="methodSignature">protected abstract&nbsp;<a href="RoleInfo.html" title="class in org.eclipse.jetty.security">RoleInfo</a>&nbsp;prepareConstraintInfo&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</pre>
</li>
</ul>
<a id="checkUserDataPermissions(java.lang.String,org.eclipse.jetty.server.Request,org.eclipse.jetty.server.Response,org.eclipse.jetty.security.RoleInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkUserDataPermissions</h4>
<pre class="methodSignature">protected abstract&nbsp;boolean&nbsp;checkUserDataPermissions&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request,
<a href="../server/Response.html" title="class in org.eclipse.jetty.server">Response</a>&nbsp;response,
<a href="RoleInfo.html" title="class in org.eclipse.jetty.security">RoleInfo</a>&nbsp;constraintInfo)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="isAuthMandatory(org.eclipse.jetty.server.Request,org.eclipse.jetty.server.Response,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAuthMandatory</h4>
<pre class="methodSignature">protected abstract&nbsp;boolean&nbsp;isAuthMandatory&#8203;(<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;baseRequest,
<a href="../server/Response.html" title="class in org.eclipse.jetty.server">Response</a>&nbsp;baseResponse,
java.lang.Object&nbsp;constraintInfo)</pre>
</li>
</ul>
<a id="checkWebResourcePermissions(java.lang.String,org.eclipse.jetty.server.Request,org.eclipse.jetty.server.Response,java.lang.Object,org.eclipse.jetty.server.UserIdentity)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>checkWebResourcePermissions</h4>
<pre class="methodSignature">protected abstract&nbsp;boolean&nbsp;checkWebResourcePermissions&#8203;(java.lang.String&nbsp;pathInContext,
<a href="../server/Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request,
<a href="../server/Response.html" title="class in org.eclipse.jetty.server">Response</a>&nbsp;response,
java.lang.Object&nbsp;constraintInfo,
<a href="../server/UserIdentity.html" title="interface in org.eclipse.jetty.server">UserIdentity</a>&nbsp;userIdentity)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></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/SecurityHandler.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><a href="#nested.class.summary">Nested</a>&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>