org.ikasan.framework.event.service
Class SinglePayloadPerEventProvider

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

All Implemented Interfaces:

EventProvider

public class SinglePayloadPerEventProvider
extends Object
implements EventProvider

Implementation of EventProvider. This implementation returns an Event per sourced payload. The purpose of this is to ensure that unrelated payloads are not unnecessarily grouped into a single Event whilst at the same time ensuring maximum performance in terms of sourcing multiple payloads in one hit. NOTE: Although an Event per payload is created and returned it is the responsibility of the flow implementer to maintain Event independence, if required, when using transactions. If no payloads are present then the Event is not created and 'null' is returned.

Author:

Ikasan Development Team

Constructor Summary

SinglePayloadPerEventProvider(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

SinglePayloadPerEventProvider

public SinglePayloadPerEventProvider(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