| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>KeyManager (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="KeyManager (Apache Archiva Redback 3.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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"; |
| 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/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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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"> </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> <a href="package-summary.html">org.apache.archiva.redback.keys</a></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><code><a href="AbstractKeyManager.html" title="class in org.apache.archiva.redback.keys">AbstractKeyManager</a></code>, <code><a href="cached/CachedKeyManager.html" title="class in org.apache.archiva.redback.keys.cached">CachedKeyManager</a></code>, <code><a href="jpa/JpaKeyManager.html" title="class in org.apache.archiva.redback.keys.jpa">JpaKeyManager</a></code>, <code><a href="memory/MemoryKeyManager.html" title="class in org.apache.archiva.redback.keys.memory">MemoryKeyManager</a></code></dd> |
| </dl> |
| <hr> |
| <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 =========== --> |
| <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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addKey(org.apache.archiva.redback.keys.AuthenticationKey)">addKey</a></span>​(<a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">String</a> 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" class="externalLink">String</a> purpose, |
| int expirationMinutes)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteKey(org.apache.archiva.redback.keys.AuthenticationKey)">deleteKey</a></span>​(<a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> key)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#eraseDatabase()">eraseDatabase</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <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" class="externalLink">List</a><<a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllKeys()">getAllKeys</a></span>()</code></th> |
| <td class="colLast"> </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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">String identifying the key manager implementation.</div> |
| </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="#removeExpiredKeys()">removeExpiredKeys</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Remove all keys that are expired.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre class="methodSignature"><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> <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 id="findKey(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findKey</h4> |
| <pre class="methodSignature"><a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> <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" class="externalLink">String</a> key) |
| throws <a href="KeyNotFoundException.html" title="class in org.apache.archiva.redback.keys">KeyNotFoundException</a>, |
| <a href="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="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="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 id="createKey(java.lang.String,java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createKey</h4> |
| <pre class="methodSignature"><a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> <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" class="externalLink">String</a> 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" class="externalLink">String</a> purpose, |
| int expirationMinutes) |
| throws <a href="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="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 id="deleteKey(org.apache.archiva.redback.keys.AuthenticationKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteKey</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.72">deleteKey</a>​(<a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> key) |
| throws <a href="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="KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteKey(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteKey</h4> |
| <pre class="methodSignature">void <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" class="externalLink">String</a> key) |
| throws <a href="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="KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAllKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllKeys</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a>> <a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.83">getAllKeys</a>()</pre> |
| </li> |
| </ul> |
| <a id="addKey(org.apache.archiva.redback.keys.AuthenticationKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addKey</h4> |
| <pre class="methodSignature"><a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> <a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.85">addKey</a>​(<a href="AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> key)</pre> |
| </li> |
| </ul> |
| <a id="eraseDatabase()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>eraseDatabase</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.87">eraseDatabase</a>()</pre> |
| </li> |
| </ul> |
| <a id="removeExpiredKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeExpiredKeys</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/keys/KeyManager.html#line.92">removeExpiredKeys</a>() |
| throws <a href="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="KeyManagerException.html" title="class in org.apache.archiva.redback.keys">KeyManagerException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2006–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
