org.mule.runtime.core.routing

Class UntilSuccessful

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.routing.outbound.AbstractOutboundRouter

org.mule.runtime.core.routing.UntilSuccessful

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, MessageRouter, Processor, ReactiveProcessor, Matchable, MatchableMessageProcessor, MatchableMessageRouter, OutboundRouter, RouterStatisticsRecorder, UntilSuccessfulConfiguration

public class UntilSuccessful
extends AbstractOutboundRouter
implements UntilSuccessfulConfiguration

UntilSuccessful attempts to route a message to the message processor it contains. Routing is considered successful if no exception has been raised and, optionally, if the response matches an expression.

UntilSuccessful internal route can be executed synchronously or asynchronously depending on the threading profile defined on it. By default, if no threading profile is defined, then it will use the default threading profile configuration for the application. This means that the default behavior is to process asynchronously.

UntilSuccessful can optionally be configured to synchronously return an acknowledgment message when it has scheduled the event for processing. UntilSuccessful is backed by a ListableObjectStore for storing the events that are pending (re)processing.

Nested Class Summary

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

ReactiveProcessor.ProcessingType

Field Summary

Fields

Modifier and Type	Field and Description
protected Processor	dlqMP
static String	PROCESS_ATTEMPT_COUNT_PROPERTY_NAME

Fields inherited from class org.mule.runtime.core.routing.outbound.AbstractOutboundRouter

initialised, logger, resultsHandler, routes, started, transactionConfig

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

Method Summary

Modifier and Type	Method and Description
String	getAckExpression()
Processor	getDlqMP()
String	getEventKeyPrefix()
String	getFailureExpression()
ExpressionFilter	getFailureExpressionFilter()
int	getMaxRetries()
long	getMillisBetweenRetries()
ListableObjectStore<Event>	getObjectStore()
Processor	getRoute()
AbstractOutboundRouter	getRouter()
void	initialise()
boolean	isMatch(Event event, Event.Builder builder) Determines if the event should be processed
protected Event	route(Event event)
void	setAckExpression(String ackExpression)
void	setFailureExpression(String failureExpression)
void	setMaxRetries(int maxRetries)
void	setMillisBetweenRetries(long millisBetweenRetries)
void	setObjectStore(ListableObjectStore<Event> objectStore)
void	setSecondsBetweenRetries(long secondsBetweenRetries) Deprecated. use setMillisBetweenRetries(long) instead
void	setSynchronous(boolean synchronous)
void	start()
void	stop()

Methods inherited from class org.mule.runtime.core.routing.outbound.AbstractOutboundRouter

addRoute, createEventToRoute, dispose, doProcessRoute, getMuleContext, getOwnedMessageProcessors, getResultsHandler, getRouterStatistics, getRoutes, getTransactionConfig, isDynamicRoutes, process, removeRoute, sendRequest, sendRequestEvent, setFlowConstruct, setMessageProcessors, setMuleContext, setResultsHandler, setRouterStatistics, setRoutes, setTransactionConfig

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

getOwnedObjects

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

getFlowConstruct, setMessagingExceptionHandler

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.routing.UntilSuccessfulConfiguration

getFlowConstruct, getMuleContext

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

apply

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.meta.AnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Field Detail

PROCESS_ATTEMPT_COUNT_PROPERTY_NAME

public static final String PROCESS_ATTEMPT_COUNT_PROPERTY_NAME

See Also:

Constant Field Values

dlqMP

protected Processor dlqMP

Constructor Detail

UntilSuccessful

public UntilSuccessful()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Overrides:

initialise in class AbstractOutboundRouter

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Overrides:

start in class AbstractOutboundRouter

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Overrides:

stop in class AbstractOutboundRouter

Throws:

org.mule.runtime.api.exception.MuleException

isMatch

public boolean isMatch(Event event,
                       Event.Builder builder)
                throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Matchable

Determines if the event should be processed

Specified by:

isMatch in interface Matchable

Parameters:

event - the current event to evaluate

builder - an event builder in case the filter needs to make changes to the event.

Returns:

true if the event should be processed by this router

Throws:

org.mule.runtime.api.exception.MuleException - if the event cannot be evaluated

route

protected Event route(Event event)
               throws org.mule.runtime.api.exception.MuleException

Specified by:

route in class AbstractOutboundRouter

Throws:

org.mule.runtime.api.exception.MuleException

getObjectStore

public ListableObjectStore<Event> getObjectStore()

Specified by:

getObjectStore in interface UntilSuccessfulConfiguration

Returns:

an ObjectStore to store until successful internal data. Always returns a not null value.

setObjectStore

public void setObjectStore(ListableObjectStore<Event> objectStore)

getMaxRetries

public int getMaxRetries()

Specified by:

getMaxRetries in interface UntilSuccessfulConfiguration

Returns:

the number of retries to process the route when failing. Default value is 5.

setMaxRetries

public void setMaxRetries(int maxRetries)

setSecondsBetweenRetries

@Deprecated
public void setSecondsBetweenRetries(long secondsBetweenRetries)

Deprecated. use setMillisBetweenRetries(long) instead

Parameters:

secondsBetweenRetries - the number of seconds to wait between retries

getMillisBetweenRetries

public long getMillisBetweenRetries()

Specified by:

getMillisBetweenRetries in interface UntilSuccessfulConfiguration

Returns:

the number of milliseconds between retries. Default value is 60000.

setMillisBetweenRetries

public void setMillisBetweenRetries(long millisBetweenRetries)

getFailureExpression

public String getFailureExpression()

setFailureExpression

public void setFailureExpression(String failureExpression)

getAckExpression

public String getAckExpression()

Specified by:

getAckExpression in interface UntilSuccessfulConfiguration

Returns:

the expression that will define the returned payload after the until successful route execution.

setAckExpression

public void setAckExpression(String ackExpression)

getEventKeyPrefix

public String getEventKeyPrefix()

getFailureExpressionFilter

public ExpressionFilter getFailureExpressionFilter()

Specified by:

getFailureExpressionFilter in interface UntilSuccessfulConfiguration

Returns:

ExpressionFilter to determine if the message was processed successfully or not. Always returns a not null value.

getDlqMP

public Processor getDlqMP()

Specified by:

getDlqMP in interface UntilSuccessfulConfiguration

Returns:

the route to which the message must be sent if the processing fails.

getRoute

public Processor getRoute()

Specified by:

getRoute in interface UntilSuccessfulConfiguration

Returns:

the route to which the message should be routed to. Always returns a not null value.

getRouter

public AbstractOutboundRouter getRouter()

Specified by:

getRouter in interface UntilSuccessfulConfiguration

Returns:

the until sucessful router instance.

setSynchronous

public void setSynchronous(boolean synchronous)