Google Git
Sign in
apache / archiva-web-content / 93f0714e1ce373f15c1c887c5b960ff2c62a38e4 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / keys / KeyManager.html
blob: ab56a652f98c43377fd7db0cbdcfa4578c9a5eb8 [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>KeyManager (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="KeyManager (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/KeyManager.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/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/archiva/redback/keys/KeyManager.html" target="_top">Frames</a></li>
<li><a href="KeyManager.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.keys</div>
<h2 title="Interface KeyManager" class="title">Interface KeyManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/archiva/redback/keys/AbstractKeyManager.html" title="class in org.apache.archiva.redback.keys">AbstractKeyManager</a>, <a href="../../../../../org/apache/archiva/redback/keys/cached/CachedKeyManager.html" title="class in org.apache.archiva.redback.keys.cached">CachedKeyManager</a>, <a href="../../../../../org/apache/archiva/redback/keys/jpa/JpaKeyManager.html" title="class in org.apache.archiva.redback.keys.jpa">JpaKeyManager</a>, <a href="../../../../../org/apache/archiva/redback/keys/memory/MemoryKeyManager.html" title="class in org.apache.archiva.redback.keys.memory">MemoryKeyManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.30">KeyManager</a></pre>
<div class="block">KeyManager</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">
<!-- ========== 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></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/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#addKey-org.apache.archiva.redback.keys.AuthenticationKey-">addKey</a></span>(<a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;key)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#createKey-java.lang.String-java.lang.String-int-">createKey</a></span>(<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;principal,
<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;purpose,
int&nbsp;expirationMinutes)</code>
<div class="block">Create a key (and save it to the store) for the specified principal.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#deleteKey-org.apache.archiva.redback.keys.AuthenticationKey-">deleteKey</a></span>(<a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;key)</code>
<div class="block">Delete a key from the underlying store.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#deleteKey-java.lang.String-">deleteKey</a></span>(<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;key)</code>
<div class="block">Delete a key from the underlying store.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#eraseDatabase--">eraseDatabase</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#findKey-java.lang.String-">findKey</a></span>(<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;key)</code>
<div class="block">Attempt to find a specific key in the store.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#getAllKeys--">getAllKeys</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/redback/keys/KeyManager.html#getId--">getId</a></span>()</code>
<div class="block">String identifying the key manager implementation.</div>
</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/keys/KeyManager.html#removeExpiredKeys--">removeExpiredKeys</a></span>()</code>
<div class="block">Remove all keys that are expired.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre><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;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.39">getId</a>()</pre>
<div class="block">String identifying the key manager implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key manager implementation id.</dd>
</dl>
</li>
</ul>
<a name="findKey-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findKey</h4>
<pre><a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.51">findKey</a>(<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;key)
throws <a href="../../../../../org/apache/archiva/redback/keys/KeyNotFoundException.html" title="class in org.apache.archiva.redback.keys">KeyNotFoundException</a>,
<a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></pre>
<div class="block">Attempt to find a specific key in the store.
NOTE: Implementations of this interface should never return an expired key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to find.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the actual key found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/keys/KeyNotFoundException.html" title="class in org.apache.archiva.redback.keys">KeyNotFoundException</a></code> - when the requested, unexpired, key cannot be found.</dd>
<dd><code><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code> - when there is a fundamental problem with the KeyManager implementation.</dd>
</dl>
</li>
</ul>
<a name="createKey-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createKey</h4>
<pre><a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.64">createKey</a>(<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;principal,
<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;purpose,
int&nbsp;expirationMinutes)
throws <a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></pre>
<div class="block">Create a key (and save it to the store) for the specified principal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>principal</code> - the principal to generate the key for.</dd>
<dd><code>purpose</code> - the purpose of the key. (Example: "selfservice password reset", "new user validation",
"remember me") This is a purely informational field .</dd>
<dd><code>expirationMinutes</code> - the amount in minutes until this key expires. (-1 means no expiration)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key created</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code> - if there is a fundamental problem with the KeyManager implementation.</dd>
</dl>
</li>
</ul>
<a name="deleteKey-org.apache.archiva.redback.keys.AuthenticationKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteKey</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.72">deleteKey</a>(<a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;key)
throws <a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></pre>
<div class="block">Delete a key from the underlying store.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to delete.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code></dd>
</dl>
</li>
</ul>
<a name="deleteKey-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteKey</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.80">deleteKey</a>(<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;key)
throws <a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></pre>
<div class="block">Delete a key from the underlying store.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to delete.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAllKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllKeys</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.83">getAllKeys</a>()</pre>
</li>
</ul>
<a name="addKey-org.apache.archiva.redback.keys.AuthenticationKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addKey</h4>
<pre><a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.85">addKey</a>(<a href="../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>&nbsp;key)</pre>
</li>
</ul>
<a name="eraseDatabase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eraseDatabase</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.87">eraseDatabase</a>()</pre>
</li>
</ul>
<a name="removeExpiredKeys--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeExpiredKeys</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.92">removeExpiredKeys</a>()
throws <a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></pre>
<div class="block">Remove all keys that are expired.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/KeyManager.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/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/archiva/redback/keys/KeyManagerException.html" title="class in org.apache.archiva.redback.keys"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/archiva/redback/keys/KeyManager.html" target="_top">Frames</a></li>
<li><a href="KeyManager.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>