Package org.apache.juneau.rest.server.view.freemarker

package org.apache.juneau.rest.server.view.freemarker

Apache FreeMarker view-rendering bridge — opt-in juneau-rest-server-view-freemarker module.

Provides three sibling pieces that together let a Juneau REST resource render Apache FreeMarker templates:

• FreemarkerMixin — mixin that renders raw FreeMarker templates from the importer's classpath under /freemarker/* and auto-registers FreemarkerViewRenderer.
• FreemarkerView — immutable value class (implements the core View interface) returned from @RestOp methods to ask the framework to render a FreeMarker template.
• FreemarkerViewRenderer — ResponseProcessor that detects FreemarkerView returns and dispatches them to the configured Configuration via cfg.getTemplate(templateName).process(dataModel, writer).

Composition example (microservice):

@Rest(path="/app", mixins=FreemarkerMixin.class) public class AppResource extends RestServlet { @Bean FreemarkerMixin freemarker() { return FreemarkerMixin.create() .basePath("/templates/") .templateSuffix(".ftlh") .build(); } @RestGet("/hello/{name}") public View hello(@Path String name) { return FreemarkerView.of("hello").attr("name", name); } }

Engine-agnostic packaging:

The bridge module's main POM declares only org.freemarker:freemarker in provided scope — no concrete FreeMarker transitive dep ships here. Consumers add the engine matching their deployment:

• Juneau microservice / Jetty: add org.freemarker:freemarker. With no user-supplied configuration bean, the bridge builds a default Configuration on first request anchored on the importer's classpath under the configured base path.
• Spring Boot: add spring-boot-starter-freemarker. Spring Boot autoconfigures a freemarker.template.Configuration bean which the bridge picks up automatically via BeanStore.getBean(Configuration.class) — no further wiring required.
• Custom: register your own @Bean freemarker.template.Configuration with whatever loaders / encodings / output formats / template-update policies you need.

When no FreeMarker engine is on the classpath, the renderer surfaces a clear diagnostic naming the missing dependency and linking to the "Choosing a Configuration" matrix in FreemarkerViewSupport.md.

.ftl vs .ftlh:

FreeMarker auto-selects HTML escaping by file extension: .ftlh templates emit HTML-escaped output, while .ftl templates emit raw output. For HTML responses, prefer .ftlh so a future attribute-binding change can't introduce an XSS regression.

See Also:

• View
• FreeMarker View Support
• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.rest.server.view	Engine-agnostic server-side-rendered view extension point.
org.apache.juneau.rest.server.view.jsp	JSP view-rendering bridge — opt-in juneau-rest-server-view-jsp module.
org.apache.juneau.rest.server.view.mustache	Mustache view-rendering bridge — opt-in juneau-rest-server-view-mustache module.
org.apache.juneau.rest.server.view.thymeleaf	Thymeleaf view-rendering bridge — opt-in juneau-rest-server-view-thymeleaf module.

Class	Description
FreemarkerDispatcher	Flavor-neutral worker bean carrying the FreeMarker raw-template-dispatch logic shared by the FreemarkerMixin mixin, the FreemarkerServlet servlet, and the FreemarkerResource child flavors.
FreemarkerDispatcher.Builder	Builder for FreemarkerDispatcher.
FreemarkerMixin	Mixin that wires Apache FreeMarker view-rendering onto any Juneau REST resource.
FreemarkerMixin.Builder	Builder for FreemarkerMixin.
FreemarkerRenderScope	Request-scoped handle so FreeMarker TemplateDirectiveModels can resolve per-request asset URLs during template.process.
FreemarkerResource	Child-resource flavor of the FreemarkerMixin mixin.
FreemarkerServlet	Standalone servlet companion of the FreemarkerMixin mixin.
FreemarkerView	Immutable value class returned from @RestOp-annotated methods to ask the framework to render an Apache FreeMarker template.
FreemarkerView.MustConsume	Marker for an attribute value that promises to be adopted during the render (unwrapped from the data model by some directive and applied to render-scoped state), and wants the render to fail if that never happens instead of silently behaving as if the attribute was absent.
FreemarkerViewRenderer	ResponseProcessor that detects FreemarkerView-typed return values and asks the configured Configuration to render them directly onto the response writer.