org.jahia.services.render

Class RenderContext

java.lang.Object

org.jahia.services.render.RenderContext

public class RenderContext
extends Object

Template rendering context with the information about current request/response pair and optional template parameters.

Author:

toto

Constructor Summary

Constructors

Constructor and Description
RenderContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, JahiaUser user)

Method Summary

Modifier and Type	Method and Description
Resource	getAjaxResource()
Channel	getChannel() Returns the currently active channel
String	getContentType()
Set<String>	getDisplayedModules()
EditConfiguration	getEditModeConfig()
String	getEditModeConfigName()
Locale	getFallbackLocale()
Resource	getMainResource()
Locale	getMainResourceLocale()
String	getMode()
ReadOnlyModeController.ReadOnlyModeStatus	getReadOnlyStatus() Get current read-only mode status.
String	getRedirect()
Set<String>	getRenderedPaths()
javax.servlet.http.HttpServletRequest	getRequest()
Stack<Resource>	getResourcesStack()
javax.servlet.http.HttpServletResponse	getResponse()
String	getServletPath()
SettingsBean	getSettings()
JCRSiteNode	getSite()
SiteInfo	getSiteInfo()
Map<String,Map<String,Integer>>	getTemplatesCacheExpiration()
Locale	getUILocale()
URLGenerator	getURLGenerator()
JahiaUser	getUser()
String	getWorkspace()
boolean	isAjaxRequest()
boolean	isContributionMode()
boolean	isEditable(JCRNodeWrapper node)
boolean	isEditMode()
boolean	isEnterpriseEdition()
boolean	isForceUILocaleForJCRSession()
boolean	isLiveMode()
boolean	isLoggedIn()
boolean	isPortletActionRequest()
boolean	isPreviewMode()
boolean	isReadOnly()
boolean	isUgcEnabled()
boolean	isVisible(JCRNodeWrapper node)
void	setAjaxRequest(boolean ajaxRequest)
void	setAjaxResource(Resource ajaxResource)
void	setChannel(Channel channel) Sets the currently active channel.
void	setContentType(String contentType)
void	setContributionMode(boolean contributionMode)
void	setEditMode(boolean editMode)
void	setEditModeConfig(EditConfiguration editModeConfig)
void	setForceUILocaleForJCRSession(boolean forceUILocaleForJCRSession)
void	setMainResource(Resource mainResource)
void	setPortletActionRequest(boolean portletActionRequest)
void	setRedirect(String redirect)
void	setResponse(javax.servlet.http.HttpServletResponse response)
void	setServletPath(String servletPath)
void	setSite(JCRSiteNode site)
void	setSiteInfo(SiteInfo siteInfo)
void	setUgcEnabled(boolean ugcEnabled)
void	setURLGenerator(URLGenerator URLGenerator)
void	setWorkspace(String workspace)

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderContext

public RenderContext(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     JahiaUser user)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

getUser

public JahiaUser getUser()

getSite

public JCRSiteNode getSite()

setSite

public void setSite(JCRSiteNode site)

getURLGenerator

public URLGenerator getURLGenerator()

setURLGenerator

public void setURLGenerator(URLGenerator URLGenerator)

getDisplayedModules

public Set<String> getDisplayedModules()

isEditMode

public boolean isEditMode()

setEditMode

public void setEditMode(boolean editMode)

getMode

public String getMode()

getEditModeConfigName

public String getEditModeConfigName()

getEditModeConfig

public EditConfiguration getEditModeConfig()

setEditModeConfig

public void setEditModeConfig(EditConfiguration editModeConfig)

getServletPath

public String getServletPath()

setServletPath

public void setServletPath(String servletPath)

getWorkspace

public String getWorkspace()

setWorkspace

public void setWorkspace(String workspace)

isContributionMode

public boolean isContributionMode()

setContributionMode

public void setContributionMode(boolean contributionMode)

isLoggedIn

public boolean isLoggedIn()

getTemplatesCacheExpiration

public Map<String,Map<String,Integer>> getTemplatesCacheExpiration()

setMainResource

public void setMainResource(Resource mainResource)

getMainResource

public Resource getMainResource()

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getRenderedPaths

public Set<String> getRenderedPaths()

getResourcesStack

public Stack<Resource> getResourcesStack()

getMainResourceLocale

public Locale getMainResourceLocale()

getUILocale

public Locale getUILocale()

getFallbackLocale

public Locale getFallbackLocale()

isLiveMode

public boolean isLiveMode()

isPreviewMode

public boolean isPreviewMode()

setAjaxRequest

public void setAjaxRequest(boolean ajaxRequest)

isAjaxRequest

public boolean isAjaxRequest()

setAjaxResource

public void setAjaxResource(Resource ajaxResource)

getAjaxResource

public Resource getAjaxResource()

getRedirect

public String getRedirect()

Returns:

the redirect

setRedirect

public void setRedirect(String redirect)

Parameters:

redirect - the redirect to set

isEnterpriseEdition

public boolean isEnterpriseEdition()

getSettings

public SettingsBean getSettings()

getChannel

public Channel getChannel()

Returns the currently active channel

Returns:

setChannel

public void setChannel(Channel channel)

Sets the currently active channel.

Parameters:

channel - a Channel containing the value for the currently active channel

isVisible

public boolean isVisible(JCRNodeWrapper node)
                  throws javax.jcr.RepositoryException

Parameters:

node - to check

Returns:

true if the node is visible (in visibleTypes or without nonVisibleTypes)

Throws:

javax.jcr.RepositoryException

isEditable

public boolean isEditable(JCRNodeWrapper node)
                   throws javax.jcr.RepositoryException

Parameters:

node - to check

Returns:

true if the node is editable (in editableTypes or without nonEditableTypes)

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

setSiteInfo

public void setSiteInfo(SiteInfo siteInfo)

getSiteInfo

public SiteInfo getSiteInfo()

setForceUILocaleForJCRSession

public void setForceUILocaleForJCRSession(boolean forceUILocaleForJCRSession)

isForceUILocaleForJCRSession

public boolean isForceUILocaleForJCRSession()

isPortletActionRequest

public boolean isPortletActionRequest()

setPortletActionRequest

public void setPortletActionRequest(boolean portletActionRequest)

isUgcEnabled

public boolean isUgcEnabled()

setUgcEnabled

public void setUgcEnabled(boolean ugcEnabled)

getReadOnlyStatus

public ReadOnlyModeController.ReadOnlyModeStatus getReadOnlyStatus()

Get current read-only mode status.

Returns:

Current read-only mode status

isReadOnly

public boolean isReadOnly()

Returns:

Whether the application is in read only mode, dependent on read only, full read only, and maintenance status currently activated/deactivated.