org.springframework.security.web.authentication

Class MultiTenantAuthenticationManagerResolver<T>

java.lang.Object

org.springframework.security.web.authentication.MultiTenantAuthenticationManagerResolver<T>

All Implemented Interfaces:

AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest>

public final class MultiTenantAuthenticationManagerResolver<T>
extends java.lang.Object
implements AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest>

An implementation of AuthenticationManagerResolver that separates the tasks of extracting the request's tenant identifier and looking up an AuthenticationManager by that tenant identifier.

Since:

5.2

See Also:

AuthenticationManagerResolver

Constructor Summary

Constructors

Constructor and Description
MultiTenantAuthenticationManagerResolver(org.springframework.core.convert.converter.Converter<javax.servlet.http.HttpServletRequest,T> tenantResolver, org.springframework.core.convert.converter.Converter<T,AuthenticationManager> authenticationManagerResolver) Constructs a MultiTenantAuthenticationManagerResolver with the provided parameters

Method Summary

Modifier and Type	Method and Description
AuthenticationManager	resolve(javax.servlet.http.HttpServletRequest context) Resolve an AuthenticationManager from a provided context
static AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest>	resolveFromHeader(java.lang.String headerName, org.springframework.core.convert.converter.Converter<java.lang.String,AuthenticationManager> resolver) Creates an AuthenticationManagerResolver that will use a request headers's value as the resolution key for the underlying AuthenticationManagerResolver.
static AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest>	resolveFromPath(org.springframework.core.convert.converter.Converter<java.lang.String,AuthenticationManager> resolver) Creates an AuthenticationManagerResolver that will use a request path's first segment as the resolution key for the underlying AuthenticationManagerResolver.
static AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest>	resolveFromSubdomain(org.springframework.core.convert.converter.Converter<java.lang.String,AuthenticationManager> resolver) Creates an AuthenticationManagerResolver that will use a hostname's first label as the resolution key for the underlying AuthenticationManagerResolver.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiTenantAuthenticationManagerResolver

public MultiTenantAuthenticationManagerResolver(org.springframework.core.convert.converter.Converter<javax.servlet.http.HttpServletRequest,T> tenantResolver,
                                                org.springframework.core.convert.converter.Converter<T,AuthenticationManager> authenticationManagerResolver)

Constructs a MultiTenantAuthenticationManagerResolver with the provided parameters

Parameters:

tenantResolver -

authenticationManagerResolver -

Method Detail

resolve

public AuthenticationManager resolve(javax.servlet.http.HttpServletRequest context)

Description copied from interface: AuthenticationManagerResolver

Resolve an AuthenticationManager from a provided context

Specified by:

resolve in interface AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest>

Returns:

the AuthenticationManager to use

resolveFromSubdomain

public static AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest> resolveFromSubdomain(org.springframework.core.convert.converter.Converter<java.lang.String,AuthenticationManager> resolver)

Creates an AuthenticationManagerResolver that will use a hostname's first label as the resolution key for the underlying AuthenticationManagerResolver. For example, you might have a set of AuthenticationManagers defined like so:

        Map authenticationManagers = new HashMap<>();
  authenticationManagers.put("tenantOne", managerOne());
  authenticationManagers.put("tenantTwo", managerTwo());
 

And that your system serves hostnames like

https://tenantOne.example.org

. Then, you could create an AuthenticationManagerResolver that uses the "tenantOne" value from the hostname to resolve Tenant One's AuthenticationManager like so:

        AuthenticationManagerResolver resolver =
                        resolveFromSubdomain(authenticationManagers::get);
 

HttpServletRequest

Parameters:

resolver - A String-resolving AuthenticationManagerResolver

Returns:

A hostname-resolving AuthenticationManagerResolver

resolveFromPath

public static AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest> resolveFromPath(org.springframework.core.convert.converter.Converter<java.lang.String,AuthenticationManager> resolver)

Creates an AuthenticationManagerResolver that will use a request path's first segment as the resolution key for the underlying AuthenticationManagerResolver. For example, you might have a set of AuthenticationManagers defined like so:

        Map authenticationManagers = new HashMap<>();
  authenticationManagers.put("tenantOne", managerOne());
  authenticationManagers.put("tenantTwo", managerTwo());
 

And that your system serves requests like

https://example.org/tenantOne

. Then, you could create an AuthenticationManagerResolver that uses the "tenantOne" value from the request to resolve Tenant One's AuthenticationManager like so:

        AuthenticationManagerResolver resolver =
                        resolveFromPath(authenticationManagers::get);
 

HttpServletRequest

Parameters:

resolver - A String-resolving AuthenticationManagerResolver

Returns:

A path-resolving AuthenticationManagerResolver

resolveFromHeader

public static AuthenticationManagerResolver<javax.servlet.http.HttpServletRequest> resolveFromHeader(java.lang.String headerName,
                                                                                                     org.springframework.core.convert.converter.Converter<java.lang.String,AuthenticationManager> resolver)

Creates an AuthenticationManagerResolver that will use a request headers's value as the resolution key for the underlying AuthenticationManagerResolver. For example, you might have a set of AuthenticationManagers defined like so:

        Map authenticationManagers = new HashMap<>();
  authenticationManagers.put("tenantOne", managerOne());
  authenticationManagers.put("tenantTwo", managerTwo());
 

And that your system serves requests with a header like

X-Tenant-Id: tenantOne

. Then, you could create an AuthenticationManagerResolver that uses the "tenantOne" value from the request to resolve Tenant One's AuthenticationManager like so:

        AuthenticationManagerResolver resolver =
                        resolveFromHeader("X-Tenant-Id", authenticationManagers::get);
 

HttpServletRequest

Parameters:

resolver - A String-resolving AuthenticationManagerResolver

Returns:

A header-resolving AuthenticationManagerResolver