org.broadleafcommerce.common.web

Interface BroadleafSiteResolver

All Known Implementing Classes:

NullBroadleafSiteResolver

public interface BroadleafSiteResolver

Responsible for returning the site used by Broadleaf Commerce for the current request. For a single site installation, this will typically return null.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
static String	SELECTED_SITE_URL_PARAM

Method Summary

Modifier and Type	Method and Description
Site	resolveSite(javax.servlet.http.HttpServletRequest request) Deprecated. Use resolveSite(WebRequest) instead
Site	resolveSite(org.springframework.web.context.request.WebRequest request)
Site	resolveSite(org.springframework.web.context.request.WebRequest request, boolean allowNullSite) Resolves a site for the given WebRequest.

Field Detail

SELECTED_SITE_URL_PARAM

static final String SELECTED_SITE_URL_PARAM

See Also:

Constant Field Values

Method Detail

resolveSite

@Deprecated
Site resolveSite(javax.servlet.http.HttpServletRequest request)
                      throws SiteNotFoundException

Deprecated. Use resolveSite(WebRequest) instead

Throws:

SiteNotFoundException

resolveSite

Site resolveSite(org.springframework.web.context.request.WebRequest request)
          throws SiteNotFoundException

Throws:

SiteNotFoundException

See Also:

resolveSite(WebRequest, boolean)

resolveSite

Site resolveSite(org.springframework.web.context.request.WebRequest request,
                 boolean allowNullSite)
          throws SiteNotFoundException

Resolves a site for the given WebRequest. Implementations should throw a SiteNotFoundException when a site could not be resolved unless the allowNullSite parameter is set to true.

Parameters:

request -

allowNullSite -

Returns:

the resolved Site

Throws:

SiteNotFoundException