Package org.jgrapes.webconsole.base.freemarker

Class FreeMarkerConlet<S>

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<S>

org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<S>

All Implemented Interfaces:

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

Direct Known Subclasses:

FormTestConlet, HelloWorldConlet, JmxBrowserConlet, LoginConlet, LoginConlet, LogViewerConlet, MarkdownDisplayConlet, MessageBoxConlet, StyleTestConlet, SysInfoConlet

public abstract class FreeMarkerConlet<S>
extends AbstractConlet<S>

Nested Class Summary

Nested classes/interfaces inherited from class org.jgrapes.webconsole.base.AbstractConlet

AbstractConlet.ConletTrackingInfo

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

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.webconsole.base.AbstractConlet

TYPE_INSTANCE_SEPARATOR

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
FreeMarkerConlet(Channel componentChannel)	Creates a new component that listens for new events on the given channel.
FreeMarkerConlet(Channel componentChannel, HandlerDefinition.ChannelReplacements channelReplacements)	Like FreeMarkerConlet(Channel), but supports the specification of channel replacements.

Method Summary

Modifier and Type	Method	Description
protected void	doGetResource(ConletResourceRequest event, IOSubchannel channel)	Checks if the path of the requested resource ends with *.ftl.*.
protected Map<String,Object>	fmConletModel(Event<?> event, IOSubchannel channel, String conletId, Object conletState)	Build a freemarker model for the current request.
protected Map<String,Object>	fmModel(NotifyConletModel event, ConsoleConnection channel, String conletId, Object conletState)	Build a freemarker model that combines fmTypeModel(org.jgrapes.webconsole.base.RenderSupport), fmSessionModel(org.jgrapes.http.Session) and fmConletModel(org.jgrapes.core.Event<?>, org.jgrapes.io.IOSubchannel, java.lang.String, java.lang.Object).
protected Map<String,Object>	fmModel(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Object conletState)	Build a freemarker model that combines fmTypeModel(org.jgrapes.webconsole.base.RenderSupport), fmSessionModel(org.jgrapes.http.Session) and fmConletModel(org.jgrapes.core.Event<?>, org.jgrapes.io.IOSubchannel, java.lang.String, java.lang.Object).
protected Map<String,Object>	fmSessionModel(Session session)	Build a freemarker model holding the information associated with the session.
protected Map<String,Object>	fmTypeModel(RenderSupport renderSupport)	Creates the request independent part of the freemarker model.
protected Configuration	freemarkerConfig()	Create the base freemarker configuration.
Future<String>	processTemplate(Event<?> request, Template template, Object dataModel)	Returns a future string providing the result from processing the given template with the given data.
Future<String>	processTemplate(RenderConletRequestBase<?> request, Template template, Object dataModel)	Returns a future string providing the result from processing the given template with the given data.

Methods inherited from class org.jgrapes.webconsole.base.AbstractConlet

afterOnClosed, conletIds, conletIdsByConsoleConnection, conletViews, createNewState, createStateRepresentation, doConletDeleted, doRemoveConletType, doRenderConlet, doSetLocale, doUpdateConletState, generateInstanceId, l10nBundles, localizations, onAddConletRequest, onClosed, onConletDeleted, onConletResourceRequest, onDetached, onNotifyConletModel, onRenderConletRequest, onSetLocale, putInSession, readContent, readContent, recreateState, removeState, resourceBundle, setPeriodicRefresh, stateFromSession, statesFromSession, supportedLocales, trackConlet, trackedConnections, type, typeFromId

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

Constructor Details

FreeMarkerConlet

public FreeMarkerConlet(Channel componentChannel)

Creates a new component that listens for new events on the given channel.

Parameters:

componentChannel -

FreeMarkerConlet

public FreeMarkerConlet(Channel componentChannel,
 HandlerDefinition.ChannelReplacements channelReplacements)

Like FreeMarkerConlet(Channel), but supports the specification of channel replacements.

Parameters:

componentChannel -

channelReplacements - the channel replacements (see Component)

