org.mule.munit.common.event

Class EventBuilder

java.lang.Object

org.mule.munit.common.event.EventBuilder

public class EventBuilder
extends Object

This class provides a friendly API to build a Event

Since:

2.0.0

Author:

Mulesoft Inc.

Constructor Summary

Constructors

Constructor and Description
EventBuilder(org.mule.runtime.api.component.location.ComponentLocation location) Creates the event builder from a flow construct
EventBuilder(org.mule.runtime.api.event.Event originalEvent) Creates the event builder from an event
EventBuilder(org.mule.runtime.api.event.EventContext eventContext) Creates the event builder from an event context and a flow construct

Method Summary

Modifier and Type	Method and Description
EventBuilder	addInboundAttachment(String key, DataHandler value) Prepares an attachment with the given key and value to be sent in the product.
EventBuilder	addInboundProperty(String key, Serializable value) Prepares a property with the given key and value to be sent as an inbound property of the product.
EventBuilder	addInboundProperty(String key, Serializable value, String mediaType, String charset) Prepares a property with the given key and value to be sent as an inbound property of the product.
EventBuilder	addOutboundAttachment(String key, DataHandler value) Prepares an attachment with the given key and value to be sent in the product.
EventBuilder	addOutboundProperty(String key, Serializable value) Prepares a property with the given key and value to be sent as an outbound property of the product.
EventBuilder	addOutboundProperty(String key, Serializable value, String mediaType, String charset) Prepares a property with the given key and value to be sent as an outbound property of the product.
EventBuilder	addSessionProperty(String key, Object value) Prepares a property with the given key and value to be sent as a session property of the product.
EventBuilder	addSessionProperty(String key, Object value, String mediaType, String charset) Prepares a property with the given key and value to be sent as a session property of the product.
EventBuilder	addVariable(String key, Object value) Prepares a flow variable with the given key and value to be set in the product.
EventBuilder	addVariable(String key, Object value, String mediaType, String charset) Prepares a flow variable with the given key and value to be set in the product.
org.mule.runtime.api.event.Event	build() Produces an event with the specified configuration.
EventBuilder	clearSessionProperties() Clears the session properties map
EventBuilder	withAttributes(Object attributes) Sets the Message.getAttributes() value of the produced message
EventBuilder	withAttributes(Object attributes, String mediaType, String charset) Prepares a flow variable with the given key and value to be set in the product.
EventBuilder	withError(org.mule.runtime.api.message.ErrorType errorType, Throwable exception) Prepares the error to be added to the event
EventBuilder	withGroupCorrelation(org.mule.runtime.core.api.message.GroupCorrelation correlation) Configures the product event to have the provided correlation.
EventBuilder	withInboundAttachments(Map<String,DataHandler> inboundAttachments) Prepares the outbound attachments with the given map.
EventBuilder	withInboundProperties(Map<String,Serializable> inboundProperties) Prepares the inbound properties with the given map.
EventBuilder	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.
EventBuilder	withOutboundAttachments(Map<String,DataHandler> outboundAttachments) Prepares the outbound attachments with the given map.
EventBuilder	withOutboundProperties(Map<String,Serializable> outboundProperties) Prepares the outbound properties with the given map.
EventBuilder	withPayload(Object payload) Prepares the given data to be sent as the payload of the product.
EventBuilder	withReplyToHandler(org.mule.runtime.core.privileged.connector.ReplyToHandler replyToHandler) Configures the product event to have the provided ReplyToHandler.
EventBuilder	withSessionProperties(Map<String,org.mule.runtime.api.metadata.TypedValue<Serializable>> sessionProperties) Prepares the session properties with the given map.
EventBuilder	withSourceCorrelationId(String sourceCorrelationId) Configures the product event to have the provided sourceCorrelationId.
EventBuilder	withVariables(Map<String,Object> variables) Prepares the flow variables with the given map.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBuilder

public EventBuilder(org.mule.runtime.api.component.location.ComponentLocation location)

Creates the event builder from a flow construct

Parameters:

location - location from where to create the new event

EventBuilder

public EventBuilder(org.mule.runtime.api.event.EventContext eventContext)

Creates the event builder from an event context and a flow construct

Parameters:

eventContext - Flow construct from where to create the new event

EventBuilder

public EventBuilder(org.mule.runtime.api.event.Event originalEvent)

Creates the event builder from an event

Parameters:

originalEvent - Base event from where to create the new one

Method Detail

withPayload

public EventBuilder 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 EventBuilder

withMediaType

public EventBuilder 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 EventBuilder

withAttributes

public EventBuilder withAttributes(Object attributes)

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

Parameters:

attributes - the attributes object for the produced Message

Returns:

this EventBuilder

withAttributes

public EventBuilder withAttributes(Object attributes,
                                   String mediaType,
                                   String charset)

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

Parameters:

