org.craftercms.engine.view

Class CrafterPageViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.craftercms.engine.view.CrafterPageViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver

public class CrafterPageViewResolver
extends org.springframework.web.context.support.WebApplicationObjectSupport
implements org.springframework.web.servlet.ViewResolver, org.springframework.core.Ordered

ViewResolver that resolves to CrafterPageViews. This resolver retrieves the Crafter page from the content store and searches in the page DOM for the actual view name. The returned CrafterPageView then adds the page and the site navigation to the model, obtains the actual page view name from the delegated view resolver and delegates rendering to that view.

Author:

Alfonso Vasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected CrafterPageAccessManager	accessManager
protected org.craftercms.core.util.cache.CacheTemplate	cacheTemplate
protected boolean	cacheUrlTransformations
protected org.craftercms.core.service.CachingOptions	cachingOptions
protected String	contentTypeXPathQuery
protected org.springframework.web.servlet.ViewResolver	delegatedViewResolver
protected String	disabledXPathQuery
protected String	forceHttpsXPathQuery
protected String	fullHttpsUrlTransformerName
protected String	localizedUrlDelimiter
protected boolean	localizeViews
protected String	mimeTypeXPathQuery
protected boolean	modePreview
protected int	order
protected String	pageViewNameXPathQuery
protected String	redirectContentType
protected String	redirectUrlXPathQuery
protected ScriptFactory	scriptFactory
protected ScriptResolver	scriptResolver
protected SiteItemService	siteItemService
protected org.craftercms.core.util.url.ContentBundleUrlParser	urlParser
protected UrlTransformationService	urlTransformationService
protected String	urlTransformerName
protected UserAgentTemplateDetector	userAgentTemplateDetector

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
CrafterPageViewResolver()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.web.servlet.View	applyLifecycleMethods(String viewName, org.springframework.web.servlet.View view)
protected org.springframework.web.servlet.View	getCachedLocalizedView(String baseUrl, Locale locale)
protected org.springframework.web.servlet.View	getCurrentPageHttpsRedirectView()
protected SiteItem	getLocalizedPage(String baseUrl, Locale locale)
int	getOrder()
protected SiteItem	getPage(String url)
protected org.springframework.web.servlet.View	getRedirectView(String redirectUrl, boolean relative)
protected void	loadScripts(SiteItem page, CrafterPageView view)
org.springframework.web.servlet.View	resolveViewName(String viewName, Locale locale)
void	setAccessManager(CrafterPageAccessManager accessManager)
void	setCacheTemplate(org.craftercms.core.util.cache.CacheTemplate cacheTemplate)
void	setCacheUrlTransformations(boolean cacheUrlTransformations)
void	setCachingOptions(org.craftercms.core.service.CachingOptions cachingOptions)
void	setContentTypeXPathQuery(String contentTypeXPathQuery)
void	setDelegatedViewResolver(org.springframework.web.servlet.ViewResolver delegatedViewResolver)
void	setDisabledXPathQuery(String disabledXPathQuery)
void	setForceHttpsXPathQuery(String forceHttpsXPathQuery)
void	setFullHttpsUrlTransformerName(String fullHttpsUrlTransformerName)
void	setLocalizedUrlDelimiter(String localizedUrlDelimiter)
void	setLocalizeViews(boolean localizeViews)
void	setMimeTypeXPathQuery(String mimeTypeXPathQuery)
void	setModePreview(boolean modePreview)
void	setOrder(int order)
void	setPageViewNameXPathQuery(String pageViewNameXPathQuery)
void	setRedirectContentType(String redirectContentType)
void	setRedirectUrlXPathQuery(String redirectUrlXPathQuery)
void	setScriptFactory(ScriptFactory scriptFactory)
void	setScriptResolver(ScriptResolver scriptResolver)
void	setSiteItemService(SiteItemService siteItemService)
void	setUrlParser(org.craftercms.core.util.url.ContentBundleUrlParser urlParser)
void	setUrlTransformationService(UrlTransformationService urlTransformationService)
void	setUrlTransformerName(String urlTransformerName)
void	setUserAgentTemplateDetector(UserAgentTemplateDetector userAgentTemplateDetector)

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

order

protected int order

cacheUrlTransformations

protected boolean cacheUrlTransformations

urlTransformerName

protected String urlTransformerName

fullHttpsUrlTransformerName

protected String fullHttpsUrlTransformerName

urlTransformationService

protected UrlTransformationService urlTransformationService

localizedUrlDelimiter

protected String localizedUrlDelimiter

urlParser

protected org.craftercms.core.util.url.ContentBundleUrlParser urlParser

