oracle.integration.platform.blocks.event.jms2

Interface EdnJmsEventReader

public interface EdnJmsEventReader

This interface represents an EDN event reader, the implementation is backed by a JMS TopicSubscriber instance, caller reads event from the underlying JMS TopicSubscriber through read methods: read() or read(long) An object of BusinessEvent is returned or null if there is no event available or event read timed out. In EDN Java Client API framework, an instance of EdnJmsEventReader is internally created by EdnJmsEventSubscriber which is in turn created by invoking subscribe API methods through EdnJmsConnection. Through interfaces EdnJmsEventSubscriber and EdnJmsEventReader, the client code has fine grained control over the event consuming: Specifically, EdnJmsEventReader allows single event read such that the client code is responsible for event consumption details such as how events be polled. Note, client code is not suppose to provide implementation of this interface, nor instantiate an instance directly, EDN Java Client API framework provides implementation and return an instance as the result of calling one of the below subscribe methods from class EdnJmsConnection: EdnJmsConnection.subscribeOnly(EdnSubscribeContext) EdnJmsConnection.subscribeOnly(javax.xml.namespace.QName, String) EdnJmsConnection.subscribeOnly(javax.xml.namespace.QName, oracle.fabric.blocks.event.ConsistencyLevel, oracle.fabric.blocks.event.XPathFilter, oracle.fabric.blocks.event.BusinessEventHandler, boolean, long, String)

Since:

12.2.1

Method Summary

Modifier and Type	Method and Description
EdnJmsEventSubscriber	getEdnEventSubscriber() Get the EdnJmsEventSubscriber instance associated with this EdnJmsEventReader instance
BusinessEvent	read() Read (consume) one event from the EDN JMS topic and return it to the caller
BusinessEvent	read(long timeout) Read (consume) one event from the EDN JMS topic and return it to the caller

Method Detail

read

BusinessEvent read()

Read (consume) one event from the EDN JMS topic and return it to the caller

Returns:

- event read from the topic, null - when there is no event or event read timeout

read

BusinessEvent read(long timeout)

Read (consume) one event from the EDN JMS topic and return it to the caller

Parameters:

timeout - - timeout (in millisecond) for receiving event

Returns:

the event received, or null when there is no event or event receive timeout

getEdnEventSubscriber

EdnJmsEventSubscriber getEdnEventSubscriber()

Get the EdnJmsEventSubscriber instance associated with this EdnJmsEventReader instance

Returns:

- the instance of EdnJmsEventSubscriber