org.ikasan.framework.event.service
Class MultiPayloadPerEventProvider

java.lang.Object
  org.ikasan.framework.event.service.MultiPayloadPerEventProvider

All Implemented Interfaces:

EventProvider

public class MultiPayloadPerEventProvider
extends Object
implements EventProvider

Implementation of EventProvider.
This implementation returns a single Event containing all sourced payloads.
The purpose of this is to keep 'related' payloads within the logical unit of a single Event.
If no payloads are present then the Event is not created and 'null' is returned.

Author:

Ikasan Development Team

Constructor Summary

MultiPayloadPerEventProvider(PayloadProvider payloadProvider, String moduleName, String componentName)
Constructor

Method Summary

List<Event>

getEvents() Returns a List of Events known to this EventProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPayloadPerEventProvider

public MultiPayloadPerEventProvider(PayloadProvider payloadProvider,
                                    String moduleName,
                                    String componentName)

Constructor

Parameters:

payloadProvider - The payload provider

moduleName - The name of the module

componentName - The name of the component

Method Detail

getEvents

public List<Event> getEvents()
                      throws javax.resource.ResourceException

Description copied from interface: EventProvider

Returns a List of Events known to this EventProvider

Specified by:

getEvents in interface EventProvider

Returns:

List of Events, or null if none available

Throws:

javax.resource.ResourceException - Exception if events could not be retrieved