attributes - the attributes object for the produced Message

mediaType - the media type of the variable to add

charset - the charset of the property to add

Returns:

this EventBuilder

addVariable

public EventBuilder addVariable(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 EventBuilder

addVariable

public EventBuilder addVariable(String key,
                                Object value,
                                String mediaType,
                                String charset)

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

mediaType - the media type of the variable to add

charset - the charset of the property to add

Returns:

this EventBuilder

withVariables

public EventBuilder withVariables(Map<String,Object> variables)

Prepares the flow variables with the given map. Should the map be null or empty the new event will contain an empty map. Otherwise the content will be added to the pre existing map.

Parameters:

variables - the map to be set

Returns:

this EventBuilder

addSessionProperty

public EventBuilder addSessionProperty(String key,
                                       Object value)

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 EventBuilder

addSessionProperty

public EventBuilder addSessionProperty(String key,
                                       Object value,
                                       String mediaType,
                                       String charset)

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

mediaType - the media type of the property to add

charset - the charset of the property to add

Returns:

this EventBuilder

withSessionProperties

public EventBuilder withSessionProperties(Map<String,org.mule.runtime.api.metadata.TypedValue<Serializable>> sessionProperties)

Prepares the session properties with the given map. Should the map be null or empty the new event will contain an empty map. Otherwise the content will be added to the pre existing map.

Parameters:

sessionProperties - the map to be set

Returns:

this EventBuilder

clearSessionProperties

public EventBuilder clearSessionProperties()

Clears the session properties map

Returns:

this EventBuilder

addInboundProperty

public EventBuilder addInboundProperty(String key,
                                       Serializable value)

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 EventBuilder

addInboundProperty

public EventBuilder addInboundProperty(String key,
                                       Serializable value,
                                       String mediaType,
                                       String charset)

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

mediaType - the media type of the property to add

charset - the charset of the property to add

Returns:

this EventBuilder

withInboundProperties

public EventBuilder withInboundProperties(Map<String,Serializable> inboundProperties)

Prepares the inbound properties with the given map. Should the map be null or empty the new event will contain an empty map. Otherwise the content will be added to the pre existing map.

Parameters:

inboundProperties - the map to be set

Returns:

this EventBuilder

addOutboundProperty

public EventBuilder addOutboundProperty(String key,
                                        Serializable value)

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 EventBuilder

addOutboundProperty

public EventBuilder addOutboundProperty(String key,
                                        Serializable value,
                                        String mediaType,
                                        String charset)

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

mediaType - the media type of the property to add

charset - the charset of the property to add

Returns:

this EventBuilder

withOutboundProperties

public EventBuilder withOutboundProperties(Map<String,Serializable> outboundProperties)

Prepares the outbound properties with the given map. Should the map be null or empty the new event will contain an empty map. Otherwise the content will be added to the pre existing map.

Parameters:

outboundProperties - the map to be set

Returns:

this EventBuilder

addOutboundAttachment

public EventBuilder addOutboundAttachment(String key,
                                          DataHandler value)

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 EventBuilder

withOutboundAttachments

public EventBuilder withOutboundAttachments(Map<String,DataHandler> outboundAttachments)

Prepares the outbound attachments with the given map. Should the map be null or empty the new event will contain an empty map. Otherwise the content will be added to the pre existing map.

Parameters:

outboundAttachments - the map to be set

Returns:

this EventBuilder

addInboundAttachment

public EventBuilder addInboundAttachment(String key,
                                         DataHandler value)

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 EventBuilder

withInboundAttachments

public EventBuilder withInboundAttachments(Map<String,DataHandler> inboundAttachments)

Prepares the outbound attachments with the given map. Should the map be null or empty the new event will contain an empty map. Otherwise the content will be added to the pre existing map.

Parameters:

inboundAttachments - the map to be set

Returns:

this EventBuilder

withSourceCorrelationId

public EventBuilder withSourceCorrelationId(String sourceCorrelationId)

Configures the product event to have the provided sourceCorrelationId.

Returns:

this EventBuilder

withGroupCorrelation

public EventBuilder withGroupCorrelation(org.mule.runtime.core.api.message.GroupCorrelation correlation)

Configures the product event to have the provided correlation.

Returns:

this EventBuilder

withReplyToHandler

public EventBuilder withReplyToHandler(org.mule.runtime.core.privileged.connector.ReplyToHandler replyToHandler)

Configures the product event to have the provided ReplyToHandler.

Returns:

this EventBuilder

withError

public EventBuilder withError(org.mule.runtime.api.message.ErrorType errorType,
                              Throwable exception)

Prepares the error to be added to the event

Parameters:

errorType - the type of the error

exception - the exception of the error

Returns:

this EventBuilder

build

public org.mule.runtime.api.event.Event build()

Produces an event with the specified configuration.

Returns:

an event with the specified configuration.