Deploying to gh-pages - 08:33:27

micronaut-projects · Oct 22, 2024 · 002cc02 · 002cc02
1 parent a572a7a
commit 002cc02
Show file tree

Hide file tree

Showing 17 changed files with 1,195 additions and 815 deletions.
diff --git a/snapshot/api/deprecated-list.html b/snapshot/api/deprecated-list.html
diff --git a/snapshot/api/index-all.html b/snapshot/api/index-all.html
diff --git a/snapshot/api/io/micronaut/security/endpoints/ControllerConfiguration.html b/snapshot/api/io/micronaut/security/endpoints/ControllerConfiguration.html
@@ -107,7 +107,7 @@ <h1 title="Interface ControllerConfiguration" class="title">Interface Controller
 <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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
+<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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
@@ -116,6 +116,9 @@ <h2>Method Summary</h2>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NonNull <a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPath()" class="member-name-link">getPath</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default @NonNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getPostContentTypes()" class="member-name-link">getPostContentTypes</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
 </div>
 </div>
 </div>
@@ -144,6 +147,19 @@ <h3>getPath</h3>
 </dl>
 </section>
 </li>
+<li>
+<section class="detail" id="getPostContentTypes()">
+<h3>getPostContentTypes</h3>
+<div class="member-signature"><span class="annotations">@NonNull
+</span><span class="modifiers">default</span>&nbsp;<span class="return-type">@NonNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getPostContentTypes</span>()</div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>Supported HTTP methods for POST endpoints.</dd>
+<dt>Since:</dt>
+<dd>4.11.0</dd>
+</dl>
+</section>
+</li>
 </ul>
 </section>
 </li>

diff --git a/snapshot/api/io/micronaut/security/endpoints/LoginController.html b/snapshot/api/io/micronaut/security/endpoints/LoginController.html
@@ -113,15 +113,18 @@ <h2>Field Summary</h2>
 <div class="col-first even-row-color"><code>protected final io.micronaut.http.server.util.locale.HttpLocaleResolver</code></div>
 <div class="col-second even-row-color"><code><a href="#httpLocaleResolver" class="member-name-link">httpLocaleResolver</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
-<div class="col-first odd-row-color"><code>protected final io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event">LoginFailedEvent</a>&gt;</code></div>
-<div class="col-second odd-row-color"><code><a href="#loginFailedEventPublisher" class="member-name-link">loginFailedEventPublisher</a></code></div>
+<div class="col-first odd-row-color"><code>protected final <a href="LoginControllerConfiguration.html" title="interface in io.micronaut.security.endpoints">LoginControllerConfiguration</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#loginControllerConfiguration" class="member-name-link">loginControllerConfiguration</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
-<div class="col-first even-row-color"><code>protected final <a href="../handlers/LoginHandler.html" title="interface in io.micronaut.security.handlers">LoginHandler</a>&lt;io.micronaut.http.HttpRequest&lt;?&gt;,<wbr>io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;</code></div>
-<div class="col-second even-row-color"><code><a href="#loginHandler" class="member-name-link">loginHandler</a></code></div>
+<div class="col-first even-row-color"><code>protected final io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event">LoginFailedEvent</a>&gt;</code></div>
+<div class="col-second even-row-color"><code><a href="#loginFailedEventPublisher" class="member-name-link">loginFailedEventPublisher</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
-<div class="col-first odd-row-color"><code>protected final io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginSuccessfulEvent.html" title="class in io.micronaut.security.event">LoginSuccessfulEvent</a>&gt;</code></div>
-<div class="col-second odd-row-color"><code><a href="#loginSuccessfulEventPublisher" class="member-name-link">loginSuccessfulEventPublisher</a></code></div>
+<div class="col-first odd-row-color"><code>protected final <a href="../handlers/LoginHandler.html" title="interface in io.micronaut.security.handlers">LoginHandler</a>&lt;io.micronaut.http.HttpRequest&lt;?&gt;,<wbr>io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;</code></div>
+<div class="col-second odd-row-color"><code><a href="#loginHandler" class="member-name-link">loginHandler</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><code>protected final io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginSuccessfulEvent.html" title="class in io.micronaut.security.event">LoginSuccessfulEvent</a>&gt;</code></div>
+<div class="col-second even-row-color"><code><a href="#loginSuccessfulEventPublisher" class="member-name-link">loginSuccessfulEventPublisher</a></code></div>
+<div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
@@ -148,7 +151,19 @@ <h2>Constructor Summary</h2>
  io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event">LoginFailedEvent</a>&gt;&nbsp;loginFailedEventPublisher,
  io.micronaut.http.server.util.HttpHostResolver&nbsp;httpHostResolver,
  io.micronaut.http.server.util.locale.HttpLocaleResolver&nbsp;httpLocaleResolver)</code></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span>
