oracle.integration.platform.blocks.event.jms2

Interface EdnJmsEventSubscriber

All Superinterfaces:

Runnable

public interface EdnJmsEventSubscriber
extends Runnable

This interface represents an EDN event subscriber (consumer) which is able to: (1) poll events continuously where the caller starts event consuming and control / monitor the process - e.g. switch on/off the events in-flow, filtering/processing the events received (through event handler), and eventually shutdown the process (stop consuming) or (2) perform single event read where the event is returned to the caller directly, the client code decides how events are to be polled, this is done through event reader interface EdnJmsEventReader getEventReader() EdnJmsEventReader Methods are exposed to provide fine grained control over the EDN event consuming process, e.g.: start/stop the polling of events: startup() shutdown() temporarily switch on/off event delivery from the underlying JMS topic: deliveryOn() deliveryOff() In EDN Java Client API, this interface is not suppose to be implemented by client code directly, implementation is provided internally by the API framework, instance of EdnJmsEventSubscriber is created and returned as result of calling subscribe methods from EdnJmsConnection, see below: 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
void	deliveryOff() Temporarily disable event delivery of underlying JMS TopicConnection, calling deliveryOn() will resume the suspended event delivery.
void	deliveryOn() Enable event delivery of underlying JMS TopicConnection, calling deliveryOn() when delivery is already on is ignored.
EdnJmsEventReader	getEventReader() Get the event reader associated with the subscriber.
boolean	isRunning() Check if the event receiving thread is running.
void	setIsRunning(boolean b) Set running state of the underlying event receiving thread.
void	shutdown() Stop the thread receiving event from underlying EDN JMS topic subscriber.
void	startup() Start the thread receiving (consuming) the event from underlying EDN JMS topic, the daemon nature of the event receiving thread inherits that of the creating thread.
void	startup(boolean daemon) Start the thread receiving event from underlying EDN JMS topic subscriber.
void	waitOnReceiver() Wait on the event receiving thread to complete (blocking the caller).
void	waitOnReceiver(long threadJoinTimeout) Wait on the event receiving thread to complete (blocking the caller) with a timeout.

Methods inherited from interface java.lang.Runnable

run

Method Detail

startup

void startup()

Start the thread receiving (consuming) the event from underlying EDN JMS topic, the daemon nature of the event receiving thread inherits that of the creating thread.

startup

void startup(boolean daemon)

Start the thread receiving event from underlying EDN JMS topic subscriber.

Parameters:

daemon - - flag indicating if the underlying thread is of daemon thread (true) or not (false)

shutdown

void shutdown()

Stop the thread receiving event from underlying EDN JMS topic subscriber.

deliveryOn

void deliveryOn()
         throws Exception

Enable event delivery of underlying JMS TopicConnection, calling deliveryOn() when delivery is already on is ignored.

Throws:

Exception - - when error occurs

deliveryOff

void deliveryOff()
          throws Exception

Temporarily disable event delivery of underlying JMS TopicConnection, calling deliveryOn() will resume the suspended event delivery.

Throws:

Exception - - when error occurs

getEventReader

EdnJmsEventReader getEventReader()

Get the event reader associated with the subscriber.

Returns:

the event reader

isRunning

boolean isRunning()

Check if the event receiving thread is running.

Returns:

true - thread is running, false - the thread has been stopped or the thread has not been started yet.

setIsRunning

void setIsRunning(boolean b)

Set running state of the underlying event receiving thread. (usually used internally by implementation)

Parameters:

b - - the flag indicates the running state of the underlying event receiving thread

waitOnReceiver

void waitOnReceiver()
             throws InterruptedException

Wait on the event receiving thread to complete (blocking the caller). Internally, thread join() called upon the underlying event receiving thread.

Throws:

InterruptedException - when the underlying event receiving thread is interrupted

waitOnReceiver

void waitOnReceiver(long threadJoinTimeout)
             throws InterruptedException

Wait on the event receiving thread to complete (blocking the caller) with a timeout. Internally, thread join() called upon the underlying event receiving thread.

Parameters:

threadJoinTimeout - - the timeout (in millisecond) for joining the underlying event receiving thread

Throws:

InterruptedException - when the underlying event receiving thread is interrupted