Class SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
java.lang.Object
org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
- All Implemented Interfaces:
org.springframework.beans.Mergeable
,org.springframework.test.web.servlet.RequestBuilder
- Enclosing class:
- SecurityMockMvcRequestBuilders
public static final class SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
extends Object
implements org.springframework.test.web.servlet.RequestBuilder, org.springframework.beans.Mergeable
Creates a form based login request including any necessary
CsrfToken
.- Since:
- 4.0
-
Method Summary
Modifier and TypeMethodDescriptionacceptMediaType
(org.springframework.http.MediaType acceptMediaType) Specify a media type to set as the Accept header in the request.org.springframework.mock.web.MockHttpServletRequest
buildRequest
(jakarta.servlet.ServletContext servletContext) boolean
loginProcessingUrl
(String loginProcessingUrl) Specifies the URL to POST to.loginProcessingUrl
(String loginProcessingUrl, Object... uriVars) Specifies the URL to POST to.The value of the password parameter.Specify both the password parameter name and the password.passwordParam
(String passwordParameter) The HTTP parameter to place the password.The value of the username parameter.Specify both the password parameter name and the password.userParameter
(String usernameParameter) The HTTP parameter to place the username.
-
Method Details
-
buildRequest
public org.springframework.mock.web.MockHttpServletRequest buildRequest(jakarta.servlet.ServletContext servletContext) - Specified by:
buildRequest
in interfaceorg.springframework.test.web.servlet.RequestBuilder
-
loginProcessingUrl
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder loginProcessingUrl(String loginProcessingUrl) Specifies the URL to POST to. Default is "/login"- Parameters:
loginProcessingUrl
- the URL to POST to. Default is "/login"- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
loginProcessingUrl
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder loginProcessingUrl(String loginProcessingUrl, Object... uriVars) Specifies the URL to POST to.- Parameters:
loginProcessingUrl
- the URL to POST touriVars
- the URI variables- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
userParameter
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder userParameter(String usernameParameter) The HTTP parameter to place the username. Default is "username".- Parameters:
usernameParameter
- the HTTP parameter to place the username. Default is "username".- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
passwordParam
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder passwordParam(String passwordParameter) The HTTP parameter to place the password. Default is "password".- Parameters:
passwordParameter
- the HTTP parameter to place the password. Default is "password".- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
password
The value of the password parameter. Default is "password".- Parameters:
password
- the value of the password parameter. Default is "password".- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
user
The value of the username parameter. Default is "user".- Parameters:
username
- the value of the username parameter. Default is "user".- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
password
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder password(String passwordParameter, String password) Specify both the password parameter name and the password.- Parameters:
passwordParameter
- the HTTP parameter to place the password. Default is "password".password
- the value of the password parameter. Default is "password".- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
user
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder user(String usernameParameter, String username) Specify both the password parameter name and the password.- Parameters:
usernameParameter
- the HTTP parameter to place the username. Default is "username".username
- the value of the username parameter. Default is "user".- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
acceptMediaType
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder acceptMediaType(org.springframework.http.MediaType acceptMediaType) Specify a media type to set as the Accept header in the request.- Parameters:
acceptMediaType
- theMediaType
to set the Accept header to. Default is: MediaType.APPLICATION_FORM_URLENCODED- Returns:
- the
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
for additional customizations
-
isMergeEnabled
public boolean isMergeEnabled()- Specified by:
isMergeEnabled
in interfaceorg.springframework.beans.Mergeable
-
merge
- Specified by:
merge
in interfaceorg.springframework.beans.Mergeable
-