+<div class="deprecation-comment">Use <a href="#%3Cinit%3E(io.micronaut.security.authentication.Authenticator,io.micronaut.security.handlers.LoginHandler,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver,io.micronaut.security.endpoints.LoginControllerConfiguration)"><code>LoginController(io.micronaut.security.authentication.Authenticator&lt;io.micronaut.http.HttpRequest&lt;B&gt;&gt;,io.micronaut.security.handlers.LoginHandler&lt;io.micronaut.http.HttpRequest&lt;?&gt;,io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;,io.micronaut.context.event.ApplicationEventPublisher&lt;io.micronaut.security.event.LoginSuccessfulEvent&gt;,io.micronaut.context.event.ApplicationEventPublisher&lt;io.micronaut.security.event.LoginFailedEvent&gt;,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver,io.micronaut.security.endpoints.LoginControllerConfiguration)</code></a> instead.</div>
+</div>
+</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.micronaut.security.authentication.Authenticator,io.micronaut.security.handlers.LoginHandler,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver,io.micronaut.security.endpoints.LoginControllerConfiguration)" class="member-name-link">LoginController</a><wbr>(<a href="../authentication/Authenticator.html" title="class in io.micronaut.security.authentication">Authenticator</a>&lt;io.micronaut.http.HttpRequest&lt;<a href="LoginController.html" title="type parameter in LoginController">B</a>&gt;&gt;&nbsp;authenticator,
+ <a href="../handlers/LoginHandler.html" title="interface in io.micronaut.security.handlers">LoginHandler</a>&lt;io.micronaut.http.HttpRequest&lt;?&gt;,<wbr>io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;&nbsp;loginHandler,
+ io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginSuccessfulEvent.html" title="class in io.micronaut.security.event">LoginSuccessfulEvent</a>&gt;&nbsp;loginSuccessfulEventPublisher,
+ io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event">LoginFailedEvent</a>&gt;&nbsp;loginFailedEventPublisher,
+ io.micronaut.http.server.util.HttpHostResolver&nbsp;httpHostResolver,
+ io.micronaut.http.server.util.locale.HttpLocaleResolver&nbsp;httpLocaleResolver,
+ <a href="LoginControllerConfiguration.html" title="interface in io.micronaut.security.endpoints">LoginControllerConfiguration</a>&nbsp;loginControllerConfiguration)</code></div>
+<div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
@@ -220,6 +235,12 @@ <h3>httpLocaleResolver</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">io.micronaut.http.server.util.locale.HttpLocaleResolver</span>&nbsp;<span class="element-name">httpLocaleResolver</span></div>
 </section>
 </li>
+<li>
+<section class="detail" id="loginControllerConfiguration">
+<h3>loginControllerConfiguration</h3>
+<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="LoginControllerConfiguration.html" title="interface in io.micronaut.security.endpoints">LoginControllerConfiguration</a></span>&nbsp;<span class="element-name">loginControllerConfiguration</span></div>
+</section>
+</li>
 </ul>
 </section>
 </li>
@@ -229,15 +250,44 @@ <h3>httpLocaleResolver</h3>
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="&lt;init&gt;(io.micronaut.security.authentication.Authenticator,io.micronaut.security.handlers.LoginHandler,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver)">
+<section class="detail" id="&lt;init&gt;(io.micronaut.security.authentication.Authenticator,io.micronaut.security.handlers.LoginHandler,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver,io.micronaut.security.endpoints.LoginControllerConfiguration)">
 <h3>LoginController</h3>
 <div class="member-signature"><span class="annotations">@Inject
