Package org.springframework.security.test.web.reactive.server

Class SecurityMockServerConfigurers.JwtMutator

  • All Implemented Interfaces:
    org.springframework.test.web.reactive.server.MockServerConfigurer, org.springframework.test.web.reactive.server.WebTestClientConfigurer
    Enclosing class:
    SecurityMockServerConfigurers
    public static final class SecurityMockServerConfigurers.JwtMutator
extends java.lang.Object
implements org.springframework.test.web.reactive.server.WebTestClientConfigurer, org.springframework.test.web.reactive.server.MockServerConfigurer
    Updates the WebServerExchange using {@link SecurityMockServerConfigurers#mockAuthentication(Authentication)}.
    Since:
    5.2

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterConfigureAdded​(org.springframework.test.web.reactive.server.WebTestClient.MockServerSpec<?> serverSpec)  
      void afterConfigurerAdded​(org.springframework.test.web.reactive.server.WebTestClient.Builder builder, org.springframework.web.server.adapter.WebHttpHandlerBuilder httpHandlerBuilder, org.springframework.http.client.reactive.ClientHttpConnector connector)  
      SecurityMockServerConfigurers.JwtMutator authorities​(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities)
      Use the provided authorities in the token
      SecurityMockServerConfigurers.JwtMutator authorities​(org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,​java.util.Collection<org.springframework.security.core.GrantedAuthority>> authoritiesConverter)
      Provides the configured Jwt so that custom authorities can be derived from it
      SecurityMockServerConfigurers.JwtMutator authorities​(org.springframework.security.core.GrantedAuthority... authorities)
      Use the provided authorities in the token
      void beforeServerCreated​(org.springframework.web.server.adapter.WebHttpHandlerBuilder builder)  
      SecurityMockServerConfigurers.JwtMutator jwt​(java.util.function.Consumer<org.springframework.security.oauth2.jwt.Jwt.Builder> jwtBuilderConsumer)
      Use the given Jwt.Builder Consumer to configure the underlying Jwt This method first creates a default Jwt.Builder instance with default values for the alg, sub, and scope claims.
      SecurityMockServerConfigurers.JwtMutator jwt​(org.springframework.security.oauth2.jwt.Jwt jwt)
      Use the given Jwt

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • jwt

        public SecurityMockServerConfigurers.JwtMutator jwt​(java.util.function.Consumer<org.springframework.security.oauth2.jwt.Jwt.Builder> jwtBuilderConsumer)
        Use the given Jwt.Builder Consumer to configure the underlying Jwt This method first creates a default Jwt.Builder instance with default values for the alg, sub, and scope claims. The Consumer can then modify these or provide additional configuration. Calling SecurityMockServerConfigurers.mockJwt() is the equivalent of calling SecurityMockMvcRequestPostProcessors.mockJwt().jwt(() -> {}).
        Parameters:
        jwtBuilderConsumer - For configuring the underlying Jwt
        Returns:
        the SecurityMockServerConfigurers.JwtMutator for further configuration

      • authorities

        public SecurityMockServerConfigurers.JwtMutator authorities​(org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,​java.util.Collection<org.springframework.security.core.GrantedAuthority>> authoritiesConverter)
        Provides the configured Jwt so that custom authorities can be derived from it
        Parameters:
        authoritiesConverter - the conversion strategy from Jwt to a Collection of GrantedAuthoritys
        Returns:
        the SecurityMockServerConfigurers.JwtMutator for further configuration

      • beforeServerCreated

        public void beforeServerCreated​(org.springframework.web.server.adapter.WebHttpHandlerBuilder builder)
        Specified by:
        beforeServerCreated in interface org.springframework.test.web.reactive.server.MockServerConfigurer

      • afterConfigureAdded

        public void afterConfigureAdded​(org.springframework.test.web.reactive.server.WebTestClient.MockServerSpec<?> serverSpec)
        Specified by:
        afterConfigureAdded in interface org.springframework.test.web.reactive.server.MockServerConfigurer

      • afterConfigurerAdded

        public void afterConfigurerAdded​(org.springframework.test.web.reactive.server.WebTestClient.Builder builder,
                                 @Nullable
                                 org.springframework.web.server.adapter.WebHttpHandlerBuilder httpHandlerBuilder,
                                 @Nullable
                                 org.springframework.http.client.reactive.ClientHttpConnector connector)
        Specified by:
        afterConfigurerAdded in interface org.springframework.test.web.reactive.server.WebTestClientConfigurer