Method Details

freemarkerConfig

protected Configuration freemarkerConfig()

Create the base freemarker configuration.

Returns:

the configuration

fmTypeModel

protected Map<String,Object> fmTypeModel(RenderSupport renderSupport)

Creates the request independent part of the freemarker model.

The result is cached as unmodifiable map as it can safely be assumed that the render support does not change for a given web console.

This model provides:

• The function conletResource that makes RenderSupport.conletResource(String, java.net.URI) available in the template. The first argument is set to the name of the web console component, only the second must be supplied when the function is invoked in a template.

Parameters:

renderSupport - the render support from the web console

Returns:

the result

fmSessionModel

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

Build a freemarker model holding the information associated with the session.

This model provides:

• The locale (of type Locale).
• The resourceBundle (of type ResourceBundle).
• A function _ that looks up the given key in the web console component’s resource bundle.
• A function supportedLanguages that returns a Map with language identifiers as keys and LanguageInfo instances as values (derived from AbstractConlet.supportedLocales()).

Parameters:

session - the session

Returns:

the model

fmConletModel

protected Map<String,Object> fmConletModel(Event<?> event,
 IOSubchannel channel,
 String conletId,
 Object conletState)

Build a freemarker model for the current request.

This model provides:

• The event property (of type RenderConletRequest).
• The conletType property (of type String).
• The conletId property (of type String).
• The conlet property with the conlet’s state (if not null).
• The function _Id(String base) that creates a unique id for an HTML element by appending the web console component id to the provided base.
• The conletProperties which are the properties from an AddConletRequest, or an empty map.

Parameters:

event - the event

channel - the channel

conletId - the conlet id

conletState - the conlet’s state information

Returns:

the model

fmModel

protected Map<String,Object> fmModel(RenderConletRequestBase<?> event,
 ConsoleConnection channel,
 String conletId,
 Object conletState)

Build a freemarker model that combines fmTypeModel(org.jgrapes.webconsole.base.RenderSupport), fmSessionModel(org.jgrapes.http.Session) and fmConletModel(org.jgrapes.core.Event<?>, org.jgrapes.io.IOSubchannel, java.lang.String, java.lang.Object).

Parameters:

event - the event

channel - the channel

conletId - the conlet id

conletState - the conlet’s state information

Returns:

the model

fmModel

protected Map<String,Object> fmModel(NotifyConletModel event,
 ConsoleConnection channel,
 String conletId,
 Object conletState)

Build a freemarker model that combines fmTypeModel(org.jgrapes.webconsole.base.RenderSupport), fmSessionModel(org.jgrapes.http.Session) and fmConletModel(org.jgrapes.core.Event<?>, org.jgrapes.io.IOSubchannel, java.lang.String, java.lang.Object).

Parameters:

event - the event

channel - the channel

conletId - the conlet id

conletState - the conlet’s state information

Returns:

the model

doGetResource

protected void doGetResource(ConletResourceRequest event,
 IOSubchannel channel)

Checks if the path of the requested resource ends with *.ftl.*.

If so, processes the template with the fmTypeModel(RenderSupport) and fmSessionModel(Session) and sends the result. Else, invoke the super class’ method.

Overrides:

doGetResource in class AbstractConlet<S>

Parameters:

event - the event. The result will be set to true on success

channel - the channel

processTemplate

public Future<String> processTemplate(RenderConletRequestBase<?> request,
 Template template,
 Object dataModel)

Returns a future string providing the result from processing the given template with the given data.

The method delegates to processTemplate(Event, Template, Object). The version with this signature is kept for backward compatibility.

Parameters:

request - the request, used to obtain the ExecutorService service related with the request being processed

template - the template

dataModel - the data model

Returns:

the future

processTemplate

public Future<String> processTemplate(Event<?> request,
 Template template,
 Object dataModel)

Returns a future string providing the result from processing the given template with the given data.

Parameters:

request - the request, used to obtain the ExecutorService service related with the request being processed

template - the template

dataModel - the data model

Returns:

the future