Package org.springframework.security.test.web.servlet.request

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 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(jakarta.servlet.ServletContext servletContext)
boolean	isMergeEnabled()
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	loginProcessingUrl(String loginProcessingUrl)	Specifies the URL to POST to.
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	loginProcessingUrl(String loginProcessingUrl, Object... uriVars)	Specifies the URL to POST to.
Object	merge(Object parent)
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	password(String password)	The value of the password parameter.
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	password(String passwordParameter, String password)	Specify both the password parameter name and the password.
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	passwordParam(String passwordParameter)	The HTTP parameter to place the password.
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	user(String username)	The value of the username parameter.
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	user(String usernameParameter, String username)	Specify both the password parameter name and the password.
SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	userParameter(String usernameParameter)	The HTTP parameter to place the username.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

buildRequest

public org.springframework.mock.web.MockHttpServletRequest buildRequest(jakarta.servlet.ServletContext servletContext)

Specified by:

buildRequest in interface org.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 to

uriVars - 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

public SecurityMockMvcRequestBuilders.FormLoginRequestBuilder password(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(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(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 - the MediaType 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 interface org.springframework.beans.Mergeable

merge

public Object merge(Object parent)

Specified by:

merge in interface org.springframework.beans.Mergeable