org.jahia.bin

Class Render

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.jahia.bin.Render

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.springframework.beans.factory.Aware, org.springframework.web.context.ServletConfigAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

Dashboard, Edit

public class Render
extends javax.servlet.http.HttpServlet
implements org.springframework.web.servlet.mvc.Controller, org.springframework.web.context.ServletConfigAware

Rendering controller. Resolves the node and the template, and renders it by executing the appropriate script.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS_USER
static String	ALLOWS_MULTIPLE_SUBMITS
static String	AUTO_ASSIGN_ROLE
static String	AUTO_CHECKIN
static String	CAPTCHA
static String	CONTRIBUTE_POST
static String	COOKIE_NAME
static String	COOKIE_PATH
static String	COOKIE_VALUE
static String	DISABLE_XSS_FILTERING
static List<String>	EVENT_ATTRIBUTE_NAMES
protected static String	HEADER_IFMODSINCE
protected static String	HEADER_LASTMOD
static String	MARK_FOR_DELETION
static String	MARK_FOR_DELETION_MESSAGE
static String	METHOD_DELETE
static String	METHOD_GET
static String	METHOD_HEAD
static String	METHOD_OPTIONS
static String	METHOD_POST
static String	METHOD_PUT
static String	METHOD_TO_CALL
static String	METHOD_TRACE
static String	NEW_NODE_OUTPUT_FORMAT
static String	NODE_NAME
static String	NODE_NAME_PROPERTY
static String	NODE_TYPE
static String	NORMALIZE_NODE_NAME
static String	PARENT_TYPE
static String	PLUTO_ACTION
static String	PLUTO_PREFIX
static String	PLUTO_RESOURCE
static String	PREVIEW_DATE
static String	REDIRECT_HTTP_RESPONSE_CODE
static String	REDIRECT_TO
static String	REMOVE_MIXIN
protected static Set<String>	RESERVED_PARAMETERS
static String	RESOURCE_ID
static String	RETURN_CONTENTTYPE
static String	RETURN_CONTENTTYPE_OVERRIDE
static String	SUBMIT
static Pattern	TAG_MISSING_END_BIGGERTHAN_PATTERN
static Pattern	TAG_MISSING_START_LESSERTHAN_PATTERN
static String	TARGETDIRECTORY
static String	TARGETNAME
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
Render()

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
static void	checkActionRequirements(Action action, RenderContext renderContext, URLResolver urlResolver) Performs all required checks for this action.
protected RenderContext	createRenderContext(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JahiaUser user)
protected void	doDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, RenderContext renderContext, URLResolver urlResolver)
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, RenderContext renderContext, Resource resource, long startTime)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, RenderContext renderContext, URLResolver urlResolver)
protected void	doPut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, RenderContext renderContext, URLResolver urlResolver)
String	getDefaultContentType(String templateType)
protected long	getLastModified(Resource resource, RenderContext renderContext) Returns the time the HttpServletRequest object was last modified, in milliseconds since midnight January 1, 1970 GMT.
static String	getRenderServletPath()
static Set<String>	getReservedParameters()
javax.servlet.ServletConfig	getServletConfig()
String	getServletName()
SettingsBean	getSettingsBean()
org.springframework.web.servlet.ModelAndView	handleRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected boolean	hasAccess(JCRNodeWrapper node)
protected boolean	isDisabled()
protected boolean	isInReadOnlyMode()
protected boolean	isMethodAllowed(String method)
boolean	isMultipartRequest(javax.servlet.http.HttpServletRequest req)
boolean	isPortletRequest(javax.servlet.http.HttpServletRequest req) If the request is a portlet request, it returns true, otherwise returns false.
static boolean	isWebflowRequest(javax.servlet.http.HttpServletRequest req)
protected void	maybeSetLastModified(javax.servlet.http.HttpServletResponse resp, long lastModified) Sets the Last-Modified entity header field, if it has not already been set and if the value is meaningful.
static void	performRedirect(String url, String path, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Map<String,List<String>> parameters, boolean bypassCache) This method allows you to define where you want to redirect the user after request.
static org.json.JSONObject	serializeNodeToJSON(JCRNodeWrapper node)
void	setAllowedMethods(Set<String> allowedMethods) Specifies the set of allowed HTTP methods.
void	setCookieExpirationInDays(Integer cookieExpirationInDays)
void	setDefaultContentType(Map<String,String> defaultContentType)
void	setDefaultPostAction(Action defaultPostActionResult)
void	setDefaultPutAction(Action defaultPutActionResult)
void	setJcrSessionFactory(JCRSessionFactory jcrSessionFactory)
void	setLoggingService(MetricsLoggingService loggingService)
void	setRenderService(RenderService renderService)
void	setServletConfig(javax.servlet.ServletConfig servletConfig)
void	setSessionExpiryTime(int sessionExpiryTime)
void	setSettingsBean(SettingsBean settingsBean)
void	setTemplateService(JahiaTemplateManagerService templateService)
void	setUrlResolverFactory(URLResolverFactory urlResolverFactory)
void	setWebflowAction(Action webflowAction)
void	setWorkspace(String workspace)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletContext, getServletInfo, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_DELETE

