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
latest/dev/relism/flash/routing/class-use/Middleware.html
+104 -5
View File
@@ -1,8 +1,8 @@
<!DOCTYPE HTML>
<html lang>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Tue May 12 13:57:37 UTC 2026 -->
<title>Uses of Interface dev.relism.flash.routing.Middleware (flash-parent 2.0.0 API)</title>
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
<title>Uses of Interface dev.relism.flash.routing.Middleware (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">
@@ -57,10 +57,16 @@ loadScripts(document, 'script');</script>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#dev.relism.flash">dev.relism.flash</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#dev.relism.flash.extension">dev.relism.flash.extension</a></div>
<div class="col-first odd-row-color"><a href="#dev.relism.flash.ext.jackson">dev.relism.flash.ext.jackson</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#dev.relism.flash.routing">dev.relism.flash.routing</a></div>
<div class="col-first even-row-color"><a href="#dev.relism.flash.ext.limiter">dev.relism.flash.ext.limiter</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#dev.relism.flash.ext.oidc">dev.relism.flash.ext.oidc</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#dev.relism.flash.extension">dev.relism.flash.extension</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#dev.relism.flash.routing">dev.relism.flash.routing</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
@@ -85,6 +91,99 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="dev.relism.flash.ext.jackson">
<h2>Uses of <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a> in <a href="../../ext/jackson/package-summary.html">dev.relism.flash.ext.jackson</a></h2>
<div class="caption"><span>Methods in <a href="../../ext/jackson/package-summary.html">dev.relism.flash.ext.jackson</a> that return <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">JacksonExtension.</span><code><a href="../../ext/jackson/JacksonExtension.html#autoJson()" class="member-name-link">autoJson</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Opinionated outbound JSON middleware factory.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">JacksonMiddleware.</span><code><a href="../../ext/jackson/JacksonMiddleware.html#autoJson()" class="member-name-link">autoJson</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Automatic JSON marshalling policy.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="dev.relism.flash.ext.limiter">
<h2>Uses of <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a> in <a href="../../ext/limiter/package-summary.html">dev.relism.flash.ext.limiter</a></h2>
<div class="caption"><span>Methods in <a href="../../ext/limiter/package-summary.html">dev.relism.flash.ext.limiter</a> that return <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Guard.</span><code><a href="../../ext/limiter/Guard.html#limit(java.lang.String,int,long,java.util.concurrent.TimeUnit)" class="member-name-link">limit</a><wbr>(<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>&nbsp;resolverKey,
int&nbsp;requests,
long&nbsp;window,
<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>&nbsp;unit)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns a <a href="../Middleware.html" title="interface in dev.relism.flash.routing"><code>Middleware</code></a> that enforces the given rate limit using
<a href="../../ext/limiter/LimitStrategy.html#FIXED_WINDOW"><code>LimitStrategy.FIXED_WINDOW</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Guard.</span><code><a href="../../ext/limiter/Guard.html#limit(java.lang.String,int,long,java.util.concurrent.TimeUnit,dev.relism.flash.ext.limiter.LimitStrategy)" class="member-name-link">limit</a><wbr>(<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>&nbsp;resolverKey,
int&nbsp;requests,
long&nbsp;window,
<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>&nbsp;unit,
<a href="../../ext/limiter/LimitStrategy.html" title="enum class in dev.relism.flash.ext.limiter">LimitStrategy</a>&nbsp;strategy)</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns a <a href="../Middleware.html" title="interface in dev.relism.flash.routing"><code>Middleware</code></a> that enforces the given rate limit with the specified strategy.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="dev.relism.flash.ext.oidc">
<h2>Uses of <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a> in <a href="../../ext/oidc/package-summary.html">dev.relism.flash.ext.oidc</a></h2>
<div class="caption"><span>Methods in <a href="../../ext/oidc/package-summary.html">dev.relism.flash.ext.oidc</a> that return <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">OidcMiddleware.</span><code><a href="../../ext/oidc/OidcMiddleware.html#authorize(dev.relism.flash.ext.oidc.OidcAuthPolicy)" class="member-name-link">authorize</a><wbr>(dev.relism.flash.ext.oidc.OidcAuthPolicy&nbsp;policy)</code></div>
<div class="col-last even-row-color">
<div class="block">Compiled authorization policy path used by annotation-driven mounting.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">OidcMiddleware.</span><code><a href="../../ext/oidc/OidcMiddleware.html#optional()" class="member-name-link">optional</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Silently populates <a href="../../ext/oidc/ClaimsHolder.html" title="class in dev.relism.flash.ext.oidc"><code>ClaimsHolder</code></a> if a valid bearer token or session cookie
is present, but never rejects or redirects unauthenticated requests.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">OidcMiddleware.</span><code><a href="../../ext/oidc/OidcMiddleware.html#protect()" class="member-name-link">protect</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Validates the bearer token or session cookie.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">OidcMiddleware.</span><code><a href="../../ext/oidc/OidcMiddleware.html#requireAnyScope(java.lang.String...)" class="member-name-link">requireAnyScope</a><wbr>(<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>...&nbsp;scopes)</code></div>
<div class="col-last odd-row-color">
<div class="block">Requires at least one of the listed scopes to be present in the token.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">OidcMiddleware.</span><code><a href="../../ext/oidc/OidcMiddleware.html#requireRole(java.lang.String...)" class="member-name-link">requireRole</a><wbr>(<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>...&nbsp;roles)</code></div>
<div class="col-last even-row-color">
<div class="block">Like <a href="../../ext/oidc/OidcMiddleware.html#protect()"><code>OidcMiddleware.protect()</code></a> but also enforces that the caller holds at least one
of the given roles (OR semantics).</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">OidcMiddleware.</span><code><a href="../../ext/oidc/OidcMiddleware.html#requireScopes(java.lang.String...)" class="member-name-link">requireScopes</a><wbr>(<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>...&nbsp;scopes)</code></div>
<div class="col-last odd-row-color">
<div class="block">Requires all listed scopes to be present in the token.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="dev.relism.flash.extension">
<h2>Uses of <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a> in <a href="../../extension/package-summary.html">dev.relism.flash.extension</a></h2>
<div class="caption"><span>Methods in <a href="../../extension/package-summary.html">dev.relism.flash.extension</a> that return types with arguments of type <a href="../Middleware.html" title="interface in dev.relism.flash.routing">Middleware</a></span></div>