org.mule.functional.api.flow

Class TestEventBuilder

java.lang.Object

org.mule.functional.api.flow.TestEventBuilder

public class TestEventBuilder
extends Object

Provides a fluent API for building events for testing.

Constructor Summary

Constructors

Constructor and Description
TestEventBuilder()

Method Summary

Modifier and Type	Method and Description
CoreEvent	build(FlowConstruct flow) Produces an event with the specified configuration.
TestEventBuilder	setExternalCompletionCallback(CompletableFuture<Void> externalCompletionCallback)
TestEventBuilder	spyObjects() Will spy the built Message and CoreEvent.
TestEventBuilder	withAttributes(Object attributes) Sets the Message.getAttributes() value of the produced message
TestEventBuilder	withCorrelation(GroupCorrelation groupCorrelation) Deprecated. use withItemSequenceInfo(ItemSequenceInfo) instead
TestEventBuilder	withInboundAttachment(String key, DataHandler value) Deprecated. Transport infrastructure is deprecated.
TestEventBuilder	withInboundProperties(Map<String,Serializable> properties) Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.
TestEventBuilder	withInboundProperty(String key, Serializable value) Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.
TestEventBuilder	withItemSequenceInfo(org.mule.runtime.api.message.ItemSequenceInfo itemSequenceInfo) Configures the product event to have the provided itemSequenceInfo.
TestEventBuilder	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.
TestEventBuilder	withOutboundProperty(String key, Serializable value) Deprecated. Transport infrastructure is deprecated. Use Message.getAttributes() instead.
TestEventBuilder	withPayload(Object payload) Prepares the given data to be sent as the payload of the product.
TestEventBuilder	withSessionProperty(String key, Object value) Deprecated. Transport infrastructure is deprecated.
TestEventBuilder	withSourceCorrelationId(String sourceCorrelationId) Configures the product event to have the provided sourceCorrelationId.
TestEventBuilder	withVariable(String key, Object value) Prepares a flow variable with the given key and value to be set in the product.
TestEventBuilder	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 product.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestEventBuilder

public TestEventBuilder()

Method Detail

withPayload

public TestEventBuilder withPayload(Object payload)

Prepares the given data to be sent as the payload of the product.

Parameters:

payload - the payload to use in the message

Returns:

this TestEventBuilder

withMediaType

public TestEventBuilder 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 TestEventBuilder withAttributes(Object attributes)

Sets the Message.getAttributes() value of the produced message

Parameters:

attributes - the attributes object for the produced Message

Returns:

this TestEventBuilder

withInboundProperty

@Deprecated
public TestEventBuilder 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 product.

Parameters:

key - the key of the inbound property to add

value - the value of the inbound property to add

Returns:

this TestEventBuilder

withInboundProperties

@Deprecated
public TestEventBuilder 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 product.

Parameters:

properties - the inbound properties to add

Returns:

this TestEventBuilder

withOutboundProperty

@Deprecated
public TestEventBuilder 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 product.

Parameters:

key - the key of the outbound property to add

value - the value of the outbound property to add

Returns:

this TestEventBuilder

withInboundAttachment

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

Deprecated. Transport infrastructure is deprecated.

Prepares an attachment with the given key and value to be sent in the product.

Parameters:

key - the key of the attachment to add

value - the DataHandler for the attachment to add

Returns:

this TestEventBuilder

withSessionProperty

@Deprecated
public TestEventBuilder 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 product.

Parameters:

key - the key of the session property to add

value - the value of the session property to add

Returns:

this TestEventBuilder

withSourceCorrelationId

public TestEventBuilder withSourceCorrelationId(String sourceCorrelationId)

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

Returns:

this TestEventBuilder

withCorrelation

public TestEventBuilder withCorrelation(GroupCorrelation groupCorrelation)

Deprecated. use withItemSequenceInfo(ItemSequenceInfo) instead

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

Returns:

this TestEventBuilder

withItemSequenceInfo

public TestEventBuilder 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 TestEventBuilder withVariable(String key,
                                     Object value)

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

Parameters:

key - the key of the flow variable to put

value - the value of the flow variable to put

Returns:

this TestEventBuilder

withVariable

public TestEventBuilder 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 product.

Parameters:

key - the key of the flow variable to put

value - the value of the flow variable to put

dataType - the data type of the variable

Returns:

this TestEventBuilder

spyObjects

public TestEventBuilder spyObjects()

Will spy the built Message and CoreEvent. See spy.

Returns:

this TestEventBuilder

setExternalCompletionCallback

public TestEventBuilder setExternalCompletionCallback(CompletableFuture<Void> externalCompletionCallback)

build

public CoreEvent build(FlowConstruct flow)

Produces an event with the specified configuration.

Parameters:

flow - the recipient for the event to be built.

Returns:

an event with the specified configuration.