Package com.adaptris.core.transform

Class XmlTransformService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.transform.XmlTransformService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

MultiPayloadXmlTransformService

@ComponentProfile(summary="Execute an XSLT transform",
                  tag="service,transform,xml")
public class XmlTransformService
extends ServiceImp

Implementation of Service which provides transformation of XML payloads.

You are required to configure the XML transformer factory; see the javadoc and implementations of XmlTransformerFactory for details on the supported transformer factories.

Configuration including allow over-ride behaviour matches previous implementation.

In the adapter configuration file this class is aliased as xml-transform-service which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
XmlTransformService()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected javax.xml.transform.Transformer	cacheAndGetTransformer(java.lang.String urlToUse, XmlTransformerFactory xmlTransformerFactory)
protected void	closeService()
void	doService(AdaptrisMessage msg)	Apply the service to the message.
java.lang.Boolean	getAllowOverride()	Returns true if a configured XSLT URL may be over-ridden by one stored against a metadata key.
java.lang.Boolean	getCacheTransforms()	Returns true if XSLTs should be cached.
java.lang.String	getMetadataKey()	Returns the metadata key against which an over-ride XSLT URL may be stored.
java.lang.String	getOutputMessageEncoding()
protected XmlTransformParameter	getParameterBuilder()
XmlTransformParameter	getTransformParameter()
java.lang.String	getUrl()	Returns the URL of the XSLT to use.
XmlTransformerFactory	getXmlTransformerFactory()
protected void	initService()
void	prepare()	Prepare for initialisation.
void	setAllowOverride(java.lang.Boolean b)	Sets whether the configured XSLT URL may be over-ridden by one stored against a metaddata key.
void	setCacheTransforms(java.lang.Boolean b)	Sets whether XSLTs should be cached or not.
void	setMetadataKey(java.lang.String s)	Sets the metadata key against which an over-ride XSLT URL may be stored.
void	setOutputMessageEncoding(java.lang.String s)	Force the output message encoding to be a particular encoding.
void	setTransformParameter(XmlTransformParameter param)
void	setUrl(java.lang.String s)	Sets the URL of the XSLT to use.
void	setXmlTransformerFactory(XmlTransformerFactory xmlTransformerFactory)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlTransformService

public XmlTransformService()

Creates a new instance. Defaults to caching transforms and not allowing over-rides. Default metadata key is transformurl.

Method Detail

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

See Also:

(com.adaptris.core.AdaptrisMessage)

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

cacheAndGetTransformer

protected javax.xml.transform.Transformer cacheAndGetTransformer(java.lang.String urlToUse,
                                                                 XmlTransformerFactory xmlTransformerFactory)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getUrl

public java.lang.String getUrl()

Returns the URL of the XSLT to use.

Returns:

the URL of the XSLT to use

setUrl

public void setUrl(java.lang.String s)

Sets the URL of the XSLT to use. May not be empty.

Parameters:

s - the URL of the XSLT to use

getMetadataKey

public java.lang.String getMetadataKey()

Returns the metadata key against which an over-ride XSLT URL may be stored.

Returns:

the metadata key against which an over-ride XSLT URL may be stored

setMetadataKey

public void setMetadataKey(java.lang.String s)

Sets the metadata key against which an over-ride XSLT URL may be stored. May not be empty.

Parameters:

s - the metadata key against which an over-ride XSLT URL may be stored, defaults to "transformurl"

getCacheTransforms

public java.lang.Boolean getCacheTransforms()

Returns true if XSLTs should be cached.

Returns:

true if XSLTs should be cached, otherwise false

See Also:

setCacheTransforms(Boolean)

setCacheTransforms

public void setCacheTransforms(java.lang.Boolean b)

Sets whether XSLTs should be cached or not. If this is false the XSLT will be read for each message processed. Therefore while any changes to the XSLT will be picked up immediately, processing will take significantly longer, particularly if the XSLT is on a remote machine.

Parameters:

b - whether XSLTs should be cached or not, defaults to true.

getAllowOverride

public java.lang.Boolean getAllowOverride()

Returns true if a configured XSLT URL may be over-ridden by one stored against a metadata key.

Returns:

true if a configured XSLT URL may be over-ridden by one stored against a metadata key, otherwise false

setAllowOverride

public void setAllowOverride(java.lang.Boolean b)

Sets whether the configured XSLT URL may be over-ridden by one stored against a metaddata key. If URL is configured this is implicitly true.

Parameters:

b - whether the configured XSLT URL may be over-ridden by one stored against a metaddata key, defaults to null (false)

getOutputMessageEncoding

public java.lang.String getOutputMessageEncoding()

setOutputMessageEncoding

public void setOutputMessageEncoding(java.lang.String s)

Force the output message encoding to be a particular encoding.

If specified then the underlying AdaptrisMessage.setCharEncoding(String) is changed to match the encoding specified here before attempting any write operations.

This is only useful if the underlying message is encoded in one way, and you wish to force the encoding directly in your stylesheet; e.g. the message is physically encoded using ISO-8859-1; but your xslt has <xsl:output method="xml" encoding="UTF-8" indent="yes"/> and you need to ensure that the message is physically encoded using UTF-8 after the transform.

Parameters:

s - the output encoding; if null, the the existing encoding specified by AdaptrisMessage.getCharEncoding() is used.

getXmlTransformerFactory

public XmlTransformerFactory getXmlTransformerFactory()

setXmlTransformerFactory

public void setXmlTransformerFactory(XmlTransformerFactory xmlTransformerFactory)

getTransformParameter

public XmlTransformParameter getTransformParameter()

setTransformParameter

public void setTransformParameter(XmlTransformParameter param)

getParameterBuilder

protected XmlTransformParameter getParameterBuilder()