com.broadleafcommerce.tenant.web.resolver

Class AbstractMultiTenantSiteResolver

java.lang.Object

com.broadleafcommerce.tenant.web.resolver.AbstractMultiTenantSiteResolver

All Implemented Interfaces:

org.broadleafcommerce.common.web.BroadleafSiteResolver

Direct Known Subclasses:

MultiTenantHeaderSiteResolver, MultiTenantQueryParameterSiteResolver, MultiTenantSiteResolver

public abstract class AbstractMultiTenantSiteResolver
extends Object
implements org.broadleafcommerce.common.web.BroadleafSiteResolver

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	ignoreAndStripRegexPatterns
protected List<String>	ignoreRegexPatterns
protected boolean	invalidateSessionOnChange
protected static org.apache.commons.logging.Log	LOG
static String	ORIGIN_IS_TEMPLATE_SITE_PARAM
static String	ORIGIN_SITE_BRC_PARAM
static String	SELECTED_SITE_BRC_PARAM
static String	SELECTED_SITE_SESSION_PARAM
protected org.broadleafcommerce.common.site.service.SiteService	siteService
protected org.broadleafcommerce.common.security.service.StaleStateProtectionService	staleStateProtectionService

Fields inherited from interface org.broadleafcommerce.common.web.BroadleafSiteResolver

SELECTED_SITE_URL_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractMultiTenantSiteResolver()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForIgnoredRequestPatterns(org.springframework.web.context.request.WebRequest request)
protected void	clearSelectedSiteIfNeeded(org.springframework.web.context.request.WebRequest request, org.broadleafcommerce.common.web.BroadleafRequestContext brc) If a SELECTED_SITE_URL_PARAM exists then this method will clear the request and session properties for a selected site.
List<String>	getIgnoreAndStripRegexPatterns()
List<String>	getIgnoreRegexPatterns()
abstract SiteRequest	getSiteRequest(org.springframework.web.context.request.WebRequest request)
boolean	isInvalidateSessionOnChange()
org.broadleafcommerce.common.site.domain.Site	resolveSite(javax.servlet.http.HttpServletRequest request)
org.broadleafcommerce.common.site.domain.Site	resolveSite(org.springframework.web.context.request.WebRequest request)
org.broadleafcommerce.common.site.domain.Site	resolveSite(org.springframework.web.context.request.WebRequest request, boolean allowNullSite)
protected org.broadleafcommerce.common.site.domain.Site	resolveSiteInternal(org.springframework.web.context.request.WebRequest request, boolean allowNullSite)
void	setIgnoreAndStripRegexPatterns(List<String> ignoreAndStripRegexPatterns)
void	setIgnoreRegexPatterns(List<String> ignoreRegexPatterns)
void	setInvalidateSessionOnChange(boolean invalidateSessionOnChange)
protected boolean	siteIsValidChild(org.broadleafcommerce.common.site.domain.Site childSite, org.broadleafcommerce.common.site.domain.Site parentSite) Returns true if the passed in child site is a descendant of the passed in parentSite.
protected void	updateOriginSiteContext(org.broadleafcommerce.common.site.domain.Site site, org.broadleafcommerce.common.web.BroadleafRequestContext brc) Sets the ORIGIN_SITE_BRC_PARAM to the passed in site.
protected org.broadleafcommerce.common.site.domain.Site	updateSelectedSiteFromRequestParam(org.springframework.web.context.request.WebRequest request, org.broadleafcommerce.common.web.BroadleafRequestContext brc, org.broadleafcommerce.common.site.domain.Site site)
protected org.broadleafcommerce.common.site.domain.Site	updateSelectedSiteFromSession(org.springframework.web.context.request.WebRequest request, org.broadleafcommerce.common.web.BroadleafRequestContext brc, org.broadleafcommerce.common.site.domain.Site site) Returns the Site from session if one exists.
protected void	updateSessionContext(org.springframework.web.context.request.WebRequest request, org.broadleafcommerce.common.site.domain.Site site, org.broadleafcommerce.common.site.domain.Site selectedSite) Updates the session with the currently selected site.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

SELECTED_SITE_SESSION_PARAM

public static final String SELECTED_SITE_SESSION_PARAM

See Also:

Constant Field Values

SELECTED_SITE_BRC_PARAM

public static final String SELECTED_SITE_BRC_PARAM

See Also:

Constant Field Values

ORIGIN_SITE_BRC_PARAM

public static final String ORIGIN_SITE_BRC_PARAM

See Also:

Constant Field Values

ORIGIN_IS_TEMPLATE_SITE_PARAM

public static final String ORIGIN_IS_TEMPLATE_SITE_PARAM

See Also:

Constant Field Values

ignoreRegexPatterns

protected List<String> ignoreRegexPatterns

ignoreAndStripRegexPatterns

protected List<String> ignoreAndStripRegexPatterns

invalidateSessionOnChange

protected boolean invalidateSessionOnChange

siteService

