Skip to content

Fix javadocs on WebFlux CSRF classes #16781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 20, 2025
Merged

Fix javadocs on WebFlux CSRF classes #16781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions web/src/main/java/org/springframework/security/web/server/csrf/CsrfException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@
import java.io.Serial;

import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.web.csrf.CsrfToken;

/**
* Thrown when an invalid or missing {@link CsrfToken} is found in the HttpServletRequest
* Thrown when an invalid or missing {@link CsrfToken} is found in the ServerWebExchange
*
* @author Rob Winch
* @since 3.2
* @since 5.0
*/
public class CsrfException extends AccessDeniedException {

Expand Down
9 changes: 4 additions & 5 deletions ...ava/org/springframework/security/web/server/csrf/WebSessionServerCsrfTokenRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,16 @@
import java.util.Map;
import java.util.UUID;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpSession;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Schedulers;

import org.springframework.util.Assert;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebSession;

/**
* A {@link ServerCsrfTokenRepository} that stores the {@link CsrfToken} in the
* {@link HttpSession}.
* {@link WebSession}.
*
* @author Rob Winch
* @since 5.0
Expand Down Expand Up @@ -78,7 +77,7 @@ public Mono<CsrfToken> loadToken(ServerWebExchange exchange) {
}

/**
* Sets the {@link HttpServletRequest} parameter name that the {@link CsrfToken} is
* Sets the {@link ServerWebExchange} parameter name that the {@link CsrfToken} is
* expected to appear on
* @param parameterName the new parameter name to use
*/
Expand All @@ -98,7 +97,7 @@ public void setHeaderName(String headerName) {
}

/**
* Sets the {@link HttpSession} attribute name that the {@link CsrfToken} is stored in
* Sets the {@link WebSession} attribute name that the {@link CsrfToken} is stored in
* @param sessionAttributeName the new attribute name to use
*/
public void setSessionAttributeName(String sessionAttributeName) {
Expand Down