org.glassfish.jersey.server.mvc.freemarker

Class FreemarkerMvcFeature

java.lang.Object

org.glassfish.jersey.server.mvc.freemarker.FreemarkerMvcFeature

All Implemented Interfaces:

javax.ws.rs.core.Feature

@ConstrainedTo(value=SERVER)
public final class FreemarkerMvcFeature
extends Object
implements javax.ws.rs.core.Feature

Feature used to add support for MVC and Freemarker templates.

Note: This feature also registers MvcFeature.

Author:

Michal Gajdos (michal.gajdos at oracle.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_TEMPLATES If true then enable caching of Freemarker templates to avoid multiple compilation.
static String	TEMPLATE_OBJECT_FACTORY Property used to pass user-configured configuration able to create Freemarker templates.
static String	TEMPLATES_BASE_PATH String property defining the base path to Freemarker templates.

Constructor Summary

Constructors

Constructor and Description
FreemarkerMvcFeature()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure(javax.ws.rs.core.FeatureContext context)

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATES_BASE_PATH

public static final String TEMPLATES_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:

• Viewable
• Template, or
• ErrorTemplate

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 configuration able to create Freemarker templates.

The default value is not set.

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

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.

Since:

2.5

See Also:

Constant Field Values

Constructor Detail

FreemarkerMvcFeature

public FreemarkerMvcFeature()

Method Detail

configure

public boolean configure(javax.ws.rs.core.FeatureContext context)

Specified by:

configure in interface javax.ws.rs.core.Feature