SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor (spring-security-docs 5.6.3 API)

java.lang.Object
- org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor

All Implemented Interfaces:

org.springframework.test.web.servlet.request.RequestPostProcessor

Enclosing class:

SecurityMockMvcRequestPostProcessors
```
public static final class SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor
extends java.lang.Object
implements org.springframework.test.web.servlet.request.RequestPostProcessor
```
Populates a valid CsrfToken into the request.

Since:

4.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor`	`asHeader()`	Instead of using the `CsrfToken` as a request parameter (default) will populate the `CsrfToken` as a header.
`org.springframework.mock.web.MockHttpServletRequest`	`postProcessRequest(org.springframework.mock.web.MockHttpServletRequest request)`
`SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor`	`useInvalidToken()`	Populates an invalid token value on the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - postProcessRequest
```
public org.springframework.mock.web.MockHttpServletRequest postProcessRequest(org.springframework.mock.web.MockHttpServletRequest request)
```
    Specified by:
    
    postProcessRequest in interface org.springframework.test.web.servlet.request.RequestPostProcessor
  - asHeader
```
public SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor asHeader()
```
    Instead of using the CsrfToken as a request parameter (default) will populate the CsrfToken as a header.
    
    Returns:
    
    the SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor for additional customizations
  - useInvalidToken
```
public SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor useInvalidToken()
```
    Populates an invalid token value on the request.
    
    Returns:
    
    the SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor for additional customizations