org.bladerunnerjs.api.plugin

Interface TagHandlerPlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractTagHandlerPlugin

public interface TagHandlerPlugin
extends Plugin

Tag handler plug-ins allow BladeRunnerJS tags within index pages (e.g. <@bundle.js/@>) to be replaced with arbitrary content.

Tag handlers are often used to cause the browser to make requests to a ContentPlugin, typically using the RoutableContentPlugin.getContentPathParser() and ContentPathParser.createRequest(java.lang.String, java.lang.String...) methods to help generate valid content paths. Similar to ContentPlugin instances, tag-handler plug-ins should be deterministic, in that they generate the same content each time they are run.

Although tag-handler plug-ins are designed to be usable both dynamically, and as part of a build (for flat-file export), a provision for generating different content in development and production is provided, for cases where things need to be done in a more efficient manner in production, and in a more dev-friendly manner in development. Developers that choose to exploit this facility should take care to ensure there is no chance of bugs being found in production, that can't also be observed in development; a core tenet of BladeRunnerJS.

The following methods are identifier-methods, and may be invoked before Plugin.setBRJS() has been invoked:

• getTagName()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getGeneratedContentPaths(java.util.Map<java.lang.String,java.lang.String> tagAttributes, BundleSet bundleSet, org.bladerunnerjs.model.RequestMode requestMode, Locale locale) Get a list of content paths this tag handler loads or causes the app to load.
java.lang.String	getTagName() Returns the name of the tag this tag-handler provides.
java.util.List<java.lang.String>	usedContentPluginRequestPrefixes() Returns the request prefixes this tag handler makes use of.
void	writeTagContent(java.util.Map<java.lang.String,java.lang.String> tagAttributes, BundleSet bundleSet, org.bladerunnerjs.model.RequestMode requestMode, Locale locale, java.io.Writer writer, java.lang.String version) Writes out the generated content for the given tag, optimized for the specified request mode

Methods inherited from interface org.bladerunnerjs.api.plugin.Plugin

castTo, close, getPluginClass, instanceOf, setBRJS

Method Detail

getTagName

java.lang.String getTagName()

Returns the name of the tag this tag-handler provides.

Note: Developers should not rely on any class initialization performed within Plugin.setBRJS() as this method is an identifier-method which may be invoked before Plugin.setBRJS() has itself been invoked.

Returns:

The name of the tag used in the index page

writeTagContent

void writeTagContent(java.util.Map<java.lang.String,java.lang.String> tagAttributes,
                     BundleSet bundleSet,
                     org.bladerunnerjs.model.RequestMode requestMode,
                     Locale locale,
                     java.io.Writer writer,
                     java.lang.String version)
              throws java.io.IOException

Writes out the generated content for the given tag, optimized for the specified request mode

Parameters:

tagAttributes - TODO

bundleSet - TODO

requestMode - TODO

locale - TODO

writer - TODO

version - TODO

Throws:

java.io.IOException - if any exceptions are thrown when writing the tag content

getGeneratedContentPaths

java.util.List<java.lang.String> getGeneratedContentPaths(java.util.Map<java.lang.String,java.lang.String> tagAttributes,
                                                          BundleSet bundleSet,
                                                          org.bladerunnerjs.model.RequestMode requestMode,
                                                          Locale locale)
                                                   throws MalformedTokenException,
                                                          ContentProcessingException

Get a list of content paths this tag handler loads or causes the app to load.

Parameters:

tagAttributes - TODO

bundleSet - TODO

requestMode - TODO

locale - TODO

Returns:

the content paths used by the content which is generated from using this tag

Throws:

MalformedTokenException - if the token cannot be processed

ContentProcessingException - if an exception is encountered when generating the content

usedContentPluginRequestPrefixes

java.util.List<java.lang.String> usedContentPluginRequestPrefixes()

Returns the request prefixes this tag handler makes use of. Used to calculate which assets are used in production and therefore which assets should be part of a built app. For example if a JS tag handler outputs content that uses, or causes the app to use, content generated by the JS content plugin this would return an array containing 'js'. If all assets generated by a content plugin should be part of a built app return an empty list.

Returns:

The list of used content plugin prefixes