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

Class JspDispatcher

java.lang.Object

org.apache.juneau.rest.server.view.jsp.JspDispatcher

All Implemented Interfaces:

RawTemplateDispatcher

public class JspDispatcher
extends Object
implements RawTemplateDispatcher

Flavor-neutral worker bean carrying the JSP raw-template-dispatch logic shared by the JspMixin mixin, the JspServlet servlet, and the JspResource child flavors.

This is the flavor-neutral worker for the JSP capability: it is not one of the three @Rest flavor classes — it is a plain bean that implements RawTemplateDispatcher and holds the capability state (basePath) plus the raw-serve logic. Each flavor independently holds an instance of this worker and delegates to it, so no flavor is another flavor's worker.

See Also:

• JspMixin
• JspServlet
• JspResource
• RawTemplateDispatcher

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JspDispatcher.Builder	Builder for JspDispatcher.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BASE_PATH	Default base path applied when no JspDispatcher.Builder.basePath(String) call has been made.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JspDispatcher(JspDispatcher.Builder builder)	Builder constructor.

Method Summary

Modifier and Type	Method	Description
static JspDispatcher.Builder	create()	Creates a new builder.
String	getBasePath()	Returns the base path under which .jsp resources are resolved.
void	render(String path, RestRequest req, RestResponse res)	Forwards the request to the JSP engine for the raw .jsp resource at the trailing path.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BASE_PATH

public static final String DEFAULT_BASE_PATH

Default base path applied when no JspDispatcher.Builder.basePath(String) call has been made.

See Also:

• Constant Field Values

Constructor Details

JspDispatcher

protected JspDispatcher(JspDispatcher.Builder builder)

Builder constructor.

Parameters:

builder - The builder. Must not be null.

Method Details

create

public static JspDispatcher.Builder create()

Creates a new builder.

Returns:

A new builder.

getBasePath

public String getBasePath()

Returns the base path under which .jsp resources are resolved.

Returns:

The base path. Never null.

render

public void render(String path,
 RestRequest req,
 RestResponse res)
            throws IOException,
NotFound

Forwards the request to the JSP engine for the raw .jsp resource at the trailing path.

Specified by:

render in interface RawTemplateDispatcher

Parameters:

path - The trailing path segment after the mount prefix (the JSP file name relative to the configured base path).

req - The current REST request.

res - The current REST response.

Throws:

IOException - If the underlying servlet writer fails.

NotFound - If the JSP resource cannot be resolved.