Package com.broadleafcommerce.tenant.service

Class DefaultTenantResolver

java.lang.Object

com.broadleafcommerce.tenant.service.DefaultTenantResolver

All Implemented Interfaces:

TenantResolver

public class DefaultTenantResolver
extends Object
implements TenantResolver

Default implementation of TenantResolver that leverages the UrlResolverProperties for resolving the admin tenant or application by URL.

Author:

Nathan Moore (nathanmoore)., Erin Pennington (epenning), Nick Crum (ncrum)

Constructor Summary

Constructors

Constructor	Description
DefaultTenantResolver(ApplicationService<Application> applicationService, TenantService<Tenant> tenantService, UrlResolverProperties props)

Method Summary

Modifier and Type	Method	Description
protected List<Currency>	convertLocaleListToCurrencyList(List<Locale> locales)
protected org.springframework.web.util.UriComponents	convertUrlToUri(String url)
protected Optional<Application>	getApplicationForUri(org.springframework.web.util.UriComponents uri)
protected ApplicationService<Application>	getApplicationService()
protected <T> Optional<T>	getContextPathMatch(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config, BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)
protected <T> Optional<T>	getDomainMatch(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config, BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)
protected String	getDomainPrefix(String domain)
protected <T> Optional<T>	getMatchForUri(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config, BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)	Tries to resolve a context result matching the given URI checking for parameters, then domain, then domain prefix.
protected <T> Optional<T>	getParameterMatch(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config, BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)
protected <T> Optional<T>	getPrefixMatch(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config, BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)
protected UrlResolverProperties	getProps()
protected Optional<Tenant>	getTenantForUri(org.springframework.web.util.UriComponents uri)
protected TenantService<Tenant>	getTenantService()
protected boolean	isDomainNotMatching(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config)
protected boolean	isEmptyPort(String port)
protected boolean	isPathNotMatching(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config)
protected boolean	isPortNotMatching(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config)
protected boolean	isPrefixNotMatching(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config)
protected boolean	isSchemeNotMatching(org.springframework.web.util.UriComponents uri, UrlResolverProperties.UrlResolverConfiguration config)
Optional<Tenant>	resolveAdminTenant(String url)	Resolves the tenant for the admin that matches the provided URL, or empty.
Optional<Application>	resolveApplication(String url)	Resolves the application that matches the provided URL, or empty.
Optional<Application>	resolveApplicationById(String id)	Resolves the application that matches the provided ID.
Optional<Application>	resolveApplicationByToken(String token)	Resolves the application that matches the provided token.
Optional<Application>	resolveApplicationByURL(String url)	Resolves the application that matches the provided URL, or empty.
protected String	trimPrefix(String host, String prefix)
protected void	updateAllowedCurrencies(Application application)
protected void	updateAllowedCurrencies(Tenant tenant)
protected void	updateDefaultCurrency(Application application)
protected void	updateDefaultCurrency(Tenant tenant)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultTenantResolver

public DefaultTenantResolver(ApplicationService<Application> applicationService,
 TenantService<Tenant> tenantService,
 UrlResolverProperties props)

Method Details

resolveApplication

public Optional<Application> resolveApplication(String url)

Description copied from interface: TenantResolver

Resolves the application that matches the provided URL, or empty.

Specified by:

resolveApplication in interface TenantResolver

Parameters:

url - the url to match to an Application

Returns:

an optional application

resolveApplicationByURL

public Optional<Application> resolveApplicationByURL(String url)

Description copied from interface: TenantResolver

Resolves the application that matches the provided URL, or empty.

Specified by:

resolveApplicationByURL in interface TenantResolver

Parameters:

url - the url to match to an Application

Returns:

an optional application

resolveApplicationById

public Optional<Application> resolveApplicationById(String id)

Description copied from interface: TenantResolver

Resolves the application that matches the provided ID.

Specified by:

resolveApplicationById in interface TenantResolver

Parameters:

id - the ID of the application

Returns:

an optional application

resolveApplicationByToken

public Optional<Application> resolveApplicationByToken(String token)

Description copied from interface: TenantResolver

Resolves the application that matches the provided token.

Specified by:

resolveApplicationByToken in interface TenantResolver

Parameters:

token - the token of the application

Returns:

an optional application

resolveAdminTenant

public Optional<Tenant> resolveAdminTenant(String url)

Description copied from interface: TenantResolver

Resolves the tenant for the admin that matches the provided URL, or empty.

Specified by:

resolveAdminTenant in interface TenantResolver

Parameters:

url - the url to match to a Tenant

Returns:

an optional tenant

updateDefaultCurrency

protected void updateDefaultCurrency(Application application)

updateAllowedCurrencies

protected void updateAllowedCurrencies(Application application)

updateDefaultCurrency

protected void updateDefaultCurrency(Tenant tenant)

updateAllowedCurrencies

protected void updateAllowedCurrencies(Tenant tenant)

convertLocaleListToCurrencyList

protected List<Currency> convertLocaleListToCurrencyList(List<Locale> locales)

convertUrlToUri

protected org.springframework.web.util.UriComponents convertUrlToUri(String url)

getApplicationForUri

protected Optional<Application> getApplicationForUri(org.springframework.web.util.UriComponents uri)

getTenantForUri

protected Optional<Tenant> getTenantForUri(org.springframework.web.util.UriComponents uri)

getMatchForUri

protected <T> Optional<T> getMatchForUri(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config,
 BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)

Tries to resolve a context result matching the given URI checking for parameters, then domain, then domain prefix.

Type Parameters:

T - The type of the context domain result to resolve

Parameters:

uri - The requested URI for which to resolve the context domain result

config - the url resolver configuration

readByIdentifierAndIdentifierType - The function to read the context domain result given the identifier and ResolutionIdentifierType

Returns:

Optional containing resolved context domain result if found

getParameterMatch

protected <T> Optional<T> getParameterMatch(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config,
 BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)

getDomainMatch

protected <T> Optional<T> getDomainMatch(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config,
 BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)

getPrefixMatch

protected <T> Optional<T> getPrefixMatch(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config,
 BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)

getContextPathMatch

protected <T> Optional<T> getContextPathMatch(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config,
 BiFunction<String,String,Optional<T>> readByIdentifierAndIdentifierType)

Since:

1.8.6

isSchemeNotMatching

protected boolean isSchemeNotMatching(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config)

isPortNotMatching

protected boolean isPortNotMatching(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config)

isEmptyPort

protected boolean isEmptyPort(String port)

isPathNotMatching

protected boolean isPathNotMatching(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config)

isDomainNotMatching

protected boolean isDomainNotMatching(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config)

isPrefixNotMatching

protected boolean isPrefixNotMatching(org.springframework.web.util.UriComponents uri,
 UrlResolverProperties.UrlResolverConfiguration config)

trimPrefix

protected String trimPrefix(String host,
 String prefix)

getDomainPrefix

@Nullable
protected String getDomainPrefix(String domain)

getApplicationService

protected ApplicationService<Application> getApplicationService()

getTenantService

protected TenantService<Tenant> getTenantService()

getProps

protected UrlResolverProperties getProps()