blob: 416a4424facf3f6c6daa3a00906c26fba71b1184 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HttpAuthenticator (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpAuthenticator (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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">
<li><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticationException.html" title="class in org.apache.archiva.redback.integration.filter.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html" target="_top">Frames</a></li>
<li><a href="HttpAuthenticator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.archiva.redback.integration.filter.authentication</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">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><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/basic/HttpBasicAuthentication.html" title="class in org.apache.archiva.redback.integration.filter.authentication.basic">HttpBasicAuthentication</a>, <a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/digest/HttpDigestAuthentication.html" title="class in org.apache.archiva.redback.integration.filter.authentication.digest">HttpDigestAuthentication</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.48">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">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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#log">log</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/archiva/redback/system/SecuritySystem.html" title="interface in org.apache.archiva.redback.system">SecuritySystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#securitySystem">securitySystem</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#HttpAuthenticator--">HttpAuthenticator</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#authenticate-org.apache.archiva.redback.authentication.AuthenticationDataSource-javax.servlet.http.HttpSession-">authenticate</a></span>(<a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationDataSource.html" title="interface in org.apache.archiva.redback.authentication">AuthenticationDataSource</a>&nbsp;ds,
javax.servlet.http.HttpSession&nbsp;httpSession)</code>
<div class="block">The Public Face of the Authenticator.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#authenticate-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">authenticate</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code>
<div class="block">Entry point for a Filter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#challenge-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-org.apache.archiva.redback.authentication.AuthenticationException-">challenge</a></span>(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">String</a>&nbsp;realmName,
<a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>&nbsp;exception)</code>
<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="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#getAuthenticationResult-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">getAuthenticationResult</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code>
<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="../../../../../../../org/apache/archiva/redback/system/SecuritySession.html" title="interface in org.apache.archiva.redback.system">SecuritySession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#getSecuritySession-javax.servlet.http.HttpSession-">getSecuritySession</a></span>(javax.servlet.http.HttpSession&nbsp;httpSession)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#getSessionUser-javax.servlet.http.HttpSession-">getSessionUser</a></span>(javax.servlet.http.HttpSession&nbsp;httpSession)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#isAlreadyAuthenticated-javax.servlet.http.HttpSession-">isAlreadyAuthenticated</a></span>(javax.servlet.http.HttpSession&nbsp;httpSession)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#setSecuritySession-org.apache.archiva.redback.system.SecuritySession-javax.servlet.http.HttpSession-">setSecuritySession</a></span>(<a href="../../../../../../../org/apache/archiva/redback/system/SecuritySession.html" title="interface in org.apache.archiva.redback.system">SecuritySession</a>&nbsp;session,
javax.servlet.http.HttpSession&nbsp;httpSession)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#setSessionUser-org.apache.archiva.redback.users.User-javax.servlet.http.HttpSession-">setSessionUser</a></span>(<a href="../../../../../../../org/apache/archiva/redback/users/User.html" title="interface in org.apache.archiva.redback.users">User</a>&nbsp;user,
javax.servlet.http.HttpSession&nbsp;httpSession)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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">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">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">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">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">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">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">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">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">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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="log">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>protected&nbsp;org.slf4j.Logger <a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.50">log</a></pre>
</li>
</ul>
<a name="securitySystem">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>securitySystem</h4>
<pre>@Inject
protected&nbsp;<a href="../../../../../../../org/apache/archiva/redback/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.53">securitySystem</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HttpAuthenticator--">
<!-- -->
</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.48">HttpAuthenticator</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="authenticate-org.apache.archiva.redback.authentication.AuthenticationDataSource-javax.servlet.http.HttpSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/archiva/redback/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.61">authenticate</a>(<a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationDataSource.html" title="interface in org.apache.archiva.redback.authentication">AuthenticationDataSource</a>&nbsp;ds,
javax.servlet.http.HttpSession&nbsp;httpSession)
throws <a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>,
<a href="../../../../../../../org/apache/archiva/redback/policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a>,
<a href="../../../../../../../org/apache/archiva/redback/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="../../../../../../../org/apache/archiva/redback/policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/archiva/redback/policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></code></dd>
</dl>
</li>
</ul>
<a name="authenticate-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.97">authenticate</a>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws <a href="../../../../../../../org/apache/archiva/redback/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="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></code></dd>
</dl>
</li>
</ul>
<a name="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>public abstract&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.129">challenge</a>(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">String</a>&nbsp;realmName,
<a href="../../../../../../../org/apache/archiva/redback/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">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">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAuthenticationResult-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationResult</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/archiva/redback/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.143">getAuthenticationResult</a>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws <a href="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a>,
<a href="../../../../../../../org/apache/archiva/redback/policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a>,
<a href="../../../../../../../org/apache/archiva/redback/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="../../../../../../../org/apache/archiva/redback/authentication/AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/archiva/redback/policy/MustChangePasswordException.html" title="class in org.apache.archiva.redback.policy">MustChangePasswordException</a></code></dd>
<dd><code><a href="../../../../../../../org/apache/archiva/redback/policy/AccountLockedException.html" title="class in org.apache.archiva.redback.policy">AccountLockedException</a></code></dd>
</dl>
</li>
</ul>
<a name="getSessionUser-javax.servlet.http.HttpSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionUser</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/archiva/redback/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.148">getSessionUser</a>(javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a name="isAlreadyAuthenticated-javax.servlet.http.HttpSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAlreadyAuthenticated</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.153">isAlreadyAuthenticated</a>(javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a name="getSecuritySession-javax.servlet.http.HttpSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecuritySession</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/archiva/redback/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.160">getSecuritySession</a>(javax.servlet.http.HttpSession&nbsp;httpSession)</pre>
</li>
</ul>
<a name="setSecuritySession-org.apache.archiva.redback.system.SecuritySession-javax.servlet.http.HttpSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecuritySession</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.172">setSecuritySession</a>(<a href="../../../../../../../org/apache/archiva/redback/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 name="setSessionUser-org.apache.archiva.redback.users.User-javax.servlet.http.HttpSession-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setSessionUser</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html#line.178">setSessionUser</a>(<a href="../../../../../../../org/apache/archiva/redback/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>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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">
<li><a href="../../../../../../../org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticationException.html" title="class in org.apache.archiva.redback.integration.filter.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/archiva/redback/integration/filter/authentication/HttpAuthenticator.html" target="_top">Frames</a></li>
<li><a href="HttpAuthenticator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>