Relism/Flash5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f6b08311216f0767d058244f32c9a17097225464
Flash5/javadoc/2.0.0/dev/relism/flash/ext/limiter/Limit.html
T

229 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
<title>Limit (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, annotation type: Limit">
<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/Limit.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>Field</li>
<li><a href="#annotation-interface-required-element-summary">Required</a></li>
<li><a href="#annotation-interface-optional-element-summary">Optional</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#annotation-interface-element-detail">Element</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>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation-interface-required-element-summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation-interface-optional-element-summary">Optional</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation-interface-element-detail">Element</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="Annotation Interface Limit" class="title">Annotation Interface Limit</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation" class="external-link">TYPE</a>)
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">Limit</span></div>
<div class="block">Applies a rate limit to a class-based <a href="../../models/RequestHandler.html" title="class in dev.relism.flash.models"><code>RequestHandler</code></a>.
<p>The annotation is processed at boot time by the <a href="LimiterExtension.html" title="class in dev.relism.flash.ext.limiter"><code>LimiterExtension</code></a> annotation
processor. If <a href="#key()"><code>key()</code></a> names a resolver that was never registered,
startup fails immediately with <a href="../../exceptions/InitializationException.html" title="class in dev.relism.flash.exceptions"><code>InitializationException</code></a>.
<pre><code>
// 100 req/s per client IP — fixed window
@Limit(requests = 100, window = 1)
public class SearchHandler extends RequestHandler { ... }
// 20 req/min per authenticated user — token bucket
@Limit(key = "auth_user", requests = 20, window = 1, windowUnit = TimeUnit.MINUTES,
strategy = LimitStrategy.TOKEN_BUCKET)
public class ExpensiveHandler extends RequestHandler { ... }
</code></pre></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== ANNOTATION INTERFACE REQUIRED MEMBER SUMMARY =========== -->
<li>
<section class="member-summary" id="annotation-interface-required-element-summary">
<h2>Required Element Summary</h2>
<div class="caption"><span>Required Elements</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Required Element</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#requests()" class="member-name-link">requests</a></code></div>
<div class="col-last even-row-color">
<div class="block">Maximum number of requests allowed per <a href="#window()"><code>window()</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code>long</code></div>
<div class="col-second odd-row-color"><code><a href="#window()" class="member-name-link">window</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Window duration in <a href="#windowUnit()"><code>windowUnit()</code></a> units.</div>
</div>
</div>
</section>
</li>
<!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== -->
<li>
<section class="member-summary" id="annotation-interface-optional-element-summary">
<h2>Optional Element Summary</h2>
<div class="caption"><span>Optional Elements</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Optional Element</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#key()" class="member-name-link">key</a></code></div>
<div class="col-last even-row-color">
<div class="block">Name of the resolver registered via <a href="LimiterConfig.html#registerResolver(java.lang.String,dev.relism.flash.ext.limiter.KeyResolver)"><code>LimiterConfig.registerResolver(java.lang.String, dev.relism.flash.ext.limiter.KeyResolver)</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code><a href="LimitStrategy.html" title="enum class in dev.relism.flash.ext.limiter">LimitStrategy</a></code></div>
<div class="col-second odd-row-color"><code><a href="#strategy()" class="member-name-link">strategy</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Rate-limit algorithm.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a></code></div>
<div class="col-second even-row-color"><code><a href="#windowUnit()" class="member-name-link">windowUnit</a></code></div>
<div class="col-last even-row-color">
<div class="block">Unit for <a href="#window()"><code>window()</code></a>.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details" id="annotation-interface-element-detail">
<ul class="details-list">
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
<li>
<section class="member-details">
<h2>Element Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="key()">
<h3>key</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">key</span></div>
<div class="block">Name of the resolver registered via <a href="LimiterConfig.html#registerResolver(java.lang.String,dev.relism.flash.ext.limiter.KeyResolver)"><code>LimiterConfig.registerResolver(java.lang.String, dev.relism.flash.ext.limiter.KeyResolver)</code></a>. Default: <code>"ip"</code>.</div>
<dl class="notes">
<dt>Default:</dt>
<dd><code>"ip"</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="requests()">
<h3>requests</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">requests</span></div>
<div class="block">Maximum number of requests allowed per <a href="#window()"><code>window()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="window()">
<h3>window</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">window</span></div>
<div class="block">Window duration in <a href="#windowUnit()"><code>windowUnit()</code></a> units.</div>
</section>
</li>
<li>
<section class="detail" id="windowUnit()">
<h3>windowUnit</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a></span>&nbsp;<span class="element-name">windowUnit</span></div>
<div class="block">Unit for <a href="#window()"><code>window()</code></a>. Default: <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/TimeUnit.html#SECONDS" title="class or interface in java.util.concurrent" class="external-link"><code>TimeUnit.SECONDS</code></a>.</div>
<dl class="notes">
<dt>Default:</dt>
<dd><code>SECONDS</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="strategy()">
<h3>strategy</h3>
<div class="member-signature"><span class="return-type"><a href="LimitStrategy.html" title="enum class in dev.relism.flash.ext.limiter">LimitStrategy</a></span>&nbsp;<span class="element-name">strategy</span></div>
<div class="block">Rate-limit algorithm. Default: <a href="LimitStrategy.html#FIXED_WINDOW"><code>LimitStrategy.FIXED_WINDOW</code></a>.</div>
<dl class="notes">
<dt>Default:</dt>
<dd><code>FIXED_WINDOW</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>
Reference in New Issue View Git Blame Copy Permalink