org.mule.functional.api.component

Class FunctionalTestProcessor

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.functional.api.component.FunctionalTestProcessor

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, Processor, ReactiveProcessor

public class FunctionalTestProcessor
extends org.mule.runtime.api.meta.AbstractAnnotatedObject
implements Processor, org.mule.runtime.api.lifecycle.Lifecycle, MuleContextAware, FlowConstructAware

FunctionalTestProcessor is a service that can be used by functional tests. This service accepts an EventCallback that can be used to assert the state of the current event.

Also, this service fires FunctionalTestNotification via Mule for every message received. Tests can register with Mule to receive these events by implementing FunctionalTestNotificationListener.

See Also:

FunctionalTestNotification, FunctionalTestNotificationListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FunctionalTestProcessor.LifecycleCallback

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

ReactiveProcessor.ProcessingType

Field Summary

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

Method Summary

Modifier and Type	Method and Description
static void	addLifecycleCallback(FunctionalTestProcessor.LifecycleCallback callback)
protected String	append(String contents, Event event) Will append the value of getAppendString() to the contents of the message.
void	dispose()
protected Event	doProcess(Event event) The service method that implements the test component logic.
String	getAppendString()
EventCallback	getEventCallback() An event callback is called when a message is received by the service.
String	getExceptionText()
Class<? extends Throwable>	getExceptionToThrow()
static FunctionalTestProcessor	getFromFlow(MuleContext muleContext, String flowName)
Event	getLastReceivedMessage() If enableMessageHistory = true, returns the last message received by the service in chronological order.
Event	getReceivedMessage(int number) If enableMessageHistory = true, returns a message received by the service in chronological order.
int	getReceivedMessagesCount() If enableMessageHistory = true, returns the number of messages received by this service.
Object	getReturnData() Often you will may want to return a fixed message payload to simulate and external system call.
long	getWaitTime()
void	initialise()
boolean	isEnableMessageHistory()
boolean	isEnableNotifications()
boolean	isLogMessageDetails()
boolean	isThrowException() Sometimes you will want the service to always throw an exception, if this is the case you can set the 'throwException' property to true.
Event	process(Event event)
static void	removeLifecycleCallback(FunctionalTestProcessor.LifecycleCallback callback)
void	setAppendString(String appendString)
void	setEnableMessageHistory(boolean enableMessageHistory)
void	setEnableNotifications(boolean enableNotifications)
void	setEventCallback(EventCallback eventCallback) An event callback is called when a message is received by the service.
void	setExceptionText(String text)
void	setExceptionToThrow(Class<? extends Throwable> exceptionToThrow)
void	setFlowConstruct(FlowConstruct flowConstruct)
void	setId(String id)
void	setLogMessageDetails(boolean logMessageDetails)
void	setMuleContext(MuleContext context)
void	setReturnData(Object returnData) Often you will may want to return a fixed message payload to simulate and external system call.
void	setThrowException(boolean throwException) Sometimes you will want the service to always throw an exception, if this is the case you can set the 'throwException' property to true.
void	setWaitTime(long waitTime)
void	start()
void	stop()
protected void	throwException() Always throws a FunctionalTestException.

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

Constructor Detail

FunctionalTestProcessor

public FunctionalTestProcessor()

Method Detail

initialise

public void initialise()

Specified by:

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

start

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

Specified by:

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

Throws:

org.mule.runtime.api.exception.MuleException

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

setFlowConstruct

public void setFlowConstruct(FlowConstruct flowConstruct)

Specified by:

setFlowConstruct in interface FlowConstructAware

stop

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

Specified by:

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

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

process

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

Specified by:

process in interface Processor

Throws:

org.mule.runtime.api.exception.MuleException

throwException

protected void throwException()
                       throws Exception

Always throws a FunctionalTestException. This methodis only called if isThrowException() is true.

Throws:

FunctionalTestException - or the exception specified in 'exceptionType

Exception

append

protected String append(String contents,
                        Event event)

Will append the value of getAppendString() to the contents of the message. This has a side affect that the inbound message will be converted to a string and the return payload will be a string. Note that the value of getAppendString() can contain expressions.

Parameters:

contents - the string vlaue of the current message payload

event - the current event

Returns:

a concatenated string of the current payload and the appendString

doProcess

protected Event doProcess(Event event)
                   throws Exception

