Class TransformerPool

java.lang.Object

org.frankframework.util.TransformerPool

public class TransformerPool
extends Object

Pool of transformers. As of IBIS 4.2.e the Templates object is used to improve performance and work around threading problems with the api.

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransformerPool.OutputType

Method Summary

Modifier and Type	Method	Description
void	close()	Closing the Pool doesn't automatically mean all references remaining in the pool will be terminated.
static @NonNull TransformerPool	configureStyleSheetTransformer(@Nullable FrankElement scopeProvider, @Nullable String styleSheetName, int xsltVersion)
static @Nullable TransformerPool	configureTransformer(@Nullable FrankElement scopeProvider, @Nullable String namespaceDefs, @Nullable String xPathExpression, @Nullable String styleSheetName, @NonNull TransformerPool.OutputType outputType, boolean includeXmlDeclaration, @Nullable ParameterList params, boolean mandatory)
static @NonNull TransformerPool	configureTransformer(@Nullable FrankElement scopeProvider, @Nullable String namespaceDefs, @Nullable String xPathExpression, @Nullable String styleSheetName, @Nullable TransformerPool.OutputType outputType, boolean includeXmlDeclaration, @Nullable ParameterList params)
static @NonNull TransformerPool	configureTransformer0(@Nullable FrankElement scopeProvider, @Nullable String namespaceDefs, @Nullable String xPathExpression, @Nullable String styleSheetName, @NonNull TransformerPool.OutputType outputType, boolean includeXmlDeclaration, @Nullable ParameterList params, int xsltVersion)
protected Transformer	createTransformer()
protected @NonNull Map<String,String>	getConfigMap()
@Nullable Boolean	getDisableOutputEscaping()
@Nullable Boolean	getIndent()
static TransformerPool	getInstance(@NonNull String xsltString, int xsltVersion, @Nullable IScopeProvider scopeProvider)	Get an instance of a TransformerPool that can load additional resources such as referenced URIs from the provided IScopeProvider.
static TransformerPool	getInstance(@NonNull Resource resource)	Get a TransformerPool instance that loads its XSLT stylesheet from the given resource.
static TransformerPool	getInstance(@NonNull Resource resource, int xsltVersion)	Get a TransformerPool instance that loads its XSLT stylesheet from the given resource.
@Nullable Boolean	getOmitXmlDeclaration()
@Nullable String	getOutputMethod()
protected @NonNull Transformer	getTransformer()
TransformerFilter	getTransformerFilter(@NonNull ThreadConnector<?> threadConnector, @NonNull ContentHandler handler)
TransformerFilter	getTransformerFilter(@NonNull ContentHandler handler)
TransformerFilter	getTransformerFilter(@NonNull ContentHandler handler, boolean removeNamespacesFromInput, boolean handleLexicalEvents)
static TransformerPool	getUtilityInstance(@NonNull String xsltString, int xsltVersion)	Special utility method to create a new TransformerPool without a ClassLoader.
static @NonNull TransformerPool	getXPathTransformerPool(@NonNull String xpathExpression, int xsltVersion)
static @NonNull TransformerPool	getXPathTransformerPool(@Nullable String namespaceDefs, @NonNull String xpathExpression, @NonNull TransformerPool.OutputType outputMethod)
static @NonNull TransformerPool	getXPathTransformerPool(@Nullable String namespaceDefs, @NonNull String xPathExpression, @NonNull TransformerPool.OutputType outputType, boolean includeXmlDeclaration, @Nullable ParameterList params)
static @NonNull TransformerPool	getXPathTransformerPool(@Nullable String namespaceDefs, @NonNull String xPathExpression, @NonNull TransformerPool.OutputType outputType, boolean includeXmlDeclaration, @Nullable ParameterList params, int xsltVersion)
protected void	invalidateTransformer(Transformer t)
protected void	invalidateTransformerNoThrow(Transformer transformer)
void	open()
protected void	releaseTransformer(Transformer t)
void	transform(@NonNull Source s, @NonNull Result r, Map<String,Object> parameters)
@NonNull Message	transform(@NonNull Message message)
@NonNull Message	transform(@NonNull Message m, @Nullable Map<String,Object> parameterMap)	Transforms Frank messages.
@NonNull Message	transform(@NonNull Message message, @Nullable ParameterValueList pvl)
String	transformToString(String s)
String	transformToString(String s, Map<String,Object> parameters)
String	transformToString(String s, Map<String,Object> parameters, boolean namespaceAware)
String	transformToString(Source s)
String	transformToString(Source s, Map<String,Object> parameters)
String	transformToString(@NonNull Message input)
String	transformToString(Message m, Map<String,Object> parameters, boolean namespaceAware)

