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

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

Thymeleaf view-rendering bridge — opt-in juneau-rest-server-view-thymeleaf module.

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

• ThymeleafMixin — mixin that renders raw .html templates from the importer's classpath under /thymeleaf/* and auto-registers ThymeleafViewRenderer.
• ThymeleafView — immutable value class (implements the core View interface) returned from @RestOp methods to ask the framework to render a Thymeleaf template.
• ThymeleafViewRenderer — ResponseProcessor that detects ThymeleafView returns and dispatches them to the configured TemplateEngine via engine.process(templateName, context, writer).

Composition example (microservice):

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

Engine-agnostic packaging:

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

• Spring Boot: add org.springframework.boot:spring-boot-starter-thymeleaf — brings in thymeleaf + thymeleaf-spring6 + autoconfigured SpringTemplateEngine. The bridge picks the engine up automatically via BeanStore.getBean(TemplateEngine.class).
• Juneau microservice / Jetty: add org.thymeleaf:thymeleaf directly. With no user-supplied engine bean, the bridge builds a default TemplateEngine on first request anchored on the importer's classloader.
• Custom: register your own @Bean TemplateEngine with whatever resolvers, dialects, and template modes you need.

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

See Also:

• View
• Thymeleaf 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.freemarker	Apache FreeMarker view-rendering bridge — opt-in juneau-rest-server-view-freemarker module.
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.

Classes

Class	Description
ThymeleafDispatcher	Flavor-neutral worker bean carrying the Thymeleaf raw-template-dispatch logic shared by the ThymeleafMixin mixin, the ThymeleafServlet servlet, and the ThymeleafResource child flavors.
ThymeleafDispatcher.Builder	Builder for ThymeleafDispatcher.
ThymeleafMixin	Mixin that wires Thymeleaf view-rendering onto any Juneau REST resource.
ThymeleafMixin.Builder	Builder for ThymeleafMixin.
ThymeleafResource	Child-resource flavor of the ThymeleafMixin mixin.
ThymeleafServlet	Standalone servlet companion of the ThymeleafMixin mixin.
ThymeleafView	Immutable value class returned from @RestOp-annotated methods to ask the framework to render a Thymeleaf template.
ThymeleafViewRenderer	ResponseProcessor that detects ThymeleafView-typed return values and asks the configured TemplateEngine to render them directly onto the response writer.