Renderers

This page explains the concept of renderers, how to configure them and which renderers Magnolia provides out of the box.

A renderer produces output such as HTML or text based on the template definition, the template script and JCR content. 

In summary, a renderer does the following things:

• Creates the model.
• Gets context objects.
• Executes template scripts.

The rendering process is executed by the RenderingFilter. The result of the renderer is written to the ServletOutputStream and sent to the browser. For further details see Rendering content.

Magnolia provides the following renderers out of the box: 

• FreemarkerRenderer
• JspRenderer
• SiteAwareRendererWrapper 

You can also implement your own custom renderer. To use a renderer, you must configure it either using YAML or in the JCR configuration workspace.

Configuring a renderer

To make a renderer available, you must configure it in the renderers folder of any module either using YAML, or in the JCR configuration workspace.

Once configured, you can:

• Decorate the renderer definition.
• Reuse the renderer definition as a base for a new renderer using YAML inherit.
• Use the YAML include directive if the definition is YAML based.

View your renderer definitions in the Definitions app.

Example:

class: info.magnolia.rendering.renderer.FreemarkerRenderer
contextAttributes:
  cms:
    componentClass: info.magnolia.templating.freemarker.Directives
    name: cms
  cmsfn:
    componentClass: info.magnolia.templating.functions.TemplatingFunctions
    name: cmsfn

Properties:

title: test-page
templateScript: /test-custom-renderers/templates/pages/test-page.ftl
renderType: foobar

Renderers provided by Magnolia

Magnolia provides a number of renderers out-of-the-box. 

Note that magnolia-rendering is available in every preconfigured Magnolia bundle or webapp, whereas  magnolia-site is available in every preconfigured Magnolia bundle or webapp except magnolia-empty-webapp.

Freemarker renderer

The freemarker renderer is used to render pages relying on templates with freemarker-based template scripts. The freemarker renderer can be considered as the standard Magnolia renderer. It is also the base for the site aware renderer.

The implementation class is FreemarkerRenderer. 

freemarker:
  class: info.magnolia.rendering.renderer.FreemarkerRenderer
  contextAttributes:
    cms:
      componentClass: info.magnolia.templating.freemarker.Directives
      name: cms
    cmsfn:
      componentClass: info.magnolia.templating.functions.TemplatingFunctions
      name: cmsfn
    imgfn:
      componentClass: info.magnolia.imaging.functions.ImagingTemplatingFunctions
      name: imgfn
    peekfn:
      componentClass: info.magnolia.unfurl.functions.PeekFunctions
      name: peekfn
    resfn:
      componentClass: info.magnolia.modules.resources.templating.ResourcesTemplatingFunctions
      name: resfn
    sitefn:
      componentClass: info.magnolia.module.site.functions.SiteFunctions
      name: sitefn
    damfn:
      componentClass: info.magnolia.dam.templating.functions.DamTemplatingFunctions
      name: damfn
    restfn:
      componentClass: info.magnolia.rest.client.templating.RestTemplatingFunctions
      name: restfn
    ecomfn:
      componentClass: info.magnolia.ecommerce.templating.EcommerceTemplatingFunctions
    searchfn:
      componentClass: info.magnolia.templating.functions.SearchTemplatingFunctions
      name: searchfn
    navfn:
      componentClass: info.magnolia.templating.functions.NavigationTemplatingFunctions
      name: navfn
    catfn:
      componentClass: info.magnolia.module.categorization.functions.CategorizationTemplatingFunctions
      name: catfn
    tourfn:
      componentClass: info.magnolia.demo.travel.tours.TourTemplatingFunctions
      name: tourfn

Freemarker exception handling

Freemarker exceptions render differently on the author and public instances. On author, Freemarker exceptions show the stack trace in a yellow block with red text, and on public errors are hidden and logged.

This behavior is controlled by ModeDependentTemplateExceptionHandler registered in /server/rendering/freemarker/templateExceptionHandler. You can extend this class to fine-grain behavior.

FreeMarker security

Magnolia extends FreeMarker's DefaultMemberAccessPolicy with a configurable list of blacklisted classes.
If you want to add more classes to the default configuration, import this YAML bootstrap file into configuration:/server/rendering/freemarker/ and add your entries.

'memberAccessPolicy':
  'class': 'info.magnolia.freemarker.models.ClassBlacklistMemberAccessPolicy'
  'blacklistedClasses':
    'javax.servlet.ServletContext':
      'className': 'javax.servlet.ServletContext'
    'javax.security.auth.Subject':
      'className': 'javax.security.auth.Subject'
    'javax.jcr.Repository':
      'className': 'javax.jcr.Repository'
    'org.apache.jackrabbit.core.data.DataStoreFactory':
      'className': 'org.apache.jackrabbit.core.data.DataStoreFactory'
    'org.apache.jackrabbit.core.RepositoryContext':
      'className': 'org.apache.jackrabbit.core.RepositoryContext'
    'org.apache.jackrabbit.core.fs.FileSystemFactory':
      'className': 'org.apache.jackrabbit.core.fs.FileSystemFactory'
    'org.apache.jackrabbit.core.data.DataStoreFactory2':
      'className': 'org.apache.jackrabbit.core.data.DataStoreFactory'
    'org.apache.jackrabbit.core.query.QueryHandlerFactory':
      'className': 'org.apache.jackrabbit.core.query.QueryHandlerFactory'
    'org.apache.jackrabbit.core.util.db.ConnectionFactory':
      'className': 'org.apache.jackrabbit.core.util.db.ConnectionFactory'
    'javax.servlet.http.HttpSessionBindingListener':
      'className': 'javax.servlet.http.HttpSessionBindingListener'

You can also implement your own freemarker.ext.beans.MemberAccessPolicy.

JSP renderer

Use this renderer if your template scripts are written in JSP. The implementation class is JspRenderer.

Site aware renderers

A site aware renderer resolves the site definition related to the given request, and it merges the template definition of the requested page with the template prototype from the site definition.

The  magnolia-site module adds the  sitefn  context attribute to the freemarker renderer configuration, and it configures two site aware renderers at /modules/site/renderers:

• site
• site-jsp

Site aware renderers are implemented by the class SiteAwareRendererWrapper. It is a wrapper that relies on another already existing renderer. It comes with the property wrappedRendererType, which must be configured. The value of this property is the name of the wrapped renderer.

Others

The renderers described above are the most frequently used Magnolia renderers and cater to many use cases.

The following renderers are used for special cases.

Creating a custom renderer

To create your own renderer, extend AbstractRenderer. This convenience class supports typical functionality such as setting context attributes and executing a rendering model. It sets up the context by providing the following objects:

• content
• def
• state
• model
• actionResult

See mustache-rendering for a detailed example.