Package org.glassfish.jersey.server.mvc.freemarker

Class FreemarkerMvcFeature

  • All Implemented Interfaces:
    Feature
    @ConstrainedTo(SERVER)
public final class FreemarkerMvcFeature
extends Object
implements Feature
    Feature used to add support for MVC and Freemarker templates.

    Note: This feature also registers MvcFeature.

    Author:
    Michal Gajdos, Jeff Wilde (jeff.wilde at complicatedrobot.com)

    • Field Detail

      • TEMPLATE_BASE_PATH

        public static final String TEMPLATE_BASE_PATH
        String property defining the base path to Freemarker templates. If set, the value of the property is added in front of the template name defined in:

        Value can be absolute providing a full path to a system directory with templates or relative to current servlet context.

        There is no default value.

        The name of the configuration property is "jersey.config.server.mvc.templateBasePath.freemarker".

        See Also:
        Constant Field Values

      • CACHE_TEMPLATES

        public static final String CACHE_TEMPLATES
        If true then enable caching of Freemarker templates to avoid multiple compilation.

        The default value is false.

        The name of the configuration property is "jersey.config.server.mvc.caching.freemarker".

        Since:
        2.5
        See Also:
        Constant Field Values

      • TEMPLATE_OBJECT_FACTORY

        public static final String TEMPLATE_OBJECT_FACTORY
        Property used to pass user-configured FreemarkerConfigurationFactory.

        The default value is not set.

        The name of the configuration property is "jersey.config.server.mvc.factory.freemarker".

        This property will also accept an instance of Configuration directly, to support backwards compatibility. If you want to set custom configuration then set template loader to multi loader of: WebappTemplateLoader (if applicable), ClassTemplateLoader and FileTemplateLoader keep functionality of resolving templates.

        If no value is set, a factory with the above behaviour is used by default in the FreemarkerViewProcessor class.

        Since:
        2.5
        See Also:
        Constant Field Values

      • ENCODING

        public static final String ENCODING
        Property defines output encoding produced by TemplateProcessor. The value must be a valid encoding defined that can be passed to the Charset.forName(String) method.

        The default value is UTF-8.

        The name of the configuration property is "jersey.config.server.mvc.encoding.freemarker".

        Since:
        2.7
        See Also:
        Constant Field Values

    • Constructor Detail

      • FreemarkerMvcFeature

        public FreemarkerMvcFeature()