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

Class SecurityMockMvcResultMatchers.AuthenticatedMatcher

java.lang.Object

org.springframework.security.test.web.servlet.response.SecurityMockMvcResultMatchers.AuthenticatedMatcher

All Implemented Interfaces:

org.springframework.test.web.servlet.ResultMatcher

Enclosing class:

SecurityMockMvcResultMatchers

public static final class SecurityMockMvcResultMatchers.AuthenticatedMatcher
extends Object

A MockMvc ResultMatcher that verifies a specific user is associated to the MvcResult.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
protected SecurityContext	load(org.springframework.test.web.servlet.MvcResult result)
void	match(org.springframework.test.web.servlet.MvcResult result)
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withAuthentication(Consumer<Authentication> assertAuthentication)	Allows for any validating the authentication with arbitrary assertions.
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withAuthentication(Authentication expected)	Specifies the expected Authentication.
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withAuthenticationName(String expected)	Specifies the expected Principal.getName().
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withAuthenticationPrincipal(Object expected)	Specifies the expected principal.
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withAuthorities(String... authorities)	Specifies the GrantedAuthority.getAuthority().
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withAuthorities(Collection<? extends GrantedAuthority> expected)	Specifies the Authentication.getAuthorities().
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withRoles(String... roles)	Specifies the expected roles.
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withRoles(String rolePrefix, String[] roles)	Specifies the expected roles.
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withSecurityContext(SecurityContext expected)	Specifies the expected SecurityContext.
SecurityMockMvcResultMatchers.AuthenticatedMatcher	withUsername(String expected)	Specifies the expected username.

Methods inherited from class java.lang.Object

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

Method Details

match

@NullUnmarked
public void match(org.springframework.test.web.servlet.MvcResult result)

withAuthentication

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withAuthentication(Consumer<Authentication> assertAuthentication)

Allows for any validating the authentication with arbitrary assertions.

Parameters:

assertAuthentication - the Consumer which validates the authentication

Returns:

the AuthenticatedMatcher to perform additional assertions

withUsername

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withUsername(String expected)

Specifies the expected username.

Parameters:

expected - the expected username

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withSecurityContext

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withSecurityContext(SecurityContext expected)

Specifies the expected SecurityContext.

Parameters:

expected - the expected SecurityContext

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withAuthentication

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withAuthentication(Authentication expected)

Specifies the expected Authentication.

Parameters:

expected - the expected Authentication

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withAuthenticationPrincipal

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withAuthenticationPrincipal(Object expected)

Specifies the expected principal.

Parameters:

expected - the expected principal

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withAuthenticationName

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withAuthenticationName(String expected)

Specifies the expected Principal.getName().

Parameters:

expected - the expected Principal.getName()

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withAuthorities

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withAuthorities(String... authorities)

Specifies the GrantedAuthority.getAuthority().

Parameters:

authorities - the authorityNames

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withAuthorities

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withAuthorities(Collection<? extends GrantedAuthority> expected)

Specifies the Authentication.getAuthorities().

Parameters:

expected - the Authentication.getAuthorities()

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withRoles

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withRoles(String... roles)

Specifies the expected roles.

Since a set of authorities can contain more than just roles, this method differs from withAuthorities(java.lang.String...) in that it only verifies the authorities prefixed by ROLE_. Other authorities are ignored.

If you want to validate more than just roles, please use withAuthorities(java.lang.String...).

Parameters:

roles - the roles. Each value is automatically prefixed with "ROLE_"

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

withRoles

public SecurityMockMvcResultMatchers.AuthenticatedMatcher withRoles(String rolePrefix,
 String[] roles)

Specifies the expected roles.

Since a set of authorities can contain more than just roles, this method differs from withAuthorities(java.lang.String...) in that it only verifies the authorities prefixed by ROLE_. Other authorities are ignored.

If you want to validate more than just roles, please use withAuthorities(java.lang.String...).

Parameters:

rolePrefix - the role prefix

roles - the roles. Each value is automatically prefixed with the rolePrefix

Returns:

the SecurityMockMvcResultMatchers.AuthenticatedMatcher for further customization

Since:

7.0

load

protected SecurityContext load(org.springframework.test.web.servlet.MvcResult result)