org.mule.functional.junit4

Class TestEventBuilder

java.lang.Object

org.mule.functional.junit4.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
Event	build(MuleContext muleContext, FlowConstruct flow) Produces an event with the specified configuration.
TestEventBuilder	spyObjects() Will spy the built Message and Event.
TestEventBuilder	withAttributes(org.mule.runtime.api.message.Attributes attributes) Sets the Message.getAttributes() value of the produced message
TestEventBuilder	withCorrelation(GroupCorrelation correlation) Configures the product event to have the provided correlation.
TestEventBuilder	withInboundAttachment(String key, DataHandler value) Deprecated. Transport infrastructure is deprecated. Use DefaultMultiPartPayload instead.
TestEventBuilder	withInboundProperties(Map<String,Serializable> properties) Deprecated. Transport infrastructure is deprecated. Use Attributes instead.
TestEventBuilder	withInboundProperty(String key, Serializable value) Deprecated. Transport infrastructure is deprecated. Use Attributes instead.
TestEventBuilder	withMediaType(org.mule.runtime.api.metadata.MediaType mediaType) Prepares the given data to be sent as the mediaType of the payload of the Event to the configured flow.
TestEventBuilder	withOutboundAttachment(String key, DataHandler value) Deprecated. Transport infrastructure is deprecated. Use DefaultMultiPartPayload instead.
TestEventBuilder	withOutboundAttachment(String key, Object object, org.mule.runtime.api.metadata.MediaType contentType) Deprecated. Transport infrastructure is deprecated. Use DefaultMultiPartPayload instead.
TestEventBuilder	withOutboundProperty(String key, Serializable value) Deprecated. Transport infrastructure is deprecated. Use Attributes instead.
TestEventBuilder	withPayload(Object payload) Prepares the given data to be sent as the payload of the product.
TestEventBuilder	withReplyToHandler(ReplyToHandler replyToHandler) Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.
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.

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 Event to the configured flow.

Parameters:

mediaType - the mediaType to use in the message

Returns:

this FlowRunner

withAttributes

public TestEventBuilder withAttributes(org.mule.runtime.api.message.Attributes 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 Attributes 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 Attributes 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 Attributes 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

withOutboundAttachment

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

Deprecated. Transport infrastructure is deprecated. Use DefaultMultiPartPayload instead.

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

withOutboundAttachment

@Deprecated
public TestEventBuilder withOutboundAttachment(String key,
                                                           Object object,
                                                           org.mule.runtime.api.metadata.MediaType contentType)

Deprecated. Transport infrastructure is deprecated. Use DefaultMultiPartPayload instead.

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

Parameters:

key - the key of the attachment to add

object - the content of the attachment to add

contentType - the content type of the attachment to add. Note that the charset attribute can be specifed too i.e. text/plain;charset=UTF-8

Returns:

this TestEventBuilder

withInboundAttachment

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

Deprecated. Transport infrastructure is deprecated. Use DefaultMultiPartPayload instead.

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 correlation)

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

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

withReplyToHandler

@Deprecated
public TestEventBuilder withReplyToHandler(ReplyToHandler replyToHandler)

Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.

Configures the product event to have the provided ReplyToHandler.

Returns:

this TestEventBuilder

spyObjects

public TestEventBuilder spyObjects()

Will spy the built Message and Event. See spy.

Returns:

this TestEventBuilder

build

public Event build(MuleContext muleContext,
                   FlowConstruct flow)

Produces an event with the specified configuration.

Parameters:

muleContext - the context of the mule application

flow - the recipient for the event to be built.

Returns:

an event with the specified configuration.