Package org.jgrapes.http.freemarker

Class FreeMarkerRequestHandler

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.http.freemarker.FreeMarkerRequestHandler

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class FreeMarkerRequestHandler
extends Component

A base class for components that generate responses to HTTP requests which are based on a FreeMarker template.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	TEMPLATE_PATTERN

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
FreeMarkerRequestHandler(Channel componentChannel, ClassLoader contentLoader, String contentPath, URI prefix)	Instantiates a new free marker request handler.
FreeMarkerRequestHandler(Channel componentChannel, HandlerDefinition.ChannelReplacements channelReplacements, ClassLoader contentLoader, String contentPath, URI prefix)	Instantiates a new free marker request handler.

Method Summary

Modifier and Type	Method	Description
protected MediaType	contentType(URI request)	Used to get the content type when generating a response with sendProcessedTemplate(Request.In, IOSubchannel, Template).
protected void	doRespond(Request.In event, IOSubchannel channel)	Removes the prefix specified in the constructor from the path in the request.
protected Map<String,Object>	fmSessionModel(Optional<Session> session)	Build a freemarker model holding the information usually found in the session.
protected freemarker.template.Configuration	freemarkerConfig()	Creates the configuration for freemarker template processing.
ResponseCreationSupport.MaxAgeCalculator	maxAgeCalculator()
URI	prefix()	Returns the prefix passed to the constructor.
ResourcePattern	prefixPattern()	Gets the prefix pattern.
protected ResourceBundle	resourceBundle(Locale locale)	Provides a resource bundle for localization.
protected boolean	sendProcessedTemplate(Request.In event, IOSubchannel channel, freemarker.template.Template tpl)	Render a response using the given template.
protected boolean	sendProcessedTemplate(Request.In event, IOSubchannel channel, String path)	Render a response using the template obtained from the config with Configuration.getTemplate(String) and the given path.
void	setMaxAgeCalculator(ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator)	Sets the ResponseCreationSupport.MaxAgeCalculator for generating the Cache-Control (max-age) header of the response.
protected void	updatePrefixPattern(ResourcePattern prefixPattern)	Updates the prefix pattern.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Field Details

TEMPLATE_PATTERN

public static final Pattern TEMPLATE_PATTERN

Constructor Details

FreeMarkerRequestHandler

public FreeMarkerRequestHandler(Channel componentChannel,
 HandlerDefinition.ChannelReplacements channelReplacements,
 ClassLoader contentLoader,
 String contentPath,
 URI prefix)

Instantiates a new free marker request handler.

The prefix path is removed from the request paths before resolving them against the content root. A prefix path must start with a slash and must end with a slash. If the request handler should respond to top-level requests, the prefix must be a single slash.

Parameters:

componentChannel - the component channel

channelReplacements - the channel replacements to apply to the channels elements of the Handler annotations

contentLoader - the content loader

contentPath - the content path

prefix - the prefix used in requests

FreeMarkerRequestHandler

public FreeMarkerRequestHandler(Channel componentChannel,
 ClassLoader contentLoader,
 String contentPath,
 URI prefix)

Instantiates a new free marker request handler.

The prefix path is removed from the request paths before resolving them against the content root. A prefix path must start with a slash and must end with a slash. If the request handler should respond to top-level requests, the prefix must be a single slash.

Parameters:

componentChannel - the component channel

contentLoader - the content loader

contentPath - the content path

prefix - the prefix used in requests

Method Details

prefix

public URI prefix()

Returns the prefix passed to the constructor.

Returns:

the prefix

prefixPattern

public ResourcePattern prefixPattern()

Gets the prefix pattern.

Returns:

the prefixPattern

updatePrefixPattern

protected void updatePrefixPattern(ResourcePattern prefixPattern)

Updates the prefix pattern.

The contructor initializes the prefix pattern to the prefix with “|**” appended (see ResourcePattern.

Parameters:

prefixPattern - the prefixPattern to set

maxAgeCalculator

public ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator()

Returns:

the maxAgeCalculator

setMaxAgeCalculator

public void setMaxAgeCalculator(ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator)

Sets the ResponseCreationSupport.MaxAgeCalculator for generating the Cache-Control (max-age) header of the response.

The default is null. This causes 0 to be provided for responses generated from templates and the ResponseCreationSupport.DEFAULT_MAX_AGE_CALCULATOR to be used for static content.

Parameters:

maxAgeCalculator - the maxAgeCalculator to set

doRespond

protected void doRespond(Request.In event,
 IOSubchannel channel)
                  throws ParseException

Removes the prefix specified in the constructor from the path in the request.

Checks if the resulting path
ends with *.ftl.*. If so, processes the template with the sendProcessedTemplate(Request.In, IOSubchannel, String) (which uses fmSessionModel(Optional)) and sends the result. Else, tries to serve static content with the optionally shortened path.

Parameters:

event - the event

channel - the channel

Throws:

ParseException - the parse exception

sendProcessedTemplate

protected boolean sendProcessedTemplate(Request.In event,
 IOSubchannel channel,
 freemarker.template.Template tpl)

Render a response using the given template.

Send the Response and at least one Output event.

If the method does not return true, the invoker should close the connection because it is most likely in an undefined state.

Parameters:

event - the request event

channel - the channel

tpl - the template

Returns:

false if an error occurred

sendProcessedTemplate

protected boolean sendProcessedTemplate(Request.In event,
 IOSubchannel channel,
 String path)

Render a response using the template obtained from the config with Configuration.getTemplate(String) and the given path.

Parameters:

event - the event

channel - the channel

path - the path

freemarkerConfig

protected freemarker.template.Configuration freemarkerConfig()

Creates the configuration for freemarker template processing.

Returns:

the configuration

fmSessionModel

protected Map<String,Object> fmSessionModel(Optional<Session> session)

Build a freemarker model holding the information usually found in the session.

Provides fallbacks in case no session is available.

This model provides:

• The locale (of type Locale) (falls back to Locale.getDefault().

• The resourceBundle (of type ResourceBundle) obtained by calling resourceBundle(Locale).

• A function “_” that looks up the given key in the resource bundle.

Parameters:

session - the session

Returns:

the model

contentType

protected MediaType contentType(URI request)

Used to get the content type when generating a response with sendProcessedTemplate(Request.In, IOSubchannel, Template).

May be overridden by derived classes. This implementation simply invokes HttpResponse.contentType(URI).

Parameters:

request - the request

Returns:

the content type

resourceBundle

protected ResourceBundle resourceBundle(Locale locale)

Provides a resource bundle for localization.

The default implementation looks up a bundle using the package name plus “l10n” as base name.

Returns:

the resource bundle