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

Class ViewResource

java.lang.Object

org.apache.juneau.rest.server.servlet.RestResource

org.apache.juneau.rest.server.view.ViewResource

Direct Known Subclasses:

FreemarkerResource, JspResource, MustacheResource, ThymeleafResource

public abstract class ViewResource
extends RestResource

Abstract base for the child-resource flavors of the view mixin resources.

Mirror of ViewServlet for routed-child deployment: each per-engine bridge module ships a thin <Engine>Resource subclass that declares its own subtree mount via @Rest(path) (e.g. "/jsp") and supplies the per-engine RawTemplateDispatcher (the matching flavor-neutral <Engine>Dispatcher worker) via dispatcher().

The single greedy op declared here (@RestGet(path="/*")) captures the trailing remainder under the child's subtree mount and delegates straight to the shared RawTemplateDispatcher, so the mixin, servlet, and child forms cannot drift.

See Also:

• RawTemplateDispatcher
• ViewServlet
• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestResource

RestResource.Builder<R extends RestResource,SELF extends RestResource.Builder<R,SELF>>, RestResource.DefaultBuilder<R extends RestResource>

Constructor Summary

Constructors

Constructor	Description
ViewResource()

Method Summary

Modifier and Type	Method	Description
protected abstract RawTemplateDispatcher	dispatcher()	Returns the per-engine RawTemplateDispatcher this child delegates raw template dispatch to.
void	render(String path, RestRequest req, RestResponse res)	[GET /*] — render the raw template identified by the trailing path under this child's subtree mount.

Methods inherited from class org.apache.juneau.rest.server.servlet.RestResource

builder, doLog, getContext, getPaths, getRequest, getResponse, getRestBuilder, log, log, setContext

Methods inherited from class java.lang.Object

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

Constructor Details

ViewResource

public ViewResource()

Method Details

dispatcher

protected abstract RawTemplateDispatcher dispatcher()

Returns the per-engine RawTemplateDispatcher this child delegates raw template dispatch to.

Typically the matching flavor-neutral <Engine>Dispatcher worker (which implements RawTemplateDispatcher). Never null.

Returns:

The raw-template dispatcher. Never null.

render

public void render(@Path("/*")
 String path,
 RestRequest req,
 RestResponse res)
            throws IOException

[GET /*] — render the raw template identified by the trailing path under this child's subtree mount.

Parameters:

path - The trailing path segment after the mount prefix.

req - The current REST request.

res - The current REST response.

Throws:

IOException - If the underlying response writer fails.