public static final String METHOD_DELETE

See Also:

Constant Field Values

METHOD_HEAD

public static final String METHOD_HEAD

See Also:

Constant Field Values

METHOD_GET

public static final String METHOD_GET

See Also:

Constant Field Values

METHOD_OPTIONS

public static final String METHOD_OPTIONS

See Also:

Constant Field Values

METHOD_POST

public static final String METHOD_POST

See Also:

Constant Field Values

METHOD_PUT

public static final String METHOD_PUT

See Also:

Constant Field Values

METHOD_TRACE

public static final String METHOD_TRACE

See Also:

Constant Field Values

HEADER_IFMODSINCE

protected static final String HEADER_IFMODSINCE

See Also:

Constant Field Values

HEADER_LASTMOD

protected static final String HEADER_LASTMOD

See Also:

Constant Field Values

NODE_TYPE

public static final String NODE_TYPE

See Also:

Constant Field Values

NODE_NAME

public static final String NODE_NAME

See Also:

Constant Field Values

NODE_NAME_PROPERTY

public static final String NODE_NAME_PROPERTY

See Also:

Constant Field Values

NEW_NODE_OUTPUT_FORMAT

public static final String NEW_NODE_OUTPUT_FORMAT

See Also:

Constant Field Values

REDIRECT_TO

public static final String REDIRECT_TO

See Also:

Constant Field Values

REDIRECT_HTTP_RESPONSE_CODE

public static final String REDIRECT_HTTP_RESPONSE_CODE

See Also:

Constant Field Values

METHOD_TO_CALL

public static final String METHOD_TO_CALL

See Also:

Constant Field Values

AUTO_CHECKIN

public static final String AUTO_CHECKIN

See Also:

Constant Field Values

CAPTCHA

public static final String CAPTCHA

See Also:

Constant Field Values

TARGETDIRECTORY

public static final String TARGETDIRECTORY

See Also:

Constant Field Values

TARGETNAME

public static final String TARGETNAME

See Also:

Constant Field Values

NORMALIZE_NODE_NAME

public static final String NORMALIZE_NODE_NAME

See Also:

Constant Field Values

VERSION

public static final String VERSION

See Also:

Constant Field Values

SUBMIT

public static final String SUBMIT

See Also:

Constant Field Values

AUTO_ASSIGN_ROLE

public static final String AUTO_ASSIGN_ROLE

See Also:

Constant Field Values

ALIAS_USER

public static final String ALIAS_USER

See Also:

Constant Field Values

PARENT_TYPE

public static final String PARENT_TYPE

See Also:

Constant Field Values

RETURN_CONTENTTYPE

public static final String RETURN_CONTENTTYPE

See Also:

Constant Field Values

RETURN_CONTENTTYPE_OVERRIDE

public static final String RETURN_CONTENTTYPE_OVERRIDE

See Also:

Constant Field Values

RESOURCE_ID

public static final String RESOURCE_ID

See Also:

Constant Field Values

REMOVE_MIXIN

