164 lines
11 KiB
HTML
164 lines
11 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) on Tue May 12 14:36:52 UTC 2026 -->
|
|
<title>dev.relism.flash.ext.oidc (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.oidc">
|
|
<meta name="generator" content="javadoc/PackageWriterImpl">
|
|
<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="package-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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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 class="nav-bar-cell1-rev">Package</li>
|
|
<li>Class</li>
|
|
<li><a href="package-use.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#package">Help</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list-small">
|
|
<li>
|
|
<p>Package:</p>
|
|
<ul>
|
|
<li>Description</li>
|
|
<li>Related Packages</li>
|
|
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div id="navbar-sub-list">
|
|
<ul class="sub-nav-list">
|
|
<li>Package: </li>
|
|
<li>Description | </li>
|
|
<li>Related Packages | </li>
|
|
<li><a href="#class-summary">Classes and Interfaces</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">
|
|
<div class="header">
|
|
<h1 title="Package dev.relism.flash.ext.oidc" class="title">Package dev.relism.flash.ext.oidc</h1>
|
|
</div>
|
|
<hr>
|
|
<div class="package-signature">package <span class="element-name">dev.relism.flash.ext.oidc</span></div>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<li>
|
|
<div id="class-summary">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab4" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab4', 2)" class="table-tab">Record Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exception Classes</button><button id="class-summary-tab6" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab6', 2)" class="table-tab">Annotation Interfaces</button></div>
|
|
<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0">
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Class</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab6"><a href="Authenticated.html" title="annotation interface in dev.relism.flash.ext.oidc">Authenticated</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab6">
|
|
<div class="block">Marks a handler as requiring a valid JWT.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ClaimsHolder.html" title="class in dev.relism.flash.ext.oidc">ClaimsHolder</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
<div class="block">Thread-local store for JWT claims, populated by the OIDC middleware before
|
|
the handler runs and cleared in the <code>finally</code> block afterward.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ClientAuthMethod.html" title="enum class in dev.relism.flash.ext.oidc">ClientAuthMethod</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab3">
|
|
<div class="block">OAuth2 client authentication method for the token endpoint (RFC 6749 §2.3).</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="InMemoryOidcSessionStore.html" title="class in dev.relism.flash.ext.oidc">InMemoryOidcSessionStore</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
<div class="block">Thread-safe in-memory <a href="OidcSessionStore.html" title="interface in dev.relism.flash.ext.oidc"><code>OidcSessionStore</code></a>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JwtValidator.html" title="class in dev.relism.flash.ext.oidc">JwtValidator</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
<div class="block">Validates JWTs against a remote JWKS endpoint using Nimbus JOSE+JWT.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OidcConfig.html" title="class in dev.relism.flash.ext.oidc">OidcConfig</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
<div class="block">Full OIDC client configuration.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OidcConfig.Builder.html" title="class in dev.relism.flash.ext.oidc">OidcConfig.Builder</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OidcExtension.html" title="class in dev.relism.flash.ext.oidc">OidcExtension</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
<div class="block">Full OIDC Authorization Code + PKCE flow for Flash.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OidcMiddleware.html" title="class in dev.relism.flash.ext.oidc">OidcMiddleware</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
<div class="block">Request-level OIDC middleware.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab4"><a href="OidcProviderMetadata.html" title="class in dev.relism.flash.ext.oidc">OidcProviderMetadata</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab4">
|
|
<div class="block">OIDC provider endpoints discovered from <code>{issuer}/.well-known/openid-configuration</code>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OidcSession.html" title="class in dev.relism.flash.ext.oidc">OidcSession</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
<div class="block">An authenticated user's OIDC session — persisted in <a href="OidcSessionStore.html" title="interface in dev.relism.flash.ext.oidc"><code>OidcSessionStore</code></a> and
|
|
looked up via the <code>oidc_session</code> cookie on every request.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="OidcSessionStore.html" title="interface in dev.relism.flash.ext.oidc">OidcSessionStore</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab1">
|
|
<div class="block">Backing store for <a href="OidcSession.html" title="class in dev.relism.flash.ext.oidc"><code>OidcSession</code></a> objects.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OidcUser.html" title="class in dev.relism.flash.ext.oidc">OidcUser</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
<div class="block">Type-safe view over the JWT claims stored in <a href="ClaimsHolder.html" title="class in dev.relism.flash.ext.oidc"><code>ClaimsHolder</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="OidcValidationException.html" title="class in dev.relism.flash.ext.oidc">OidcValidationException</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab5">
|
|
<div class="block">Thrown when OIDC token validation fails (signature, claims, nonce, expiry, etc.).</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab6"><a href="RolesAllowed.html" title="annotation interface in dev.relism.flash.ext.oidc">RolesAllowed</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab6">
|
|
<div class="block">Restricts a handler to callers whose JWT contains at least one of the
|
|
specified roles.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color class-summary class-summary-tab6"><a href="ScopesAllowed.html" title="annotation interface in dev.relism.flash.ext.oidc">ScopesAllowed</a></div>
|
|
<div class="col-last odd-row-color class-summary class-summary-tab6">
|
|
<div class="block">Restricts a handler to callers whose token carries the required OAuth2 scopes.</div>
|
|
</div>
|
|
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ScopesAllowed.Match.html" title="enum class in dev.relism.flash.ext.oidc">ScopesAllowed.Match</a></div>
|
|
<div class="col-last even-row-color class-summary class-summary-tab3"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 2026. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|