Methods inherited from class Object

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

Method Details

getInstance

public static TransformerPool getInstance(@NonNull String xsltString,
 int xsltVersion,
 @Nullable IScopeProvider scopeProvider)
                                   throws TransformerConfigurationException

Get an instance of a TransformerPool that can load additional resources such as referenced URIs from the provided IScopeProvider. WARNING: This should only be used to be able to load Configuration-specific resources in dynamically loaded configurations. This should not be used for application-wide transformer pools.

Parameters:

xsltString - The XSLT to be evaluated, as string

xsltVersion - Version of XSLT. Can be 0, 1, or 2. If 0, the actual version will be extracted from the stylesheet at a performance-penalty.

scopeProvider - The IScopeProvider for loading additional resources

Returns:

A TransformerPool instance for the input stylesheet.

Throws:

TransformerConfigurationException

getUtilityInstance

public static TransformerPool getUtilityInstance(@NonNull String xsltString,
 int xsltVersion)
                                          throws TransformerConfigurationException

Special utility method to create a new TransformerPool without a ClassLoader. Utility pools should never use configuration classloaders, instead always read from the classpath! Utility pools should always be cached statically for re-use. The caller-code is responsible for this.

Throws:

TransformerConfigurationException

getInstance

public static TransformerPool getInstance(@NonNull Resource resource)
                                   throws TransformerConfigurationException,
IOException

Get a TransformerPool instance that loads its XSLT stylesheet from the given resource. The XSLT version will be dynamically derived from the stylesheet, at a performance penalty.

Parameters:

resource - Resource from which to load the stylesheet

Returns:

TransformerPool instance for the XSLT stylesheet.

Throws:

TransformerConfigurationException - Thrown if there was an exception creating the TransformerPool or parsing the XSLT stylesheet

IOException - Thrown if the resource cannot be loaded

getInstance

public static TransformerPool getInstance(@NonNull Resource resource,
 int xsltVersion)
                                   throws TransformerConfigurationException,
IOException

Get a TransformerPool instance that loads its XSLT stylesheet from the given resource. The XSLT version in the stylesheet should match the xlstVersion parameter, or be 0 for dynamic derivation at a performance penalty.

Parameters:

resource - The Resource from which to load the XSLT stylesheet

xsltVersion - The XSLT version of the stylesheet. Can be 0, 1, or 2. If 0, the actual version will be dynamically derived from the stylesheet itself on creation at a cost in performance.

Returns:

TransformerPool instance for the XSLT stylesheet.

Throws:

TransformerConfigurationException - Thrown if there was an exception creating the TransformerPool or parsing the XSLT stylesheet

IOException - Thrown if the resource cannot be loaded

configureTransformer

public static @Nullable TransformerPool configureTransformer(@Nullable FrankElement scopeProvider,
 @Nullable String namespaceDefs,
 @Nullable String xPathExpression,
 @Nullable String styleSheetName,
 @NonNull TransformerPool.OutputType outputType,
 boolean includeXmlDeclaration,
 @Nullable ParameterList params,
 boolean mandatory)
                                                      throws ConfigurationException

Throws:

ConfigurationException

configureTransformer

public static @NonNull TransformerPool configureTransformer(@Nullable FrankElement scopeProvider,
 @Nullable String namespaceDefs,
 @Nullable String xPathExpression,
 @Nullable String styleSheetName,
 @Nullable TransformerPool.OutputType outputType,
 boolean includeXmlDeclaration,
 @Nullable ParameterList params)
                                                     throws ConfigurationException

Throws:

ConfigurationException

configureTransformer0

public static @NonNull TransformerPool configureTransformer0(@Nullable FrankElement scopeProvider,
 @Nullable String namespaceDefs,
 @Nullable String xPathExpression,
 @Nullable String styleSheetName,
 @NonNull TransformerPool.OutputType outputType,
 boolean includeXmlDeclaration,
 @Nullable ParameterList params,
 int xsltVersion)
                                                      throws ConfigurationException

Throws:

ConfigurationException

configureStyleSheetTransformer

public static @NonNull TransformerPool configureStyleSheetTransformer(@Nullable FrankElement scopeProvider,
 @Nullable String styleSheetName,
 int xsltVersion)
                                                               throws ConfigurationException

Throws:

ConfigurationException

getXPathTransformerPool

public static @NonNull TransformerPool getXPathTransformerPool(@NonNull String xpathExpression,
 int xsltVersion)
                                                        throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getXPathTransformerPool

