de.hybris.platform.addonsupport.interceptors

Class AbstractConditionalResourceBeforeHandler

java.lang.Object

de.hybris.platform.addonsupport.interceptors.AbstractConditionalResourceBeforeHandler

All Implemented Interfaces:

BeforeViewHandlerAdaptee

public abstract class AbstractConditionalResourceBeforeHandler
extends java.lang.Object
implements BeforeViewHandlerAdaptee

Allows an AddOn to Include Java Script and CSS conditionally.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COMMON
protected static java.lang.String	RESOURCE_TYPE_CSS
protected static java.lang.String	RESOURCE_TYPE_JAVASCRIPT
protected static java.lang.String	SHARED

Constructor Summary

Constructors

Constructor and Description
AbstractConditionalResourceBeforeHandler()

Method Summary

Modifier and Type	Method and Description
protected void	addOrAppendListAttribute(ModelMap model, java.lang.String key, java.util.List newVals)
protected void	addResourcePaths(java.lang.String contextPath, java.util.List<java.lang.String> addOnResourcePaths, java.lang.String addon, java.lang.String propertyName)
java.lang.String	beforeView(HttpServletRequest request, HttpServletResponse response, ModelMap model, java.lang.String viewName)
protected java.util.List	getAddOnCommonCSSPaths(java.lang.String contextPath, java.lang.String uiExperience, java.util.List<java.lang.String> addOnNames)
protected java.util.List	getAddOnJSPaths(java.lang.String contextPath, java.lang.String siteName, java.lang.String uiExperience, java.util.List<java.lang.String> addOnNames)
protected java.util.List	getAddOnResourcePaths(java.lang.String contextPath, java.util.List<java.lang.String> addOnNames, java.lang.String[] propertyNames)
protected java.util.List	getAddOnThemeCSSPaths(java.lang.String contextPath, java.lang.String themeName, java.lang.String uiExperience, java.util.List<java.lang.String> addOnNames)
protected <T> T	getBean(HttpServletRequest request, java.lang.String beanName, java.lang.Class<T> beanType) Helper method to lookup a spring bean in the context of a request.
protected java.lang.String	getCommonCssPathKey()
protected java.lang.String	getDefaultThemeName()
protected java.lang.String	getJavaScriptPathsKey()
abstract java.lang.String	getPathPropertyPrefix()
protected RequestContextData	getRequestContextData(HttpServletRequest request)
protected java.lang.String	getThemeCssPathKey()
protected java.lang.String	getThemeNameForSite(CMSSiteModel site)
protected abstract boolean	isIncludeResource(HttpServletRequest request, HttpServletResponse response, ModelMap model, java.lang.String viewName)
void	setDefaultThemeName(java.lang.String defaultThemeName)

Methods inherited from class java.lang.Object

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

Field Detail

COMMON

protected static final java.lang.String COMMON

See Also:

Constant Field Values

SHARED

protected static final java.lang.String SHARED

See Also:

Constant Field Values

RESOURCE_TYPE_JAVASCRIPT

protected static final java.lang.String RESOURCE_TYPE_JAVASCRIPT

See Also:

Constant Field Values

RESOURCE_TYPE_CSS

protected static final java.lang.String RESOURCE_TYPE_CSS

See Also:

Constant Field Values

Constructor Detail

AbstractConditionalResourceBeforeHandler

public AbstractConditionalResourceBeforeHandler()

Method Detail

beforeView

public java.lang.String beforeView(HttpServletRequest request,
                                   HttpServletResponse response,
                                   ModelMap model,
                                   java.lang.String viewName)
                            throws java.lang.Exception

Specified by:

beforeView in interface BeforeViewHandlerAdaptee

Throws:

java.lang.Exception

addOrAppendListAttribute

protected void addOrAppendListAttribute(ModelMap model,
                                        java.lang.String key,
                                        java.util.List newVals)

getCommonCssPathKey

protected java.lang.String getCommonCssPathKey()

getThemeCssPathKey

protected java.lang.String getThemeCssPathKey()

getJavaScriptPathsKey

protected java.lang.String getJavaScriptPathsKey()

isIncludeResource

protected abstract boolean isIncludeResource(HttpServletRequest request,
                                             HttpServletResponse response,
                                             ModelMap model,
                                             java.lang.String viewName)

getAddOnResourcePaths

protected java.util.List getAddOnResourcePaths(java.lang.String contextPath,
                                               java.util.List<java.lang.String> addOnNames,
                                               java.lang.String[] propertyNames)

addResourcePaths

protected void addResourcePaths(java.lang.String contextPath,
                                java.util.List<java.lang.String> addOnResourcePaths,
                                java.lang.String addon,
                                java.lang.String propertyName)

getAddOnCommonCSSPaths

protected java.util.List getAddOnCommonCSSPaths(java.lang.String contextPath,
                                                java.lang.String uiExperience,
                                                java.util.List<java.lang.String> addOnNames)

getAddOnThemeCSSPaths

protected java.util.List getAddOnThemeCSSPaths(java.lang.String contextPath,
                                               java.lang.String themeName,
                                               java.lang.String uiExperience,
                                               java.util.List<java.lang.String> addOnNames)

getAddOnJSPaths

protected java.util.List getAddOnJSPaths(java.lang.String contextPath,
                                         java.lang.String siteName,
                                         java.lang.String uiExperience,
                                         java.util.List<java.lang.String> addOnNames)

getThemeNameForSite

protected java.lang.String getThemeNameForSite(CMSSiteModel site)

getBean

protected <T> T getBean(HttpServletRequest request,
                        java.lang.String beanName,
                        java.lang.Class<T> beanType)

Helper method to lookup a spring bean in the context of a request. This should only be used to lookup beans that are request scoped. The looked up bean is cached in the request attributes so it should not have a narrower scope than request scope. This method should not be used for beans that could be injected into this bean.

Type Parameters:

T - the expected type of the bean

Parameters:

request - the current request

beanName - the name of the bean to lookup

beanType - the expected type of the bean

Returns:

the bean found or null

getRequestContextData

protected RequestContextData getRequestContextData(HttpServletRequest request)

getDefaultThemeName

protected java.lang.String getDefaultThemeName()

setDefaultThemeName

public void setDefaultThemeName(java.lang.String defaultThemeName)

getPathPropertyPrefix

public abstract java.lang.String getPathPropertyPrefix()