protected org.broadleafcommerce.common.site.service.SiteService siteService

staleStateProtectionService

protected org.broadleafcommerce.common.security.service.StaleStateProtectionService staleStateProtectionService

Constructor Detail

AbstractMultiTenantSiteResolver

public AbstractMultiTenantSiteResolver()

Method Detail

resolveSite

public org.broadleafcommerce.common.site.domain.Site resolveSite(javax.servlet.http.HttpServletRequest request)
                                                          throws org.broadleafcommerce.common.exception.SiteNotFoundException

Specified by:

resolveSite in interface org.broadleafcommerce.common.web.BroadleafSiteResolver

Throws:

org.broadleafcommerce.common.exception.SiteNotFoundException

resolveSite

public org.broadleafcommerce.common.site.domain.Site resolveSite(org.springframework.web.context.request.WebRequest request)
                                                          throws org.broadleafcommerce.common.exception.SiteNotFoundException

Specified by:

resolveSite in interface org.broadleafcommerce.common.web.BroadleafSiteResolver

Throws:

org.broadleafcommerce.common.exception.SiteNotFoundException

resolveSite

public org.broadleafcommerce.common.site.domain.Site resolveSite(org.springframework.web.context.request.WebRequest request,
                                                                 boolean allowNullSite)
                                                          throws org.broadleafcommerce.common.exception.SiteNotFoundException

Specified by:

resolveSite in interface org.broadleafcommerce.common.web.BroadleafSiteResolver

Throws:

org.broadleafcommerce.common.exception.SiteNotFoundException

resolveSiteInternal

protected org.broadleafcommerce.common.site.domain.Site resolveSiteInternal(org.springframework.web.context.request.WebRequest request,
                                                                            boolean allowNullSite)

updateSelectedSiteFromRequestParam

protected org.broadleafcommerce.common.site.domain.Site updateSelectedSiteFromRequestParam(org.springframework.web.context.request.WebRequest request,
                                                                                           org.broadleafcommerce.common.web.BroadleafRequestContext brc,
                                                                                           org.broadleafcommerce.common.site.domain.Site site)

Parameters:

request -

brc -

updateSelectedSiteFromSession

protected org.broadleafcommerce.common.site.domain.Site updateSelectedSiteFromSession(org.springframework.web.context.request.WebRequest request,
                                                                                      org.broadleafcommerce.common.web.BroadleafRequestContext brc,
                                                                                      org.broadleafcommerce.common.site.domain.Site site)

Returns the Site from session if one exists. Updates the site variables on the BroadleafRequestContet.

Parameters:

request -

brc -

site -

Returns:

clearSelectedSiteIfNeeded

protected void clearSelectedSiteIfNeeded(org.springframework.web.context.request.WebRequest request,
                                         org.broadleafcommerce.common.web.BroadleafRequestContext brc)

If a SELECTED_SITE_URL_PARAM exists then this method will clear the request and session properties for a selected site. The assumption is that if the parameter exists and was a valid child site of the origin site then this method would not be called.

Parameters:

request -

brc -

checkForIgnoredRequestPatterns

protected boolean checkForIgnoredRequestPatterns(org.springframework.web.context.request.WebRequest request)

updateOriginSiteContext

protected void updateOriginSiteContext(org.broadleafcommerce.common.site.domain.Site site,
                                       org.broadleafcommerce.common.web.BroadleafRequestContext brc)

Sets the ORIGIN_SITE_BRC_PARAM to the passed in site. Also sets the ORIGIN_IS_TEMPLATE_SITE_PARAM property which indicates that the current origin site is a template site.

Parameters:

site -

brc -

updateSessionContext

protected void updateSessionContext(org.springframework.web.context.request.WebRequest request,
                                    org.broadleafcommerce.common.site.domain.Site site,
                                    org.broadleafcommerce.common.site.domain.Site selectedSite)

Updates the session with the currently selected site.

Parameters:

site -

selectedSite -

siteIsValidChild

protected boolean siteIsValidChild(org.broadleafcommerce.common.site.domain.Site childSite,
                                   org.broadleafcommerce.common.site.domain.Site parentSite)

Returns true if the passed in child site is a descendant of the passed in parentSite.

Parameters:

childSite -

parentSite -

Returns:

getIgnoreRegexPatterns

public List<String> getIgnoreRegexPatterns()

setIgnoreRegexPatterns

public void setIgnoreRegexPatterns(List<String> ignoreRegexPatterns)

isInvalidateSessionOnChange

public boolean isInvalidateSessionOnChange()

setInvalidateSessionOnChange

public void setInvalidateSessionOnChange(boolean invalidateSessionOnChange)

getIgnoreAndStripRegexPatterns

public List<String> getIgnoreAndStripRegexPatterns()

setIgnoreAndStripRegexPatterns

public void setIgnoreAndStripRegexPatterns(List<String> ignoreAndStripRegexPatterns)

getSiteRequest

public abstract SiteRequest getSiteRequest(org.springframework.web.context.request.WebRequest request)