org.mule.functional.api.flow

Class FlowConstructRunner<R extends FlowConstructRunner>

java.lang.Object

org.mule.functional.api.flow.FlowConstructRunner<R>

Type Parameters:

R - the runner class for a FlowConstruct implementation.

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable

Direct Known Subclasses:

FlowRunner

public abstract class FlowConstructRunner<R extends FlowConstructRunner>
extends Object
implements org.mule.runtime.api.lifecycle.Disposable

Provides a fluent API for running events through batch FlowConstructs.

Field Summary

Fields

Modifier and Type	Field and Description
protected TestEventBuilder	eventBuilder
protected org.mule.runtime.api.artifact.Registry	registry

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
FlowConstructRunner(org.mule.runtime.api.artifact.Registry registry) Initializes this runner with a mule context.

Method Summary

Modifier and Type	Method and Description
CoreEvent	buildEvent() Builds a new event based on this runner's config.
void	dispose()
protected FlowConstruct	getFlowConstruct()
abstract String	getFlowConstructName()
protected CoreEvent	getOrBuildEvent()
void	reset() Clears the last built requestEvent, allowing for reuse of this runner.
R	spyObjects() Will spy the built Message and CoreEvent.
R	withAttributes(Object attributes) Prepares the given data to be sent as the attributes of the CoreEvent to the configured flow.
R	withCorrelation(GroupCorrelation correlation) Deprecated. use withItemSequenceInfo(ItemSequenceInfo)
R	withInboundAttachment(String key, DataHandler value) Deprecated. Transport infrastructure is deprecated.
R	withInboundProperties(Map<String,Serializable> properties) Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.
R	withInboundProperty(String key, Serializable value) Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.
R	withItemSequenceInfo(org.mule.runtime.api.message.ItemSequenceInfo itemSequenceInfo) Configures the product event to have the provided itemSequenceInfo.
R	withMediaType(org.mule.runtime.api.metadata.MediaType mediaType) Prepares the given data to be sent as the mediaType of the payload of the CoreEvent to the configured flow.
R	withOutboundProperty(String key, Serializable value) Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.
R	withPayload(Object payload) Prepares the given data to be sent as the payload of the CoreEvent to the configured flow.
R	withSessionProperty(String key, Object value) Deprecated. Transport infrastructure is deprecated.
R	withSourceCorrelationId(String sourceCorrelationId) Configures the product event to have the provided sourceCorrelationId.
R	withVariable(String key, Object value) Prepares a flow variable with the given key and value to be set in the Message to the configured flow.
R	withVariable(String key, Object value, org.mule.runtime.api.metadata.DataType dataType) Prepares a flow variable with the given key and value to be set in the Message to the configured flow.

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected org.mule.runtime.api.artifact.Registry registry

eventBuilder

protected TestEventBuilder eventBuilder

Constructor Detail

FlowConstructRunner

public FlowConstructRunner(org.mule.runtime.api.artifact.Registry registry)

Initializes this runner with a mule context.

Parameters:

registry - the registry for the currently running test

Method Detail

withPayload

public R withPayload(Object payload)

Prepares the given data to be sent as the payload of the CoreEvent to the configured flow.

Parameters:

payload - the payload to use in the message

Returns:

this FlowRunner

withMediaType

public R withMediaType(org.mule.runtime.api.metadata.MediaType mediaType)

Prepares the given data to be sent as the mediaType of the payload of the CoreEvent to the configured flow.

Parameters:

mediaType - the mediaType to use in the message

Returns:

this FlowRunner

withAttributes

public R withAttributes(Object attributes)

Prepares the given data to be sent as the attributes of the CoreEvent to the configured flow.

Parameters:

attributes - the message attributes

Returns:

this FlowRunner

withInboundProperty

@Deprecated
public R withInboundProperty(String key,
                                         Serializable value)

Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.

Prepares a property with the given key and value to be sent as an inbound property of the Message to the configured flow.

Parameters:

key - the key of the inbound property to add

value - the value of the inbound property to add

Returns:

this FlowRunner

withInboundProperties

@Deprecated
public R withInboundProperties(Map<String,Serializable> properties)

Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.

Prepares the given properties map to be sent as inbound properties of the Message to the configured flow.

Parameters:

properties - the inbound properties to add

Returns:

this FlowRunner

withOutboundProperty

@Deprecated
public R withOutboundProperty(String key,
                                          Serializable value)

Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.

Prepares a property with the given key and value to be sent as an outbound property of the Message to the configured flow.

Parameters:

key - the key of the outbound property to add

value - the value of the outbound property to add

Returns:

this FlowRunner

withInboundAttachment

@Deprecated
public R withInboundAttachment(String key,
                                           DataHandler value)

Deprecated. Transport infrastructure is deprecated.

Prepares an attachment with the given key and value to be sent in the Message to the configured flow.

Parameters:

key - the key of the attachment to add

value - the DataHandler for the attachment to add

Returns:

this FlowRunner

withSessionProperty

@Deprecated
public R withSessionProperty(String key,
                                         Object value)

Deprecated. Transport infrastructure is deprecated.

Prepares a property with the given key and value to be sent as a session property of the Message to the configured flow.

Parameters:

key - the key of the session property to add

value - the value of the session property to add

Returns:

this FlowRunner

withSourceCorrelationId

public R withSourceCorrelationId(String sourceCorrelationId)

Configures the product event to have the provided sourceCorrelationId. See Event.getCorrelationId().

Returns:

this TestEventBuilder

withCorrelation

public R withCorrelation(GroupCorrelation correlation)

Deprecated. use withItemSequenceInfo(ItemSequenceInfo)

Configures the product event to have the provided correlation. See CoreEvent.getGroupCorrelation().

Returns:

this TestEventBuilder

withItemSequenceInfo

public R withItemSequenceInfo(org.mule.runtime.api.message.ItemSequenceInfo itemSequenceInfo)

Configures the product event to have the provided itemSequenceInfo. See Event.getItemSequenceInfo().

Returns:

this TestEventBuilder

withVariable

public R withVariable(String key,
                      Object value)

Prepares a flow variable with the given key and value to be set in the Message to the configured flow.

Parameters:

key - the key of the flow variable to put

value - the value of the flow variable to put

Returns:

this FlowRunner

withVariable

public R withVariable(String key,
                      Object value,
                      org.mule.runtime.api.metadata.DataType dataType)

Prepares a flow variable with the given key and value to be set in the Message to the configured flow.

Parameters:

key - the key of the flow variable to put

value - the value of the flow variable to put

dataType - the value data type

Returns:

this FlowRunner

spyObjects

public R spyObjects()

Will spy the built Message and CoreEvent. See spy.

Returns:

this FlowRunner

getOrBuildEvent

protected CoreEvent getOrBuildEvent()

buildEvent

public CoreEvent buildEvent()

Builds a new event based on this runner's config. If one has already been built, it will fail.

Returns:

an event that would be used to go through the flow.

getFlowConstruct

protected FlowConstruct getFlowConstruct()

reset

public void reset()

Clears the last built requestEvent, allowing for reuse of this runner.

getFlowConstructName

public abstract String getFlowConstructName()

Returns:

the name of the FlowConstruct to use.

dispose

public void dispose()

Specified by:

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