public static @NonNull TransformerPool getXPathTransformerPool(@Nullable String namespaceDefs,
 @NonNull String xpathExpression,
 @NonNull TransformerPool.OutputType outputMethod)
                                                        throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getXPathTransformerPool

public static @NonNull TransformerPool getXPathTransformerPool(@Nullable String namespaceDefs,
 @NonNull String xPathExpression,
 @NonNull TransformerPool.OutputType outputType,
 boolean includeXmlDeclaration,
 @Nullable ParameterList params)
                                                        throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getXPathTransformerPool

public static @NonNull TransformerPool getXPathTransformerPool(@Nullable String namespaceDefs,
 @NonNull String xPathExpression,
 @NonNull TransformerPool.OutputType outputType,
 boolean includeXmlDeclaration,
 @Nullable ParameterList params,
 int xsltVersion)
                                                        throws TransformerConfigurationException

Throws:

TransformerConfigurationException

open

public void open()

close

public void close()

Closing the Pool doesn't automatically mean all references remaining in the pool will be terminated. After closing, manually releases any associated resources in the pool

getTransformer

protected @NonNull Transformer getTransformer()
                                       throws TransformerConfigurationException

Throws:

TransformerConfigurationException

releaseTransformer

protected void releaseTransformer(Transformer t)
                           throws TransformerConfigurationException

Throws:

TransformerConfigurationException

invalidateTransformer

protected void invalidateTransformer(Transformer t)
                              throws Exception

Throws:

Exception

invalidateTransformerNoThrow

protected void invalidateTransformerNoThrow(Transformer transformer)

createTransformer

protected Transformer createTransformer()
                                 throws TransformerConfigurationException

Throws:

TransformerConfigurationException

transformToString

public String transformToString(Message m,
 Map<String,Object> parameters,
 boolean namespaceAware)
                         throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transformToString

public String transformToString(String s)
                         throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transformToString

public String transformToString(String s,
 Map<String,Object> parameters)
                         throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transformToString

public String transformToString(String s,
 Map<String,Object> parameters,
 boolean namespaceAware)
                         throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transformToString

public String transformToString(Source s)
                         throws TransformerException,
IOException

Throws:

TransformerException

IOException

transformToString

public String transformToString(Source s,
 Map<String,Object> parameters)
                         throws TransformerException,
IOException

Throws:

TransformerException

IOException

transformToString

public String transformToString(@NonNull Message input)
                         throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transform

public @NonNull Message transform(@NonNull Message message)
                           throws IOException,
TransformerException,
SAXException

Throws:

IOException

TransformerException

SAXException

transform

public @NonNull Message transform(@NonNull Message message,
 @Nullable ParameterValueList pvl)
                           throws IOException,
TransformerException,
SAXException

Throws:

IOException

TransformerException

SAXException

transform

public @NonNull Message transform(@NonNull Message m,
 @Nullable Map<String,Object> parameterMap)
                           throws IOException,
TransformerException,
SAXException

Transforms Frank messages.

Throws:

IOException

TransformerException

SAXException

transform

public void transform(@NonNull Source s,
 @NonNull Result r,
 Map<String,Object> parameters)
               throws TransformerException,
IOException

Throws:

TransformerException

IOException

getTransformerFilter

public TransformerFilter getTransformerFilter(@NonNull ContentHandler handler)
                                       throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getTransformerFilter

public TransformerFilter getTransformerFilter(@NonNull ContentHandler handler,
 boolean removeNamespacesFromInput,
 boolean handleLexicalEvents)
                                       throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getTransformerFilter

public TransformerFilter getTransformerFilter(@NonNull ThreadConnector<?> threadConnector,
 @NonNull ContentHandler handler)
                                       throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getConfigMap

protected @NonNull Map<String,String> getConfigMap()
                                            throws TransformerException,
IOException

Throws:

TransformerException

IOException

getOmitXmlDeclaration

public @Nullable Boolean getOmitXmlDeclaration()
                                        throws TransformerException,
IOException

Throws:

TransformerException

IOException

getIndent

public @Nullable Boolean getIndent()
                            throws TransformerException,
IOException

Throws:

TransformerException

IOException

getOutputMethod

public @Nullable String getOutputMethod()
                                 throws TransformerException,
IOException

Throws:

TransformerException

IOException

getDisableOutputEscaping

public @Nullable Boolean getDisableOutputEscaping()
                                           throws TransformerException,
IOException

Throws:

TransformerException

IOException