public static final String REMOVE_MIXIN

See Also:

Constant Field Values

COOKIE_VALUE

public static final String COOKIE_VALUE

See Also:

Constant Field Values

COOKIE_NAME

public static final String COOKIE_NAME

See Also:

Constant Field Values

COOKIE_PATH

public static final String COOKIE_PATH

See Also:

Constant Field Values

CONTRIBUTE_POST

public static final String CONTRIBUTE_POST

See Also:

Constant Field Values

MARK_FOR_DELETION

public static final String MARK_FOR_DELETION

See Also:

Constant Field Values

MARK_FOR_DELETION_MESSAGE

public static final String MARK_FOR_DELETION_MESSAGE

See Also:

Constant Field Values

PREVIEW_DATE

public static final String PREVIEW_DATE

See Also:

Constant Field Values

DISABLE_XSS_FILTERING

public static final String DISABLE_XSS_FILTERING

See Also:

Constant Field Values

EVENT_ATTRIBUTE_NAMES

public static final List<String> EVENT_ATTRIBUTE_NAMES

TAG_MISSING_END_BIGGERTHAN_PATTERN

public static final Pattern TAG_MISSING_END_BIGGERTHAN_PATTERN

TAG_MISSING_START_LESSERTHAN_PATTERN

public static final Pattern TAG_MISSING_START_LESSERTHAN_PATTERN

ALLOWS_MULTIPLE_SUBMITS

public static final String ALLOWS_MULTIPLE_SUBMITS

See Also:

Constant Field Values

PLUTO_PREFIX

public static final String PLUTO_PREFIX

See Also:

Constant Field Values

PLUTO_ACTION

public static final String PLUTO_ACTION

See Also:

Constant Field Values

PLUTO_RESOURCE

public static final String PLUTO_RESOURCE

See Also:

Constant Field Values

RESERVED_PARAMETERS

protected static final Set<String> RESERVED_PARAMETERS

Constructor Detail

Render

public Render()

Method Detail

getLastModified

protected long getLastModified(Resource resource,
                               RenderContext renderContext)
                        throws javax.jcr.RepositoryException,
                               IOException

Returns the time the HttpServletRequest object was last modified, in milliseconds since midnight January 1, 1970 GMT. If the time is unknown, this method returns a negative number (the default).

Servlets that support HTTP GET requests and can quickly determine their last modification time should override this method. This makes browser and proxy caches work more effectively, reducing the load on server and network resources.

Returns:

a long integer specifying the time the HttpServletRequest object was last modified, in milliseconds since midnight, January 1, 1970 GMT, or -1 if the time is not known

Throws:

javax.jcr.RepositoryException

IOException

maybeSetLastModified

protected void maybeSetLastModified(javax.servlet.http.HttpServletResponse resp,
                                    long lastModified)

Sets the Last-Modified entity header field, if it has not already been set and if the value is meaningful. Called before doGet, to ensure that headers are set before response data is written. A subclass might have set this header already, so we check.

createRenderContext

protected RenderContext createRenderContext(javax.servlet.http.HttpServletRequest req,
                                            javax.servlet.http.HttpServletResponse resp,
                                            JahiaUser user)

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp,
                     RenderContext renderContext,
                     Resource resource,
                     long startTime)
              throws javax.jcr.RepositoryException,
                     RenderException,
                     IOException

Throws:

javax.jcr.RepositoryException

RenderException

IOException

doPut

protected void doPut(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp,
                     RenderContext renderContext,
                     URLResolver urlResolver)
              throws Exception

Throws:

Exception

addCookie

public void addCookie(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse resp)

serializeNodeToJSON

public static org.json.JSONObject serializeNodeToJSON(JCRNodeWrapper node)
                                               throws javax.jcr.RepositoryException,
                                                      IOException,
                                                      org.json.JSONException

Throws:

javax.jcr.RepositoryException

IOException

org.json.JSONException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse resp,
                      RenderContext renderContext,
                      URLResolver urlResolver)
               throws Exception

Throws:

Exception

doDelete

protected void doDelete(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse resp,
                        RenderContext renderContext,
                        URLResolver urlResolver)
                 throws Exception

