blob: 9c133aaf2c0afa5f2955a6be26c0347ce88cae6b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.archiva.redback.authentication (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="org.apache.archiva.redback.authentication (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.archiva.redback.authentication</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AuthenticationDataSource.html" title="interface in org.apache.archiva.redback.authentication">AuthenticationDataSource</a></th>
<td class="colLast">
<div class="block">Just a tag to indicate that the implementing class is an AuthenticationDataSource.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AuthenticationManager.html" title="interface in org.apache.archiva.redback.authentication">AuthenticationManager</a></th>
<td class="colLast">
<div class="block">AuthenticationManager:</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Authenticator.html" title="interface in org.apache.archiva.redback.authentication">Authenticator</a></th>
<td class="colLast">
<div class="block">Authenticator:</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Token.html" title="interface in org.apache.archiva.redback.authentication">Token</a></th>
<td class="colLast">
<div class="block">This interface represents a token including its metadata.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TokenData.html" title="interface in org.apache.archiva.redback.authentication">TokenData</a></th>
<td class="colLast">
<div class="block">This contains the token payload that is used for verification of tokens.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractAuthenticator.html" title="class in org.apache.archiva.redback.authentication">AbstractAuthenticator</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AuthenticationConstants.html" title="class in org.apache.archiva.redback.authentication">AuthenticationConstants</a></th>
<td class="colLast">
<div class="block">Contants class used for authentication</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AuthenticationFailureCause.html" title="class in org.apache.archiva.redback.authentication">AuthenticationFailureCause</a></th>
<td class="colLast">
<div class="block">detail on possible authentication failure.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AuthenticationResult.html" title="class in org.apache.archiva.redback.authentication">AuthenticationResult</a></th>
<td class="colLast">
<div class="block">AuthenticationResult: wrapper object for information that comes back from the authentication system</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AuthenticatorControl.html" title="class in org.apache.archiva.redback.authentication">AuthenticatorControl</a></th>
<td class="colLast">
<div class="block">Gives a priority and what to do, if the authentication succeeds.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BearerTokenAuthenticationDataSource.html" title="class in org.apache.archiva.redback.authentication">BearerTokenAuthenticationDataSource</a></th>
<td class="colLast">
<div class="block">Datasource used for authentication by Bearer token (JWT)</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultAuthenticationManager.html" title="class in org.apache.archiva.redback.authentication">DefaultAuthenticationManager</a></th>
<td class="colLast">
<div class="block">DefaultAuthenticationManager: the goal of the authentication manager is to act as a conduit for
authentication requests into different authentication schemes</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PasswordBasedAuthenticationDataSource.html" title="class in org.apache.archiva.redback.authentication">PasswordBasedAuthenticationDataSource</a></th>
<td class="colLast">
<div class="block">PasswordBasedAuthenticationDataSource: the username is considered the principal with this data source</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SimpleTokenData.html" title="class in org.apache.archiva.redback.authentication">SimpleTokenData</a></th>
<td class="colLast">
<div class="block">Simple Token information class that contains a username and a lifetime.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="StringToken.html" title="class in org.apache.archiva.redback.authentication">StringToken</a></th>
<td class="colLast">
<div class="block">Simple token implementation.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TokenBasedAuthenticationDataSource.html" title="class in org.apache.archiva.redback.authentication">TokenBasedAuthenticationDataSource</a></th>
<td class="colLast">
<div class="block">TokenBasedAuthenticationDataSource</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TokenManager.html" title="class in org.apache.archiva.redback.authentication">TokenManager</a></th>
<td class="colLast">
<div class="block">Class that manages tokens that are encrypted with a dynamic key.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AuthenticationControl.html" title="enum in org.apache.archiva.redback.authentication">AuthenticationControl</a></th>
<td class="colLast">
<div class="block">These have the same meaning as for PAM modules
required
If a ‘required’ module returns a status that is not ‘success’,
the operation will ultimately fail, but only after the modules below
it are invoked.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TokenType.html" title="enum in org.apache.archiva.redback.authentication">TokenType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AuthenticationException.html" title="class in org.apache.archiva.redback.authentication">AuthenticationException</a></th>
<td class="colLast">
<div class="block">AuthenticationException.java</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EncryptionFailedException.html" title="class in org.apache.archiva.redback.authentication">EncryptionFailedException</a></th>
<td class="colLast">
<div class="block">Exception used by the token manager.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InvalidTokenException.html" title="class in org.apache.archiva.redback.authentication">InvalidTokenException</a></th>
<td class="colLast">
<div class="block">Exception used by the token manager.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NotAuthenticatedException.html" title="class in org.apache.archiva.redback.authentication">NotAuthenticatedException</a></th>
<td class="colLast">
<div class="block">EntityAuthenticationException.java</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>