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 java.lang.Object implements org.springframework.test.web.servlet.RequestBuilder, org.springframework.beans.Mergeable
Creates a form based login request including any necessaryCsrfToken
.- Since:
- 4.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
acceptMediaType(org.springframework.http.MediaType acceptMediaType)
Specify a media type to set as the Accept header in the request.org.springframework.mock.web.MockHttpServletRequest
buildRequest(javax.servlet.ServletContext servletContext)
boolean
isMergeEnabled()
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
loginProcessingUrl(java.lang.String loginProcessingUrl)
Specifies the URL to POST to.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
loginProcessingUrl(java.lang.String loginProcessingUrl, java.lang.Object... uriVars)
Specifies the URL to POST to.java.lang.Object
merge(java.lang.Object parent)
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
password(java.lang.String password)
The value of the password parameter.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
password(java.lang.String passwordParameter, java.lang.String password)
Specify both the password parameter name and the password.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
passwordParam(java.lang.String passwordParameter)
The HTTP parameter to place the password.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
user(java.lang.String username)
The value of the username parameter.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
user(java.lang.String usernameParameter, java.lang.String username)
Specify both the password parameter name and the password.SecurityMockMvcRequestBuilders.FormLoginRequestBuilder
userParameter(java.lang.String usernameParameter)
The HTTP parameter to place the username.
-
-
-
Method Detail
-
buildRequest
public org.springframework.mock.web.MockHttpServletRequest buildRequest(javax.servlet.ServletContext servletContext)
- Specified by:
buildRequest
in interfaceorg.springframework.test.web.servlet.RequestBuilder
-
loginProcessingUrl
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder loginProcessingUrl(java.lang.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(java.lang.String loginProcessingUrl, java.lang.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(java.lang.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(java.lang.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
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder password(java.lang.String 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
public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder user(java.lang.String username)
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(java.lang.String passwordParameter, java.lang.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(java.lang.String usernameParameter, java.lang.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
public java.lang.Object merge(java.lang.Object parent)
- Specified by:
merge
in interfaceorg.springframework.beans.Mergeable
-
-