org.mule.runtime.core.internal.enricher

Class MessageEnricher

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.processor.AbstractMuleObjectOwner<Processor>

org.mule.runtime.core.processor.AbstractMessageProcessorOwner

org.mule.runtime.core.internal.enricher.MessageEnricher

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.AnnotatedObject, FlowConstructAware, MuleContextAware, MessagingExceptionHandlerAware, Processor, ReactiveProcessor

public class MessageEnricher
extends AbstractMessageProcessorOwner
implements Processor

The Message Enricher allows the current message to be augmented using data from a seperate resource.

The Mule implementation the Enrichment Resource can be any Message Processor. This allows you to not only use a JDBC endpoint directly but also call out to a remote service via HTTP or even reference another flow or sub-flow.

The Message Processor that implements the Enrichment Resource is invoked with a copy of the current message along with any flow or session variables that are present. Invocation of the this message processor is done in a separate context to the main flow such that any modification to the message (and it's properties and attachments) or flow or session variables will not be reflected in the flow where the enricher is configured.

The Enrichment Resource should always return a result. If it doesn't then the Enricher will simply leave the message untouched.

The way in which the message is enriched (or modified) is by explicitly configuring mappings (source -> target) between the result from the Enrichment Resource and the message using of Mule Expressions. Mule Expressions are used to both select the value to be extracted from result that comes back from the enrichment resource (source) and to define where this value to be inserted into the message (target). The default 'source' if it's not configured is the payload of the result from the enrichment resource..

EIP Reference: http://eaipatterns.com/DataEnricher.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageEnricher.EnrichExpressionPair

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

ReactiveProcessor.ProcessingType

Field Summary

Fields inherited from class org.mule.runtime.core.processor.AbstractMuleObjectOwner

flowConstruct, messagingExceptionHandler, muleContext

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
MessageEnricher()

Method Summary

Modifier and Type	Method and Description
void	addEnrichExpressionPair(MessageEnricher.EnrichExpressionPair pair)
org.reactivestreams.Publisher<Event>	apply(org.reactivestreams.Publisher<Event> publisher) Applies a Publisher function transforming a stream of Event's.
protected Event	enrich(Event event, Event eventToEnrich)
protected Event	enrich(Event currentEvent, Event enrichmentEvent, String sourceExpressionArg, String targetExpressionArg, ExtendedExpressionManager expressionManager)
protected List<Processor>	getOwnedMessageProcessors()
Event	process(Event event) Invokes the MessageProcessor.
void	setEnrichExpressionPairs(List<MessageEnricher.EnrichExpressionPair> enrichExpressionPairs)
void	setEnrichmentMessageProcessor(Processor enrichmentProcessor)
void	setMessageProcessor(Processor enrichmentProcessor) For spring

Methods inherited from class org.mule.runtime.core.processor.AbstractMessageProcessorOwner

getOwnedObjects

Methods inherited from class org.mule.runtime.core.processor.AbstractMuleObjectOwner

dispose, getFlowConstruct, getMuleContext, initialise, setFlowConstruct, setMessagingExceptionHandler, setMuleContext, start, stop

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

getProcessingType

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface org.mule.runtime.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.runtime.api.lifecycle.Startable

start

Methods inherited from interface org.mule.runtime.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.runtime.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.runtime.core.api.context.MuleContextAware

setMuleContext

Methods inherited from interface org.mule.runtime.core.api.construct.FlowConstructAware

setFlowConstruct

Methods inherited from interface org.mule.runtime.api.meta.AnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Constructor Detail

MessageEnricher

public MessageEnricher()

Method Detail

process

public Event process(Event event)
              throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Processor

Invokes the MessageProcessor.

Specified by:

process in interface Processor

Parameters:

event - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

org.mule.runtime.api.exception.MuleException

enrich

protected Event enrich(Event currentEvent,
                       Event enrichmentEvent,
                       String sourceExpressionArg,
                       String targetExpressionArg,
                       ExtendedExpressionManager expressionManager)

apply

public org.reactivestreams.Publisher<Event> apply(org.reactivestreams.Publisher<Event> publisher)

Description copied from interface: Processor

Applies a Publisher function transforming a stream of Event's.

The default implementation delegates to Processor.process(Event) and will:

1. propagate any exception thrown
2. drop events if invocation of Processor.process(Event) returns null.

Specified by:

apply in interface Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>

Specified by:

apply in interface Processor

Parameters:

publisher - the event stream to transform

Returns:

the transformed event stream

enrich

protected Event enrich(Event event,
                       Event eventToEnrich)
                throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

setEnrichmentMessageProcessor

public void setEnrichmentMessageProcessor(Processor enrichmentProcessor)

setMessageProcessor

public void setMessageProcessor(Processor enrichmentProcessor)

For spring

setEnrichExpressionPairs

public void setEnrichExpressionPairs(List<MessageEnricher.EnrichExpressionPair> enrichExpressionPairs)

addEnrichExpressionPair

public void addEnrichExpressionPair(MessageEnricher.EnrichExpressionPair pair)

getOwnedMessageProcessors

protected List<Processor> getOwnedMessageProcessors()

Specified by:

getOwnedMessageProcessors in class AbstractMessageProcessorOwner