Relism/Flash5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(javadoc): publish 2.0.0

Browse Source
This commit is contained in:
github-actions[bot]
2026-05-12 14:36:56 +00:00
parent 26d6386427
commit f6b0831121
939 changed files with 105195 additions and 1539 deletions
Download Patch File Download Diff File Expand all files Collapse all files
javadoc/2.0.0/dev/relism/flash/ext/limiter/LimiterExtension.html
+276
View File
@@ -0,0 +1,276 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
<title>LimiterExtension (flash-parent 2.1.0-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2026-05-12">
<meta name="description" content="declaration: package: dev.relism.flash.ext.limiter, class: LimiterExtension">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/LimiterExtension.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">dev.relism.flash.ext.limiter</a></div>
<h1 title="Class LimiterExtension" class="title">Class LimiterExtension</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">dev.relism.flash.ext.limiter.LimiterExtension</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../extension/FlashExtension.html" title="interface in dev.relism.flash.extension">FlashExtension</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">LimiterExtension</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="../../extension/FlashExtension.html" title="interface in dev.relism.flash.extension">FlashExtension</a></span></div>
<div class="block">Rate-limiting extension for Flash.
<p>At <a href="#provide(dev.relism.flash.extension.FlashContext)"><code>provide(dev.relism.flash.extension.FlashContext)</code></a>:
<ol>
<li>Creates a single <a href="BucketStore.html" title="class in dev.relism.flash.ext.limiter"><code>BucketStore</code></a> shared by all rules in this extension instance.</li>
<li>Provides a <a href="Guard.html" title="class in dev.relism.flash.ext.limiter"><code>Guard</code></a> in the <a href="../../extension/FlashContext.html" title="class in dev.relism.flash.extension"><code>FlashContext</code></a> for manual use on lambda routes.</li>
<li>Registers an <a href="../../extension/AnnotationProcessor.html" title="interface in dev.relism.flash.extension"><code>AnnotationProcessor</code></a> for <a href="Limit.html" title="annotation interface in dev.relism.flash.ext.limiter"><code>Limit</code></a>:
reads the annotation once per handler class at boot, resolves the key lambda
fail-fast, then returns a pre-compiled middleware — zero map lookups at request time.</li>
</ol>
<h3 id="annotation-based-class-handlers--heading">Annotation-based (class handlers)</h3>
<pre><code>
@Limit(requests = 100, window = 1) // 100 req/s per IP
public class SearchHandler extends RequestHandler { ... }
@Limit(key = "auth_user", requests = 20, window = 1,
windowUnit = TimeUnit.MINUTES,
strategy = LimitStrategy.TOKEN_BUCKET)
public class ReportHandler extends RequestHandler { ... }
</code></pre>
<h3 id="lambda-routes-via-guard--heading">Lambda routes (via Guard)</h3>
<pre><code>
app.install(new LimiterExtension(
new LimiterConfig().registerResolver("auth_user", req -&gt; ClaimsHolder.user().sub())));
// inside FlashExtension.routes() or after install():
Guard guard = ctx.require(Guard.class);
app.get("/api/search", handler, guard.limit("ip", 50, 1, TimeUnit.SECONDS));
</code></pre></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LimiterExtension</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Installs with default config (only the built-in <code>"ip"</code> resolver).</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(dev.relism.flash.ext.limiter.LimiterConfig)" class="member-name-link">LimiterExtension</a><wbr>(<a href="LimiterConfig.html" title="class in dev.relism.flash.ext.limiter">LimiterConfig</a>&nbsp;config)</code></div>
<div class="col-last odd-row-color">
<div class="block">Installs with a custom <a href="LimiterConfig.html" title="class in dev.relism.flash.ext.limiter"><code>LimiterConfig</code></a> (custom resolvers, etc.).</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#priority()" class="member-name-link">priority</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Rate limiting runs before authentication — cheaper check rejects over-limit
requests before any token validation occurs.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#provide(dev.relism.flash.extension.FlashContext)" class="member-name-link">provide</a><wbr>(<a href="../../extension/FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a>&nbsp;ctx)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Phase 1 — register services and processors.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)" class="member-name-link">routes</a><wbr>(<a href="../../extension/FlashRegistrar.html" title="class in dev.relism.flash.extension">FlashRegistrar</a>&lt;?&gt;&nbsp;app,
<a href="../../extension/FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a>&nbsp;ctx)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Phase 2 — register routes.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>LimiterExtension</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LimiterExtension</span>()</div>
<div class="block">Installs with default config (only the built-in <code>"ip"</code> resolver).</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(dev.relism.flash.ext.limiter.LimiterConfig)">
<h3>LimiterExtension</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LimiterExtension</span><wbr><span class="parameters">(<a href="LimiterConfig.html" title="class in dev.relism.flash.ext.limiter">LimiterConfig</a>&nbsp;config)</span></div>
<div class="block">Installs with a custom <a href="LimiterConfig.html" title="class in dev.relism.flash.ext.limiter"><code>LimiterConfig</code></a> (custom resolvers, etc.).</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="priority()">
<h3>priority</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">priority</span>()</div>
<div class="block">Rate limiting runs before authentication — cheaper check rejects over-limit
requests before any token validation occurs.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../extension/FlashExtension.html#priority()">priority</a></code>&nbsp;in interface&nbsp;<code><a href="../../extension/FlashExtension.html" title="interface in dev.relism.flash.extension">FlashExtension</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="provide(dev.relism.flash.extension.FlashContext)">
<h3>provide</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">provide</span><wbr><span class="parameters">(<a href="../../extension/FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a>&nbsp;ctx)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="../../extension/FlashExtension.html#provide(dev.relism.flash.extension.FlashContext)">FlashExtension</a></code></span></div>
<div class="block">Phase 1 — register services and processors.
Safe: <a href="../../extension/FlashContext.html#provide(java.lang.Class,T)"><code>FlashContext.provide(java.lang.Class&lt;T&gt;, T)</code></a>, <a href="../../extension/FlashContext.html#supply(java.lang.Class,java.util.function.Supplier)"><code>FlashContext.supply(java.lang.Class&lt;T&gt;, java.util.function.Supplier&lt;T&gt;)</code></a>,
<a href="../../extension/FlashContext.html#addAnnotationProcessor(dev.relism.flash.extension.AnnotationProcessor)"><code>FlashContext.addAnnotationProcessor(dev.relism.flash.extension.AnnotationProcessor)</code></a>, <a href="../../extension/FlashContext.html#addRouteListener(dev.relism.flash.extension.RouteListener)"><code>FlashContext.addRouteListener(dev.relism.flash.extension.RouteListener)</code></a>.
Unsafe: <a href="../../extension/FlashContext.html#require(java.lang.Class)"><code>FlashContext.require(java.lang.Class&lt;T&gt;)</code></a> (services not yet resolved).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../extension/FlashExtension.html#provide(dev.relism.flash.extension.FlashContext)">provide</a></code>&nbsp;in interface&nbsp;<code><a href="../../extension/FlashExtension.html" title="interface in dev.relism.flash.extension">FlashExtension</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)">
<h3>routes</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">routes</span><wbr><span class="parameters">(<a href="../../extension/FlashRegistrar.html" title="class in dev.relism.flash.extension">FlashRegistrar</a>&lt;?&gt;&nbsp;app,
<a href="../../extension/FlashContext.html" title="class in dev.relism.flash.extension">FlashContext</a>&nbsp;ctx)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="../../extension/FlashExtension.html#routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)">FlashExtension</a></code></span></div>
<div class="block">Phase 2 — register routes. All services are fully resolved.
<a href="../../extension/FlashContext.html#require(java.lang.Class)"><code>FlashContext.require(java.lang.Class&lt;T&gt;)</code></a> is safe here.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../extension/FlashExtension.html#routes(dev.relism.flash.extension.FlashRegistrar,dev.relism.flash.extension.FlashContext)">routes</a></code>&nbsp;in interface&nbsp;<code><a href="../../extension/FlashExtension.html" title="interface in dev.relism.flash.extension">FlashExtension</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2026. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>