The service method that implements the test component logic.

Parameters:

event - the current Event

Returns:

a new message payload according to the configuration of the component

Throws:

Exception - if there is a general failure or if isThrowException() is true.

getEventCallback

public EventCallback getEventCallback()

An event callback is called when a message is received by the service. An Event callback isn't strictly required but it is useful for performing assertions on the current message being received. Note that the FunctionalTestProcessor should be made a singleton when using Event callbacks

Another option is to register a FunctionalTestNotificationListener with Mule and this will deleiver a FunctionalTestNotification for every message received by this service

Returns:

the callback to call when a message is received

See Also:

FunctionalTestNotification, FunctionalTestNotificationListener

setEventCallback

public void setEventCallback(EventCallback eventCallback)

An event callback is called when a message is received by the service. An Event callback isn't strictly required but it is useful for performing assertions on the current message being received. Note that the FunctionalTestProcessor should be made a singleton when using Event callbacks

Another option is to register a FunctionalTestNotificationListener with Mule and this will deleiver a FunctionalTestNotification for every message received by this service

Parameters:

eventCallback - the callback to call when a message is received

See Also:

FunctionalTestNotification, FunctionalTestNotificationListener

getReturnData

public Object getReturnData()

Often you will may want to return a fixed message payload to simulate and external system call. This can be done using the 'returnData' property. Note that you can return complex objects by using the element in the Xml configuration.

Returns:

the message payload to always return from this service instance

setReturnData

public void setReturnData(Object returnData)

Often you will may want to return a fixed message payload to simulate and external system call. This can be done using the 'returnData' property. Note that you can return complex objects by using the element in the Xml configuration.

Parameters:

returnData - the message payload to always return from this service instance

isThrowException

public boolean isThrowException()

Sometimes you will want the service to always throw an exception, if this is the case you can set the 'throwException' property to true.

Returns:

throwException true if an exception should always be thrown from this instance. If the getReturnData() property is set and is of type java.lang.Exception, that exception will be thrown.

setThrowException

public void setThrowException(boolean throwException)

Sometimes you will want the service to always throw an exception, if this is the case you can set the 'throwException' property to true.

Parameters:

throwException - true if an exception should always be thrown from this instance. If the getReturnData() property is set and is of type java.lang.Exception, that exception will be thrown.

isEnableMessageHistory

public boolean isEnableMessageHistory()

setEnableMessageHistory

public void setEnableMessageHistory(boolean enableMessageHistory)

getReceivedMessagesCount

public int getReceivedMessagesCount()

If enableMessageHistory = true, returns the number of messages received by this service.

Returns:

-1 if no message history, otherwise the history size

getReceivedMessage

public Event getReceivedMessage(int number)

If enableMessageHistory = true, returns a message received by the service in chronological order. For example, getReceivedMessage(1) returns the first message received by the service, getReceivedMessage(2) returns the second message received by the service, etc.

getLastReceivedMessage

public Event getLastReceivedMessage()

If enableMessageHistory = true, returns the last message received by the service in chronological order.

getAppendString

public String getAppendString()

setAppendString

public void setAppendString(String appendString)

isEnableNotifications

public boolean isEnableNotifications()

setEnableNotifications

public void setEnableNotifications(boolean enableNotifications)

getExceptionToThrow

public Class<? extends Throwable> getExceptionToThrow()

setExceptionToThrow

public void setExceptionToThrow(Class<? extends Throwable> exceptionToThrow)

getWaitTime

public long getWaitTime()

setWaitTime

public void setWaitTime(long waitTime)

isLogMessageDetails

public boolean isLogMessageDetails()

setLogMessageDetails

public void setLogMessageDetails(boolean logMessageDetails)

getExceptionText

public String getExceptionText()

setExceptionText

public void setExceptionText(String text)

setId

public void setId(String id)

addLifecycleCallback

public static void addLifecycleCallback(FunctionalTestProcessor.LifecycleCallback callback)

removeLifecycleCallback

public static void removeLifecycleCallback(FunctionalTestProcessor.LifecycleCallback callback)

getFromFlow

public static FunctionalTestProcessor getFromFlow(MuleContext muleContext,
                                                  String flowName)
                                           throws Exception

Returns:

the first test:processor from a flow with the provided name.

Throws:

Exception