Package org.springframework.security.config.annotation.web.configurers

Class JeeConfigurer<H extends HttpSecurityBuilder<H>>

java.lang.Object

org.springframework.security.config.annotation.SecurityConfigurerAdapter<DefaultSecurityFilterChain,B>

org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer<JeeConfigurer<H>,H>

org.springframework.security.config.annotation.web.configurers.JeeConfigurer<H>

All Implemented Interfaces:

SecurityConfigurer<DefaultSecurityFilterChain,H>

public final class JeeConfigurer<H extends HttpSecurityBuilder<H>>
extends AbstractHttpConfigurer<JeeConfigurer<H>,H>

Adds support for J2EE pre authentication.

Security Filters

The following Filters are populated

• J2eePreAuthenticatedProcessingFilter

Shared Objects Created

• AuthenticationEntryPoint is populated with an Http403ForbiddenEntryPoint
• A PreAuthenticatedAuthenticationProvider is populated into HttpSecurity.authenticationProvider(org.springframework.security.authentication.AuthenticationProvider)

Shared Objects Used

The following shared objects are used:

• AuthenticationManager

Since:

3.2

Constructor Summary

Constructors

Constructor	Description
JeeConfigurer()	Creates a new instance

Method Summary

Modifier and Type	Method	Description
JeeConfigurer<H>	authenticatedUserDetailsService(AuthenticationUserDetailsService<PreAuthenticatedAuthenticationToken> authenticatedUserDetailsService)	Specifies the AuthenticationUserDetailsService that is used with the PreAuthenticatedAuthenticationProvider.
void	configure(H http)	Configure the SecurityBuilder by setting the necessary properties on the SecurityBuilder.
void	init(H http)	Populates a PreAuthenticatedAuthenticationProvider into HttpSecurity.authenticationProvider(org.springframework.security.authentication.AuthenticationProvider) and a Http403ForbiddenEntryPoint into HttpSecurityBuilder.setSharedObject(Class, Object)
JeeConfigurer<H>	j2eePreAuthenticatedProcessingFilter(J2eePreAuthenticatedProcessingFilter j2eePreAuthenticatedProcessingFilter)	Allows specifying the J2eePreAuthenticatedProcessingFilter to use.
JeeConfigurer<H>	mappableAuthorities(String... mappableRoles)	Specifies roles to use map from the HttpServletRequest to the UserDetails.
JeeConfigurer<H>	mappableAuthorities(Set<String> mappableRoles)	Specifies roles to use map from the HttpServletRequest to the UserDetails.
JeeConfigurer<H>	mappableRoles(String... mappableRoles)	Specifies roles to use map from the HttpServletRequest to the UserDetails and automatically prefixes it with "ROLE_".

Methods inherited from class org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer

disable, getSecurityContextHolderStrategy, withObjectPostProcessor

Methods inherited from class org.springframework.security.config.annotation.SecurityConfigurerAdapter

addObjectPostProcessor, and, getBuilder, postProcess, setBuilder

Methods inherited from class java.lang.Object

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

Constructor Details

JeeConfigurer

public JeeConfigurer()

Creates a new instance

See Also:

• HttpSecurity.jee()

Method Details

mappableAuthorities

public JeeConfigurer<H> mappableAuthorities(String... mappableRoles)

Specifies roles to use map from the HttpServletRequest to the UserDetails. If HttpServletRequest.isUserInRole(String) returns true, the role is added to the UserDetails. This method is the equivalent of invoking mappableAuthorities(Set). Multiple invocations of mappableAuthorities(String...) will override previous invocations.

There are no default roles that are mapped.

Parameters:

mappableRoles - the roles to attempt to map to the UserDetails (i.e. "ROLE_USER", "ROLE_ADMIN", etc).

Returns:

the JeeConfigurer for further customizations

See Also:

• SimpleMappableAttributesRetriever
• mappableRoles(String...)

mappableRoles

public JeeConfigurer<H> mappableRoles(String... mappableRoles)

Specifies roles to use map from the HttpServletRequest to the UserDetails and automatically prefixes it with "ROLE_". If HttpServletRequest.isUserInRole(String) returns true, the role is added to the UserDetails. This method is the equivalent of invoking mappableAuthorities(Set). Multiple invocations of mappableRoles(String...) will override previous invocations.

There are no default roles that are mapped.

Parameters:

mappableRoles - the roles to attempt to map to the UserDetails (i.e. "USER", "ADMIN", etc).

Returns:

the JeeConfigurer for further customizations

See Also:

• SimpleMappableAttributesRetriever
• mappableAuthorities(String...)

mappableAuthorities

public JeeConfigurer<H> mappableAuthorities(Set<String> mappableRoles)

Specifies roles to use map from the HttpServletRequest to the UserDetails. If HttpServletRequest.isUserInRole(String) returns true, the role is added to the UserDetails. This is the equivalent of mappableRoles(String...). Multiple invocations of mappableAuthorities(Set) will override previous invocations.

There are no default roles that are mapped.

Parameters:

mappableRoles - the roles to attempt to map to the UserDetails.

Returns:

the JeeConfigurer for further customizations

See Also:

• SimpleMappableAttributesRetriever

authenticatedUserDetailsService

public JeeConfigurer<H> authenticatedUserDetailsService(AuthenticationUserDetailsService<PreAuthenticatedAuthenticationToken> authenticatedUserDetailsService)

Specifies the AuthenticationUserDetailsService that is used with the PreAuthenticatedAuthenticationProvider. The default is a PreAuthenticatedGrantedAuthoritiesUserDetailsService.

Parameters:

authenticatedUserDetailsService - the AuthenticationUserDetailsService to use.

Returns:

the JeeConfigurer for further configuration

j2eePreAuthenticatedProcessingFilter

public JeeConfigurer<H> j2eePreAuthenticatedProcessingFilter(J2eePreAuthenticatedProcessingFilter j2eePreAuthenticatedProcessingFilter)

Allows specifying the J2eePreAuthenticatedProcessingFilter to use. If J2eePreAuthenticatedProcessingFilter is provided, all of its attributes must also be configured manually (i.e. all attributes populated in the JeeConfigurer are not used).

Parameters:

j2eePreAuthenticatedProcessingFilter - the J2eePreAuthenticatedProcessingFilter to use.

Returns:

the JeeConfigurer for further configuration

init

public void init(H http)

Populates a PreAuthenticatedAuthenticationProvider into HttpSecurity.authenticationProvider(org.springframework.security.authentication.AuthenticationProvider) and a Http403ForbiddenEntryPoint into HttpSecurityBuilder.setSharedObject(Class, Object)

Specified by:

init in interface SecurityConfigurer<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>>

Overrides:

init in class SecurityConfigurerAdapter<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>>

See Also:

• SecurityConfigurerAdapter.init(org.springframework.security.config.annotation.SecurityBuilder)

configure

public void configure(H http)

Description copied from interface: SecurityConfigurer

Configure the SecurityBuilder by setting the necessary properties on the SecurityBuilder.

Specified by:

configure in interface SecurityConfigurer<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>>

Overrides:

configure in class SecurityConfigurerAdapter<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>>