org.apache.camel.processor

Class Enricher

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.Enricher

All Implemented Interfaces:

AsyncProcessor, Processor, Service, ShutdownableService, StatefulService, SuspendableService

public class Enricher
extends ServiceSupport
implements AsyncProcessor

A content enricher that enriches input data by first obtaining additional data from a resource represented by an endpoint producer and second by aggregating input data and additional data. Aggregation of input data and additional data is delegated to an AggregationStrategy object.

Uses a Producer to obtain the additional data as opposed to PollEnricher that uses a PollingConsumer.

See Also:

PollEnricher

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
Enricher(AggregationStrategy aggregationStrategy, Producer producer) Creates a new Enricher.
Enricher(Producer producer) Creates a new Enricher.

Method Summary

Methods

Modifier and Type	Method and Description
protected Exchange	createResourceExchange(Exchange source, ExchangePattern pattern) Creates a new DefaultExchange instance from the given exchange.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
AggregationStrategy	getAggregationStrategy()
boolean	isAggregateOnException()
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Enriches the input data (exchange) by first obtaining additional data from an endpoint represented by an endpoint producer and second by aggregating input data and additional data.
void	setAggregateOnException(boolean aggregateOnException) Whether to call AggregationStrategy.aggregate(org.apache.camel.Exchange, org.apache.camel.Exchange) if an exception was thrown.
void	setAggregationStrategy(AggregationStrategy aggregationStrategy) Sets the aggregation strategy for this enricher.
void	setDefaultAggregationStrategy() Sets the default aggregation strategy for this enricher.
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Enricher

public Enricher(Producer producer)

Creates a new Enricher. The default aggregation strategy is to copy the additional data obtained from the enricher's resource over the input data. When using the copy aggregation strategy the enricher degenerates to a normal transformer.

Parameters:

producer - producer to resource endpoint.

Enricher

public Enricher(AggregationStrategy aggregationStrategy,
        Producer producer)

Creates a new Enricher.

Parameters:

aggregationStrategy - aggregation strategy to aggregate input data and additional data.

producer - producer to resource endpoint.

Method Detail

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

Sets the aggregation strategy for this enricher.

Parameters:

aggregationStrategy - the aggregationStrategy to set

getAggregationStrategy

public AggregationStrategy getAggregationStrategy()

isAggregateOnException

public boolean isAggregateOnException()

setAggregateOnException

public void setAggregateOnException(boolean aggregateOnException)

Whether to call AggregationStrategy.aggregate(org.apache.camel.Exchange, org.apache.camel.Exchange) if an exception was thrown.

setDefaultAggregationStrategy

public void setDefaultAggregationStrategy()

Sets the default aggregation strategy for this enricher.

process

public void process(Exchange exchange)
             throws Exception

Description copied from interface: Processor

Processes the message exchange

Specified by:

process in interface Processor

Parameters:

exchange - the message exchange

Throws:

Exception - if an internal processing error has occurred.

process

public boolean process(Exchange exchange,
              AsyncCallback callback)

Enriches the input data (exchange) by first obtaining additional data from an endpoint represented by an endpoint producer and second by aggregating input data and additional data. Aggregation of input data and additional data is delegated to an AggregationStrategy object set at construction time. If the message exchange with the resource endpoint fails then no aggregation will be done and the failed exchange content is copied over to the original message exchange.

Specified by:

process in interface AsyncProcessor

Parameters:

exchange - input data.

callback - the AsyncCallback will be invoked when the processing of the exchange is completed. If the exchange is completed synchronously, then the callback is also invoked synchronously. The callback should therefore be careful of starting recursive loop.

Returns:

(doneSync) true to continue execute synchronously, false to continue being executed asynchronously

createResourceExchange

protected Exchange createResourceExchange(Exchange source,
                              ExchangePattern pattern)

Creates a new DefaultExchange instance from the given exchange. The resulting exchange's pattern is defined by pattern.

Parameters:

source - exchange to copy from.

pattern - exchange pattern to set.

Returns:

created exchange.

toString

public String toString()

Overrides:

toString in class Object

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()