Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / integration / filter / authentication / HttpAuthenticator.html
blob: 6aeebaa6789c253ad78b6d8ce06c3efe0cbe6674 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>HttpAuthenticator (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="HttpAuthenticator (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":6,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All 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/HttpAuthenticator.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.apache.archiva.redback.integration.filter.authentication</a></div>
<h2 title="Class HttpAuthenticator" class="title">Class HttpAuthenticator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.archiva.redback.integration.filter.authentication.HttpAuthenticator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="basic/HttpBasicAuthentication.html" title="class in org.apache.archiva.redback.integration.filter.authentication.basic">HttpBasicAuthentication</a></code>, <code><a href="digest/HttpDigestAuthentication.html" title="class in org.apache.archiva.redback.integration.filter.authentication.digest">HttpDigestAuthentication</a></code></dd>
</dl>
<hr>
<pre>public abstract class <a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.47">HttpAuthenticator</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">HttpAuthenticator</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></dd>
</dl>
</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>protected <a href="https://www.slf4j.org/apidocs/org/slf4j/Logger.html?is-external=true" title="class or interface in org.slf4j" class="externalLink">Logger</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#log">log</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../system/SecuritySystem.html" title="interface in org.apache.archiva.redback.system">SecuritySystem</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#securitySystem">securitySystem</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()">HttpAuthenticator</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="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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticate(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">authenticate</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Entry point for a Filter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../authentication/AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticate(org.apache.archiva.redback.authentication.AuthenticationDataSource,javax.servlet.http.HttpSession)">authenticate</a></span>&#8203;(<a href="../../../authentication/AuthenticationDataSource.html" title="interface in org.apache.archiva.redback.authentication">AuthenticationDataSource</a>&nbsp;ds,
javax.servlet.http.HttpSession&nbsp;httpSession)</code></th>
<td class="colLast">
<div class="block">The Public Face of the Authenticator.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#challenge(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.String,org.apache.archiva.redback.authentication.AuthenticationException)">challenge</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;realmName,
<a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>&nbsp;exception)</code></th>
<td class="colLast">
<div class="block">Issue a Challenge Response back to the HTTP Client.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../authentication/AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationResult(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">getAuthenticationResult</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Parse the incoming request and return an AuthenticationResult.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../system/SecuritySession.html" title="interface in org.apache.archiva.redback.system">SecuritySession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecuritySession(javax.servlet.http.HttpSession)">getSecuritySession</a></span>&#8203;(javax.servlet.http.HttpSession&nbsp;httpSession)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../users/User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionUser(javax.servlet.http.HttpSession)">getSessionUser</a></span>&#8203;(javax.servlet.http.HttpSession&nbsp;httpSession)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAlreadyAuthenticated(javax.servlet.http.HttpSession)">isAlreadyAuthenticated</a></span>&#8203;(javax.servlet.http.HttpSession&nbsp;httpSession)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecuritySession(org.apache.archiva.redback.system.SecuritySession,javax.servlet.http.HttpSession)">setSecuritySession</a></span>&#8203;(<a href="../../../system/SecuritySession.html" title="interface in org.apache.archiva.redback.system">SecuritySession</a>&nbsp;session,
javax.servlet.http.HttpSession&nbsp;httpSession)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionUser(org.apache.archiva.redback.users.User,javax.servlet.http.HttpSession)">setSessionUser</a></span>&#8203;(<a href="../../../users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
javax.servlet.http.HttpSession&nbsp;httpSession)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</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="log">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>protected&nbsp;<a href="https://www.slf4j.org/apidocs/org/slf4j/Logger.html?is-external=true" title="class or interface in org.slf4j" class="externalLink">Logger</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.49">log</a></pre>
</li>
</ul>
<a id="securitySystem">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>securitySystem</h4>
<pre>@Inject
protected&nbsp;<a href="../../../system/SecuritySystem.html" title="interface in org.apache.archiva.redback.system">SecuritySystem</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.51">securitySystem</a></pre>
</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>HttpAuthenticator</h4>
<pre>public&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.47">HttpAuthenticator</a>()</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="authenticate(org.apache.archiva.redback.authentication.AuthenticationDataSource,javax.servlet.http.HttpSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../authentication/AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.60">authenticate</a>&#8203;(<a href="../../../authentication/AuthenticationDataSource.html" title="interface in org.apache.archiva.redback.authentication">AuthenticationDataSource</a>&nbsp;ds,
javax.servlet.http.HttpSession&nbsp;httpSession)
throws <a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>,
<a href="../../../policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a>,
<a href="../../../policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></pre>
<div class="block">The Public Face of the Authenticator.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></code></dd>
<dd><code><a href="../../../policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a></code></dd>
<dd><code><a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></code></dd>
</dl>
</li>
</ul>
<a id="authenticate(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.96">authenticate</a>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws <a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></pre>
<div class="block">Entry point for a Filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - </dd>
<dd><code>response</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></code></dd>
</dl>
</li>
</ul>
<a id="challenge(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.String,org.apache.archiva.redback.authentication.AuthenticationException)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>challenge</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.128">challenge</a>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;realmName,
<a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>&nbsp;exception)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Issue a Challenge Response back to the HTTP Client.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - </dd>
<dd><code>response</code> - </dd>
<dd><code>realmName</code> - </dd>
<dd><code>exception</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code></dd>
</dl>
</li>
</ul>
<a id="getAuthenticationResult(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationResult</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="../../../authentication/AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.142">getAuthenticationResult</a>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws <a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>,
<a href="../../../policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a>,
<a href="../../../policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></pre>
<div class="block">Parse the incoming request and return an AuthenticationResult.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - </dd>
<dd><code>response</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if no http auth credentials, or the actual authentication result based on the credentials.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></code></dd>
<dd><code><a href="../../../policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></code></dd>
<dd><code><a href="../../../policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a></code></dd>
</dl>
</li>
</ul>
<a id="getSessionUser(javax.servlet.http.HttpSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionUser</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.147">getSessionUser</a>&#8203;(javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a id="isAlreadyAuthenticated(javax.servlet.http.HttpSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAlreadyAuthenticated</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.152">isAlreadyAuthenticated</a>&#8203;(javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a id="getSecuritySession(javax.servlet.http.HttpSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecuritySession</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../system/SecuritySession.html" title="interface in org.apache.archiva.redback.system">SecuritySession</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.159">getSecuritySession</a>&#8203;(javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a id="setSecuritySession(org.apache.archiva.redback.system.SecuritySession,javax.servlet.http.HttpSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecuritySession</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.171">setSecuritySession</a>&#8203;(<a href="../../../system/SecuritySession.html" title="interface in org.apache.archiva.redback.system">SecuritySession</a>&nbsp;session,
javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a id="setSessionUser(org.apache.archiva.redback.users.User,javax.servlet.http.HttpSession)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setSessionUser</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.177">setSessionUser</a>&#8203;(<a href="../../../users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</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/HttpAuthenticator.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; 2006&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>