+</span><span class="modifiers">public</span>&nbsp;<span class="element-name">LoginController</span><wbr><span class="parameters">(<a href="../authentication/Authenticator.html" title="class in io.micronaut.security.authentication">Authenticator</a>&lt;io.micronaut.http.HttpRequest&lt;<a href="LoginController.html" title="type parameter in LoginController">B</a>&gt;&gt;&nbsp;authenticator,
+ <a href="../handlers/LoginHandler.html" title="interface in io.micronaut.security.handlers">LoginHandler</a>&lt;io.micronaut.http.HttpRequest&lt;?&gt;,<wbr>io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;&nbsp;loginHandler,
+ io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginSuccessfulEvent.html" title="class in io.micronaut.security.event">LoginSuccessfulEvent</a>&gt;&nbsp;loginSuccessfulEventPublisher,
+ io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event">LoginFailedEvent</a>&gt;&nbsp;loginFailedEventPublisher,
+ io.micronaut.http.server.util.HttpHostResolver&nbsp;httpHostResolver,
+ io.micronaut.http.server.util.locale.HttpLocaleResolver&nbsp;httpLocaleResolver,
+ <a href="LoginControllerConfiguration.html" title="interface in io.micronaut.security.endpoints">LoginControllerConfiguration</a>&nbsp;loginControllerConfiguration)</span></div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>authenticator</code> - <a href="../authentication/Authenticator.html" title="class in io.micronaut.security.authentication"><code>Authenticator</code></a> collaborator</dd>
+<dd><code>loginHandler</code> - A collaborator which helps to build HTTP response depending on success or failure.</dd>
+<dd><code>loginSuccessfulEventPublisher</code> - Application event publisher for <a href="../event/LoginSuccessfulEvent.html" title="class in io.micronaut.security.event"><code>LoginSuccessfulEvent</code></a>.</dd>
+<dd><code>loginFailedEventPublisher</code> - Application event publisher for <a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event"><code>LoginFailedEvent</code></a>.</dd>
+<dd><code>httpHostResolver</code> - The http host resolver</dd>
+<dd><code>httpLocaleResolver</code> - The http locale resolver</dd>
+<dd><code>loginControllerConfiguration</code> - Login Controller Configuration</dd>
+<dt>Since:</dt>
+<dd>4.11.0</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="&lt;init&gt;(io.micronaut.security.authentication.Authenticator,io.micronaut.security.handlers.LoginHandler,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver)">
+<h3>LoginController</h3>
+<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html#forRemoval()" title="class or interface in java.lang" class="external-link">forRemoval</a>=true,
+            <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="4.11.0")
 </span><span class="modifiers">public</span>&nbsp;<span class="element-name">LoginController</span><wbr><span class="parameters">(<a href="../authentication/Authenticator.html" title="class in io.micronaut.security.authentication">Authenticator</a>&lt;io.micronaut.http.HttpRequest&lt;<a href="LoginController.html" title="type parameter in LoginController">B</a>&gt;&gt;&nbsp;authenticator,
  <a href="../handlers/LoginHandler.html" title="interface in io.micronaut.security.handlers">LoginHandler</a>&lt;io.micronaut.http.HttpRequest&lt;?&gt;,<wbr>io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;&nbsp;loginHandler,
  io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginSuccessfulEvent.html" title="class in io.micronaut.security.event">LoginSuccessfulEvent</a>&gt;&nbsp;loginSuccessfulEventPublisher,
  io.micronaut.context.event.ApplicationEventPublisher&lt;<a href="../event/LoginFailedEvent.html" title="class in io.micronaut.security.event">LoginFailedEvent</a>&gt;&nbsp;loginFailedEventPublisher,
  io.micronaut.http.server.util.HttpHostResolver&nbsp;httpHostResolver,
  io.micronaut.http.server.util.locale.HttpLocaleResolver&nbsp;httpLocaleResolver)</span></div>
+<div class="deprecation-block"><span class="deprecated-label">Deprecated, for removal: This API element is subject to removal in a future version.</span>
+<div class="deprecation-comment">Use <a href="#%3Cinit%3E(io.micronaut.security.authentication.Authenticator,io.micronaut.security.handlers.LoginHandler,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.context.event.ApplicationEventPublisher,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver,io.micronaut.security.endpoints.LoginControllerConfiguration)"><code>LoginController(io.micronaut.security.authentication.Authenticator&lt;io.micronaut.http.HttpRequest&lt;B&gt;&gt;,io.micronaut.security.handlers.LoginHandler&lt;io.micronaut.http.HttpRequest&lt;?&gt;,io.micronaut.http.MutableHttpResponse&lt;?&gt;&gt;,io.micronaut.context.event.ApplicationEventPublisher&lt;io.micronaut.security.event.LoginSuccessfulEvent&gt;,io.micronaut.context.event.ApplicationEventPublisher&lt;io.micronaut.security.event.LoginFailedEvent&gt;,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver,io.micronaut.security.endpoints.LoginControllerConfiguration)</code></a> instead.</div>
+</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>authenticator</code> - <a href="../authentication/Authenticator.html" title="class in io.micronaut.security.authentication"><code>Authenticator</code></a> collaborator</dd>