Throws:

Exception

isMultipartRequest

public boolean isMultipartRequest(javax.servlet.http.HttpServletRequest req)

isPortletRequest

public boolean isPortletRequest(javax.servlet.http.HttpServletRequest req)

If the request is a portlet request, it returns true, otherwise returns false.

Parameters:

req - An HttpServletRequest.

Returns:

True if request is a portlet request.

performRedirect

public static void performRedirect(String url,
                                   String path,
                                   javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.http.HttpServletResponse resp,
                                   Map<String,List<String>> parameters,
                                   boolean bypassCache)
                            throws IOException

This method allows you to define where you want to redirect the user after request.

Parameters:

url -

path -

req -

resp -

parameters -

bypassCache - If true we will append a parameter to the URL that should match the id of the resource to refresh

Throws:

IOException

handleRequest

public org.springframework.web.servlet.ModelAndView handleRequest(javax.servlet.http.HttpServletRequest req,
                                                                  javax.servlet.http.HttpServletResponse resp)
                                                           throws Exception

Specified by:

handleRequest in interface org.springframework.web.servlet.mvc.Controller

Throws:

Exception

isWebflowRequest

public static boolean isWebflowRequest(javax.servlet.http.HttpServletRequest req)

isDisabled

protected boolean isDisabled()

isInReadOnlyMode

protected boolean isInReadOnlyMode()

checkActionRequirements

public static void checkActionRequirements(Action action,
                                           RenderContext renderContext,
                                           URLResolver urlResolver)
                                    throws javax.jcr.RepositoryException

Performs all required checks for this action.

Parameters:

action - the action to check requirements for

renderContext - current render context instance

urlResolver - the URL resolver instance

Throws:

javax.jcr.RepositoryException - in case of requirements violation

Since:

7.2.3.2

isMethodAllowed

protected boolean isMethodAllowed(String method)

hasAccess

protected boolean hasAccess(JCRNodeWrapper node)

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig servletConfig)

Specified by:

setServletConfig in interface org.springframework.web.context.ServletConfigAware

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Specified by:

getServletConfig in interface javax.servlet.Servlet

Overrides:

getServletConfig in class javax.servlet.GenericServlet

getServletName

public String getServletName()

Specified by:

getServletName in interface javax.servlet.ServletConfig

Overrides:

getServletName in class javax.servlet.GenericServlet

getRenderServletPath

public static String getRenderServletPath()

setWorkspace

public void setWorkspace(String workspace)

setLoggingService

public void setLoggingService(MetricsLoggingService loggingService)

setTemplateService

public void setTemplateService(JahiaTemplateManagerService templateService)

setSessionExpiryTime

public void setSessionExpiryTime(int sessionExpiryTime)

setDefaultPostAction

public void setDefaultPostAction(Action defaultPostActionResult)

setDefaultPutAction

public void setDefaultPutAction(Action defaultPutActionResult)

setWebflowAction

public void setWebflowAction(Action webflowAction)

getReservedParameters

public static Set<String> getReservedParameters()

setSettingsBean

public void setSettingsBean(SettingsBean settingsBean)

Parameters:

settingsBean - the settingsBean to set

setRenderService

public void setRenderService(RenderService renderService)

Parameters:

renderService - the renderService to set

setJcrSessionFactory

public void setJcrSessionFactory(JCRSessionFactory jcrSessionFactory)

Parameters:

jcrSessionFactory - the jcrSessionFactory to set

setCookieExpirationInDays

public void setCookieExpirationInDays(Integer cookieExpirationInDays)

setUrlResolverFactory

public void setUrlResolverFactory(URLResolverFactory urlResolverFactory)

setAllowedMethods

public void setAllowedMethods(Set<String> allowedMethods)

Specifies the set of allowed HTTP methods.

Parameters:

allowedMethods - the set of allowed HTTP methods

getDefaultContentType

public String getDefaultContentType(String templateType)

setDefaultContentType

public void setDefaultContentType(Map<String,String> defaultContentType)

getSettingsBean

public SettingsBean getSettingsBean()