cacheTemplate

protected org.craftercms.core.util.cache.CacheTemplate cacheTemplate

cachingOptions

protected org.craftercms.core.service.CachingOptions cachingOptions

siteItemService

protected SiteItemService siteItemService

pageViewNameXPathQuery

protected String pageViewNameXPathQuery

redirectUrlXPathQuery

protected String redirectUrlXPathQuery

contentTypeXPathQuery

protected String contentTypeXPathQuery

redirectContentType

protected String redirectContentType

disabledXPathQuery

protected String disabledXPathQuery

mimeTypeXPathQuery

protected String mimeTypeXPathQuery

forceHttpsXPathQuery

protected String forceHttpsXPathQuery

scriptResolver

protected ScriptResolver scriptResolver

delegatedViewResolver

protected org.springframework.web.servlet.ViewResolver delegatedViewResolver

localizeViews

protected boolean localizeViews

userAgentTemplateDetector

protected UserAgentTemplateDetector userAgentTemplateDetector

modePreview

protected boolean modePreview

accessManager

protected CrafterPageAccessManager accessManager

scriptFactory

protected ScriptFactory scriptFactory

Constructor Detail

CrafterPageViewResolver

public CrafterPageViewResolver()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)

setModePreview

public void setModePreview(boolean modePreview)

setCacheUrlTransformations

public void setCacheUrlTransformations(boolean cacheUrlTransformations)

setUrlTransformerName

public void setUrlTransformerName(String urlTransformerName)

setFullHttpsUrlTransformerName

public void setFullHttpsUrlTransformerName(String fullHttpsUrlTransformerName)

setUrlTransformationService

public void setUrlTransformationService(UrlTransformationService urlTransformationService)

setLocalizedUrlDelimiter

public void setLocalizedUrlDelimiter(String localizedUrlDelimiter)

setUrlParser

public void setUrlParser(org.craftercms.core.util.url.ContentBundleUrlParser urlParser)

setCacheTemplate

public void setCacheTemplate(org.craftercms.core.util.cache.CacheTemplate cacheTemplate)

setCachingOptions

public void setCachingOptions(org.craftercms.core.service.CachingOptions cachingOptions)

setSiteItemService

public void setSiteItemService(SiteItemService siteItemService)

setPageViewNameXPathQuery

public void setPageViewNameXPathQuery(String pageViewNameXPathQuery)

setRedirectUrlXPathQuery

public void setRedirectUrlXPathQuery(String redirectUrlXPathQuery)

setContentTypeXPathQuery

public void setContentTypeXPathQuery(String contentTypeXPathQuery)

setRedirectContentType

public void setRedirectContentType(String redirectContentType)

setDisabledXPathQuery

public void setDisabledXPathQuery(String disabledXPathQuery)

setMimeTypeXPathQuery

public void setMimeTypeXPathQuery(String mimeTypeXPathQuery)

setScriptResolver

public void setScriptResolver(ScriptResolver scriptResolver)

setForceHttpsXPathQuery

public void setForceHttpsXPathQuery(String forceHttpsXPathQuery)

setDelegatedViewResolver

public void setDelegatedViewResolver(org.springframework.web.servlet.ViewResolver delegatedViewResolver)

setLocalizeViews

public void setLocalizeViews(boolean localizeViews)

setUserAgentTemplateDetector

public void setUserAgentTemplateDetector(UserAgentTemplateDetector userAgentTemplateDetector)

setAccessManager

public void setAccessManager(CrafterPageAccessManager accessManager)

setScriptFactory

public void setScriptFactory(ScriptFactory scriptFactory)

resolveViewName

public org.springframework.web.servlet.View resolveViewName(String viewName,
                                                   Locale locale)
                                                     throws Exception

Specified by:

resolveViewName in interface org.springframework.web.servlet.ViewResolver

Throws:

Exception

getPage

protected SiteItem getPage(String url)

getLocalizedPage

protected SiteItem getLocalizedPage(String baseUrl,
                        Locale locale)

getRedirectView

protected org.springframework.web.servlet.View getRedirectView(String redirectUrl,
                                                   boolean relative)

getCurrentPageHttpsRedirectView

protected org.springframework.web.servlet.View getCurrentPageHttpsRedirectView()

getCachedLocalizedView

protected org.springframework.web.servlet.View getCachedLocalizedView(String baseUrl,
                                                          Locale locale)

loadScripts

protected void loadScripts(SiteItem page,
               CrafterPageView view)

applyLifecycleMethods

protected org.springframework.web.servlet.View applyLifecycleMethods(String viewName,
                                                         org.springframework.web.servlet.View view)