org.apache.camel.util.toolbox

Class XsltAggregationStrategy

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.util.toolbox.XsltAggregationStrategy

All Implemented Interfaces:

CamelContextAware, AggregationStrategy, Service, ShutdownableService, StatefulService, SuspendableService

public class XsltAggregationStrategy
extends ServiceSupport
implements AggregationStrategy, CamelContextAware

The XSLT Aggregation Strategy enables you to use XSL stylesheets to aggregate messages.

Since XSLT does not directly support providing multiple XML payloads as an input, this aggregator injects the new incoming XML document (newExchange) into the oldExchange as an exchange property of type Document. The old exchange therefore remains accessible as the root context. This exchange property can then be accessed from your XSLT by declaring an <xsl:param /> at the top of your stylesheet: The exchange property name defaults to new-exchange but can be changed through setPropertyName(String).

Some code bits have been copied from the XsltEndpoint.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
XsltAggregationStrategy(String xslFileLocation) Constructor.

Method Summary

Modifier and Type	Method and Description
Exchange	aggregate(Exchange oldExchange, Exchange newExchange) Aggregates an old and new exchange together to create a single combined exchange
protected void	configureOutput(XsltBuilder xslt, String output)
static XsltAggregationStrategy	create(String xslFile)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
String	getPropertyName()
protected void	initialize(CamelContext context) Deprecated.
protected void	loadResource(String resourceUri) Loads the resource.
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setOutput(XsltOutput output)
void	setPropertyName(String propertyName)
void	setTransformerFactoryClass(String transformerFactoryClass)
void	setUriResolver(URIResolver uriResolver)
void	setXslt(XsltBuilder xslt)
XsltAggregationStrategy	withOutput(XsltOutput output)
XsltAggregationStrategy	withPropertyName(String propertyName)
XsltAggregationStrategy	withSaxon()
XsltAggregationStrategy	withTransformerFactoryClass(String clazz)
XsltAggregationStrategy	withUriResolver(URIResolver resolver)

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

XsltAggregationStrategy

public XsltAggregationStrategy(String xslFileLocation)

Constructor.

Parameters:

xslFileLocation - location of the XSL transformation

Method Detail

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

aggregate

public Exchange aggregate(Exchange oldExchange,
                          Exchange newExchange)

Description copied from interface: AggregationStrategy

Aggregates an old and new exchange together to create a single combined exchange

Specified by:

aggregate in interface AggregationStrategy

Parameters:

oldExchange - the oldest exchange (is null on first aggregation as we only have the new exchange)

newExchange - the newest exchange (can be null if there was no data possible to acquire)

Returns:

a combined composite of the two exchanges, favor returning the oldExchange whenever possible

setOutput

public void setOutput(XsltOutput output)

setXslt

public void setXslt(XsltBuilder xslt)

setUriResolver

public void setUriResolver(URIResolver uriResolver)

setTransformerFactoryClass

public void setTransformerFactoryClass(String transformerFactoryClass)

getPropertyName

public String getPropertyName()

setPropertyName

public void setPropertyName(String propertyName)

initialize

@Deprecated
protected void initialize(CamelContext context)
                               throws Exception

Deprecated.

Throws:

Exception

configureOutput

protected void configureOutput(XsltBuilder xslt,
                               String output)
                        throws Exception

Throws:

Exception

loadResource

protected void loadResource(String resourceUri)
                     throws TransformerException,
                            IOException

Loads the resource.

Parameters:

resourceUri - the resource to load

Throws:

TransformerException - is thrown if error loading resource

IOException - is thrown if error loading resource

create

public static XsltAggregationStrategy create(String xslFile)

withPropertyName

public XsltAggregationStrategy withPropertyName(String propertyName)

withOutput

public XsltAggregationStrategy withOutput(XsltOutput output)

withUriResolver

public XsltAggregationStrategy withUriResolver(URIResolver resolver)

withTransformerFactoryClass

public XsltAggregationStrategy withTransformerFactoryClass(String clazz)

withSaxon

public XsltAggregationStrategy withSaxon()

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()