From de104e22b7855172876d7be6dc6ef882755da60a Mon Sep 17 00:00:00 2001
From: Max Batischev <mblancer@mail.ru>
Date: Tue, 1 Oct 2024 23:05:08 +0300
Subject: [PATCH] Update javaDoc for
 DefaultOneTimeTokenSubmitPageGeneratingFilter

---
 .../DefaultOneTimeTokenSubmitPageGeneratingFilter.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/web/src/main/java/org/springframework/security/web/authentication/ui/DefaultOneTimeTokenSubmitPageGeneratingFilter.java b/web/src/main/java/org/springframework/security/web/authentication/ui/DefaultOneTimeTokenSubmitPageGeneratingFilter.java
index 7f1545db23..cdf39b7223 100644
--- a/web/src/main/java/org/springframework/security/web/authentication/ui/DefaultOneTimeTokenSubmitPageGeneratingFilter.java
+++ b/web/src/main/java/org/springframework/security/web/authentication/ui/DefaultOneTimeTokenSubmitPageGeneratingFilter.java
@@ -89,11 +89,21 @@ public final class DefaultOneTimeTokenSubmitPageGeneratingFilter extends OncePer
 			.render();
 	}
 
+	/**
+	 * Sets a Function used to resolve a Map of the hidden inputs where the key is the
+	 * name of the input and the value is the value of the input.
+	 * @param resolveHiddenInputs the function to resolve the inputs
+	 */
 	public void setResolveHiddenInputs(Function<HttpServletRequest, Map<String, String>> resolveHiddenInputs) {
 		Assert.notNull(resolveHiddenInputs, "resolveHiddenInputs cannot be null");
 		this.resolveHiddenInputs = resolveHiddenInputs;
 	}
 
+	/**
+	 * Use this {@link RequestMatcher} to choose whether this filter will handle the
+	 * request. By default, it handles {@code /login/ott}.
+	 * @param requestMatcher the {@link RequestMatcher} to use
+	 */
 	public void setRequestMatcher(RequestMatcher requestMatcher) {
 		Assert.notNull(requestMatcher, "requestMatcher cannot be null");
 		this.requestMatcher = requestMatcher;