Package net.solarnetwork.central.support.xslt

Class BaseXsltService

java.lang.Object

net.solarnetwork.domain.BasicIdentity<String>

net.solarnetwork.service.support.BaseLocalizedServiceInfoProvider<String>

net.solarnetwork.settings.support.BaseSettingsSpecifierLocalizedServiceInfoProvider<String>

net.solarnetwork.central.support.xslt.BaseXsltService

All Implemented Interfaces:

Comparable<String>, net.solarnetwork.domain.Identity<String>, net.solarnetwork.service.LocalizedServiceInfoProvider, net.solarnetwork.settings.SettingSpecifierProvider, EntityResolver

public abstract class BaseXsltService
extends net.solarnetwork.settings.support.BaseSettingsSpecifierLocalizedServiceInfoProvider<String>
implements EntityResolver

Base service class for XSLT support.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	DOCTYPE_PAT	A regular expression matching an XML DOCTYPE declaration.
protected final DocumentBuilderFactory	documentBuilderFactory	The document builder factory.
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper	A JSON mapper.
static final String	SETTING_XSLT	The setting key for the XSLT stylesheet.
static final String	SETTING_XSLT_CACHE_DURATION	The setting key for the XSLT stylesheet cache seconds.
protected final SharedValueCache<String,Templates,String>	templatesCache	A cache for templates.
protected final Duration	templatesCacheTtl	A templates cache duration.
protected final TransformerFactory	transformerFactory	The transformer factory.
static final String	XSLT_PARAM_JSON	The XSLT input parameter for input JSON.

Fields inherited from class net.solarnetwork.service.support.BaseLocalizedServiceInfoProvider

log

Constructor Summary

Constructors

Constructor	Description
BaseXsltService(String serviceId, DocumentBuilderFactory documentBuilderFactory, TransformerFactory transformerFactory, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Duration templatesCacheTtl)	Constructor.
BaseXsltService(String serviceId, DocumentBuilderFactory documentBuilderFactory, TransformerFactory transformerFactory, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Duration templatesCacheTtl, SharedValueCache<String,Templates,String> templatesCache)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected DocumentBuilder	documentBuilder()	Get a new document builder.
protected static String	inputText(Object input)	Get textual input.
InputSource	resolveEntity(String publicId, String systemId)
protected Templates	templates(String xslt, net.solarnetwork.service.IdentifiableConfiguration config, Object cacheKey)	Get a Templates instance.
protected long	templatesCacheTtlSeconds(net.solarnetwork.service.IdentifiableConfiguration config)	Get the templates cache TTL seconds.

Methods inherited from class net.solarnetwork.settings.support.BaseSettingsSpecifierLocalizedServiceInfoProvider

getLocalizedServiceInfo, getSettingUid, populateInfoMessages, resolveInfoMessages

Methods inherited from class net.solarnetwork.service.support.BaseLocalizedServiceInfoProvider

getMessageSource, setMessageSource

Methods inherited from class net.solarnetwork.domain.BasicIdentity

clone, compareTo, equals, getId, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.solarnetwork.domain.Identity

hasId

Methods inherited from interface net.solarnetwork.settings.SettingSpecifierProvider

getDisplayName, getMessageSource, getSettingSpecifiers, localizedInfo, templateSettingSpecifiers, unwrap

Field Details

SETTING_XSLT

public static final String SETTING_XSLT

The setting key for the XSLT stylesheet.

See Also:

• Constant Field Values

SETTING_XSLT_CACHE_DURATION

public static final String SETTING_XSLT_CACHE_DURATION

The setting key for the XSLT stylesheet cache seconds.

See Also:

• Constant Field Values

XSLT_PARAM_JSON

public static final String XSLT_PARAM_JSON

The XSLT input parameter for input JSON.

See Also:

• Constant Field Values

transformerFactory

protected final TransformerFactory transformerFactory

The transformer factory.

documentBuilderFactory

protected final DocumentBuilderFactory documentBuilderFactory

The document builder factory.

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

A JSON mapper.

templatesCacheTtl

protected final Duration templatesCacheTtl

A templates cache duration.

templatesCache

protected final SharedValueCache<String,Templates,String> templatesCache

A cache for templates.

DOCTYPE_PAT

public static final Pattern DOCTYPE_PAT

A regular expression matching an XML DOCTYPE declaration.

Constructor Details

BaseXsltService

public BaseXsltService(String serviceId,
 DocumentBuilderFactory documentBuilderFactory,
 TransformerFactory transformerFactory,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 Duration templatesCacheTtl)

Constructor.

Parameters:

serviceId - the service ID to use

documentBuilderFactory - the XML document builder factory

transformerFactory - the XSLT transformer factory to use

objectMapper - the object mapper

templatesCacheTtl - the TTL for the templates cache, or null or 0 for no caching

Throws:

IllegalArgumentException - if any argument is null

BaseXsltService

public BaseXsltService(String serviceId,
 DocumentBuilderFactory documentBuilderFactory,
 TransformerFactory transformerFactory,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 Duration templatesCacheTtl,
 SharedValueCache<String,Templates,String> templatesCache)

Constructor.

If a templatesCache is provided then XSLT templates will be cached for up to the configured templatesCacheTtl seconds. The templates cache key can be provided by a

invalid reference

#PARAM_XSLT_CACHE_KEY

parameter value, or will be derived from the XSLT value itself.

Parameters:

serviceId - the service ID to use

documentBuilderFactory - the XML document builder factory

transformerFactory - the XSLT transformer factory to use

objectMapper - the object mapper

templatesCacheTtl - the TTL for the templates cache, or null or 0 for no caching

templatesCache - the templates cache to use

Throws:

IllegalArgumentException - if any argument except templatesCache is null

Method Details

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException,
IOException

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

IOException

documentBuilder

protected DocumentBuilder documentBuilder()
                                   throws ParserConfigurationException

Get a new document builder.

This instance will be configured as the EntityResolver.

Returns:

the new document builder

Throws:

ParserConfigurationException - if an XML error occurs

templates

protected Templates templates(String xslt,
 net.solarnetwork.service.IdentifiableConfiguration config,
 Object cacheKey)
                       throws IOException

Get a Templates instance.

Parameters:

xslt - the XSLT to parse

config - optional settings to use, for example SETTING_XSLT_CACHE_DURATION

cacheKey - optional cache key to use (will be converted to a string), otherwise generate a key based on the XSLT itself

Returns:

the templates, never null

Throws:

IOException - if any error occurs parsing the XSLT

templatesCacheTtlSeconds

protected long templatesCacheTtlSeconds(net.solarnetwork.service.IdentifiableConfiguration config)

Get the templates cache TTL seconds.

Parameters:

config - the optional settings

Returns:

the TTL, in seconds

inputText

protected static String inputText(Object input)
                           throws IOException

Get textual input.

Parameters:

input - the input, can be an InputStream, Reader, or anything else will have Object.toString() invoked; UTF-8 will be assumed for streams

Returns:

the text value, never null

Throws:

IOException - if any IO error occurs