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

Class SecurityMockMvcRequestBuilders

java.lang.Object

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

public final class SecurityMockMvcRequestBuilders
extends Object

Contains Spring Security related MockMvc RequestBuilders.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	Creates a form based login request including any necessary CsrfToken.
static final class	SecurityMockMvcRequestBuilders.LogoutRequestBuilder	Creates a logout request (including any necessary CsrfToken)

Method Summary

Modifier and Type	Method	Description
static SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	formLogin()	Creates a request (including any necessary CsrfToken) that will submit a form based login to POST "/login".
static SecurityMockMvcRequestBuilders.FormLoginRequestBuilder	formLogin(String loginProcessingUrl)	Creates a request (including any necessary CsrfToken) that will submit a form based login to POST loginProcessingUrl.
static SecurityMockMvcRequestBuilders.LogoutRequestBuilder	logout()	Creates a logout request.
static SecurityMockMvcRequestBuilders.LogoutRequestBuilder	logout(String logoutUrl)	Creates a logout request (including any necessary CsrfToken) to the specified logoutUrl

Methods inherited from class java.lang.Object

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

Method Details

formLogin

public static SecurityMockMvcRequestBuilders.FormLoginRequestBuilder formLogin()

Creates a request (including any necessary CsrfToken) that will submit a form based login to POST "/login".

Returns:

the FormLoginRequestBuilder for further customizations

formLogin

public static SecurityMockMvcRequestBuilders.FormLoginRequestBuilder formLogin(String loginProcessingUrl)

Creates a request (including any necessary CsrfToken) that will submit a form based login to POST loginProcessingUrl.

Parameters:

loginProcessingUrl - the URL to POST to

Returns:

the FormLoginRequestBuilder for further customizations

logout

public static SecurityMockMvcRequestBuilders.LogoutRequestBuilder logout()

Creates a logout request.

Returns:

the LogoutRequestBuilder for additional customizations

logout

public static SecurityMockMvcRequestBuilders.LogoutRequestBuilder logout(String logoutUrl)

Creates a logout request (including any necessary CsrfToken) to the specified logoutUrl

Parameters:

logoutUrl - the logout request URL

Returns:

the LogoutRequestBuilder for additional customizations