oracle.integration.platform.blocks.event.jms2

Class EdnJmsConnection

java.lang.Object

oracle.integration.platform.blocks.event.jms2.BaseEdnConnection

oracle.integration.platform.blocks.event.jms2.EdnJmsConnection

All Implemented Interfaces:

BusinessEventConnection, EdnConnection

public final class EdnJmsConnection
extends BaseEdnConnection

Remote EDN connection where events can be published and subscribed. The implementation of this class is based on plain JMS API, and is typically used by J2SE client.

Since:

12.1.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	JNDI_DEFAULT_AQJMS_LOCALTX_CONN_FACTORY
static String	JNDI_DEFAULT_AQJMS_XA_CONN_FACTORY
static String	JNDI_DEFAULT_WLJMS_LOCALTX_CONN_FACTORY
static String	JNDI_DEFAULT_WLJMS_XA_CONN_FACTORY

Constructor Summary

Constructors

Constructor and Description
EdnJmsConnection(Context ctx) Construct a remote JMS Connection to EDN.

Method Summary

Modifier and Type	Method and Description
String	getClientID()
Context	getContext() get the JNDI context
javax.jms.TopicConnectionFactory	getTopicConnectionFactory() Get non-XA TopicConnectionFactory instance.
UserTransaction	getUserTransaction() Get UserTranasction instance for XA.
javax.jms.TopicConnectionFactory	getXaTopicConnectionFactory() Get XA TopicConnectionFactory instance.
void	publishEvent(BusinessEvent event) Publish an event with default persistent, priority, time to live, and EDL as input source.
void	publishEvent(BusinessEvent event, boolean persistent, int priority, long timeToLive, String edlURI) Publish an event with specified delivery mode, priority, time to live, and EDL URI.
void	publishEvent(BusinessEvent event, int priority) Publish an event with indicated priority
void	setClientID(String clientID)
void	setJmsConfig(JmsConfig config) Custom JmsConfig for all the events to be published and subscribed via this Event Connection.
void	setTopicConnectionFactory(javax.jms.TopicConnectionFactory topicConnectionFactory) Set a non-XA TopicConnectionFactory instance.
void	setUserTransaction(UserTransaction userTransaction)
void	setXaTopicConnectionFactory(javax.jms.TopicConnectionFactory xaTopicConnectionFactory) Set a XA TopicConnectionFactory instance.
void	subscribe(EdnSubscribeContext subscriptionContext) Subscribe to EDN JMS topic for EDN event and start receiving events immediately, parameters for subscription are included in and specified as subscriptionContext;
void	subscribe(QName eventName, ConsistencyLevel eventDeliverConsistencyLvl, XPathFilter eventFilter, BusinessEventHandler eventHandler, boolean runAsPublisher, long eventRecvTimeout, String durableSubscriberName) Subscribe to the EDN JMS topic for the specified event (specified as eventName), and start receiving events (consuming) immediately.
void	subscribe(QName eventName, String durableSubscriberName) Subscribe to the EDN JMS topic for the specified event (specified as eventName), and start receiving events (consuming) immediately.
EdnJmsEventSubscriber	subscribeOnly(EdnSubscribeContext subscriptionContex) Subscribe to EDN JMS topic for the event (specified as eventName), and return an instance of (EdnJmsEventSubscriber), allowing fine grained event consuming (switch on/off event delivery in-flow, read event etc.) through EdnJmsEventSubscriber and EdnJmsEventReader (the event reader can be obtained by EdnJmsEventSubscriber.getEventReader()).
EdnJmsEventSubscriber	subscribeOnly(QName eventName, ConsistencyLevel eventDeliverConsistencyLvl, XPathFilter eventFilter, BusinessEventHandler eventHandler, boolean runAsPublisher, long eventRecvTimeout, String durableSubscriberName) Subscribe to EDN JMS topic for the event (specified as eventName), and return an instance of (EdnJmsEventSubscriber), allowing fine grained event consuming (switch on/off event delivery in-flow, read event etc.) through EdnJmsEventSubscriber and EdnJmsEventReader (the event reader can be obtained by EdnJmsEventSubscriber.getEventReader()).
EdnJmsEventSubscriber	subscribeOnly(QName eventName, String durableSubscriberName) Subscribe to EDN JMS topic for the event (specified as eventName), and return an instance of (EdnJmsEventSubscriber), allowing fine grained event consuming (switch on/off event delivery in-flow, read event etc.) through EdnJmsEventSubscriber and EdnJmsEventReader (the event reader can be obtained by EdnJmsEventSubscriber.getEventReader()).
void	unsubscribe(EdnSubscribeContext subscriptionContex) Unsubscribe using parameter of EdnSubscribeContext;
void	unsubscribe(QName eventName, String durableSubscriberName) Unsubscribe (remove) the event subscriber indicated by durableSubscriberName.

Methods inherited from class oracle.integration.platform.blocks.event.jms2.BaseEdnConnection

close, getConsistencyLevel, getContextProvider, getEDL, getEDN, getEventHandler, getEventToJmsMapping, getPriority, getTimeout, getTimeToLive, getXPathFilter, isPersistent, isRunAsPublisher, setConsistencyLevel, setContextProvider, setEDL, setEDN, setEventHandler, setEventToJmsMapping, setPersistent, setPriority, setRunAsPublisher, setTimeout, setTimeToLive, setXPathFilter

Methods inherited from class java.lang.Object

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

Field Detail

JNDI_DEFAULT_WLJMS_XA_CONN_FACTORY

public static final String JNDI_DEFAULT_WLJMS_XA_CONN_FACTORY

See Also:

Constant Field Values

JNDI_DEFAULT_WLJMS_LOCALTX_CONN_FACTORY

public static final String JNDI_DEFAULT_WLJMS_LOCALTX_CONN_FACTORY

See Also:

Constant Field Values

JNDI_DEFAULT_AQJMS_XA_CONN_FACTORY

public static final String JNDI_DEFAULT_AQJMS_XA_CONN_FACTORY

See Also:

Constant Field Values

JNDI_DEFAULT_AQJMS_LOCALTX_CONN_FACTORY

public static final String JNDI_DEFAULT_AQJMS_LOCALTX_CONN_FACTORY

See Also:

Constant Field Values

Constructor Detail

EdnJmsConnection

public EdnJmsConnection(Context ctx)

Construct a remote JMS Connection to EDN.

Parameters:

ctx - - JNDI Context.

Method Detail

getTopicConnectionFactory

public javax.jms.TopicConnectionFactory getTopicConnectionFactory()

Get non-XA TopicConnectionFactory instance.

Returns:

non-XA TopicConnectionFactory instance.

setTopicConnectionFactory

public void setTopicConnectionFactory(javax.jms.TopicConnectionFactory topicConnectionFactory)

Set a non-XA TopicConnectionFactory instance.

Parameters:

topicConnectionFactory - - non-XA TopicConnectionFactory instance.

getXaTopicConnectionFactory

public javax.jms.TopicConnectionFactory getXaTopicConnectionFactory()

Get XA TopicConnectionFactory instance.

Returns:

XA TopicConnectionFactory instance.

setXaTopicConnectionFactory

public void setXaTopicConnectionFactory(javax.jms.TopicConnectionFactory xaTopicConnectionFactory)

Set a XA TopicConnectionFactory instance.

Parameters:

xaTopicConnectionFactory - - XA TopicConnectionFactory instance.

getUserTransaction

public UserTransaction getUserTransaction()

Get UserTranasction instance for XA.

Returns:

UserTranasction instance for XA.

setUserTransaction

public void setUserTransaction(UserTransaction userTransaction)

getClientID

public String getClientID()

setClientID

public void setClientID(String clientID)

publishEvent

public void publishEvent(BusinessEvent event)
                  throws oracle.fabric.common.FabricException

Description copied from interface: EdnConnection

Publish an event with default persistent, priority, time to live, and EDL as input source.

Specified by:

publishEvent in interface EdnConnection

Overrides:

publishEvent in class BaseEdnConnection

Parameters:

event - Business Event to be published

Throws:

oracle.fabric.common.FabricException - If it fails to publish the event with default options.

publishEvent

public void publishEvent(BusinessEvent event,
                         int priority)
                  throws oracle.fabric.common.FabricException

Description copied from interface: BusinessEventConnection

Publish an event with indicated priority

Specified by:

publishEvent in interface BusinessEventConnection

Overrides:

publishEvent in class BaseEdnConnection

Parameters:

event - - Business Event to be published

priority - - event priority

Throws:

oracle.fabric.common.FabricException - if fabric exception occurs

publishEvent

public void publishEvent(BusinessEvent event,
                         boolean persistent,
                         int priority,
                         long timeToLive,
                         String edlURI)
                  throws oracle.fabric.common.FabricException

Description copied from interface: EdnConnection

Publish an event with specified delivery mode, priority, time to live, and EDL URI.

Specified by:

publishEvent in interface EdnConnection

Overrides:

publishEvent in class BaseEdnConnection

Parameters:

event - Business Event to be published

persistent - Persistent (or non persistent) delivery mode

priority - Event priority

timeToLive - Time to live in milliseconds

edlURI - URI with "oramds" referencing Event definition content

Throws:

oracle.fabric.common.FabricException - If it fails to publish the event with specified options.

subscribe

public void subscribe(QName eventName,
                      ConsistencyLevel eventDeliverConsistencyLvl,
                      XPathFilter eventFilter,
                      BusinessEventHandler eventHandler,
                      boolean runAsPublisher,
                      long eventRecvTimeout,
                      String durableSubscriberName)
               throws oracle.fabric.common.FabricException

Subscribe to the EDN JMS topic for the specified event (specified as eventName), and start receiving events (consuming) immediately. Note, the JMS client ID of the corresponding durable subscriber will use the class instance level property EdnJmsConnection.getClientID()

Specified by:

subscribe in interface EdnConnection

Overrides:

subscribe in class BaseEdnConnection

Parameters:

eventName - - full name of event subscribe to

eventDeliverConsistencyLvl - - event delivery consistency level: OAOO or GUARANTEED

eventFilter - - xpath used to filter received event

eventHandler - - event handler for processing received event (filtered)

runAsPublisher - - a hint for EDN delivery security policy, when true, the event publisher's subject will be used when deliver event to further processing;

eventRecvTimeout - - timeout (in millisecond) for event receiving

durableSubscriberName - - name of durable subscriber to be created if presents, otherwise, non-durable subscriber will be created.

Throws:

oracle.fabric.common.FabricException - - Error during subscription.

See Also:

BaseEdnConnection.subscribe(javax.xml.namespace.QName, java.lang.String)

subscribe

public void subscribe(QName eventName,
                      String durableSubscriberName)
               throws oracle.fabric.common.FabricException

Subscribe to the EDN JMS topic for the specified event (specified as eventName), and start receiving events (consuming) immediately. Note, the JMS client ID of the corresponding durable subscriber will use the class instance level property EdnJmsConnection.getClientID() EDN consistency level : default to class instance consistency level EDN event filter: default to class instance event filter EDN event handler: default to class instance event handler EDN run as publisher: default to class instance value of run as publisher EDN event receiving (read) timeout (in millisecond) : default to class instance timeout value

Specified by:

subscribe in interface EdnConnection

Overrides:

subscribe in class BaseEdnConnection

Parameters:

eventName - - full name of event subscribe to

durableSubscriberName - - name of durable subscriber to be created if presents, otherwise, non-durable subscriber will be created.

Throws:

oracle.fabric.common.FabricException - - Error during subscription. Internally, this method delegates to below subscribe(...) with full parameters with those parameters not present taken from defaults:

See Also:

subscribeOnly(QName, ConsistencyLevel, XPathFilter, BusinessEventHandler, boolean, long, String)

subscribe

public void subscribe(EdnSubscribeContext subscriptionContext)

Subscribe to EDN JMS topic for EDN event and start receiving events immediately, parameters for subscription are included in and specified as subscriptionContext;

Parameters:

subscriptionContext - - subscribe context encapsulating parameters for creating EDN subscriber; Internally, this method delegates to below subscribe(...) with full parameters where the individual parameters obtained from the subscriptionContext.

See Also:

subscribe(QName, ConsistencyLevel, XPathFilter, BusinessEventHandler, boolean, long, String)

subscribeOnly

public EdnJmsEventSubscriber subscribeOnly(QName eventName,
                                           ConsistencyLevel eventDeliverConsistencyLvl,
                                           XPathFilter eventFilter,
                                           BusinessEventHandler eventHandler,
                                           boolean runAsPublisher,
                                           long eventRecvTimeout,
                                           String durableSubscriberName)
                                    throws Exception

Subscribe to EDN JMS topic for the event (specified as eventName), and return an instance of (EdnJmsEventSubscriber), allowing fine grained event consuming (switch on/off event delivery in-flow, read event etc.) through EdnJmsEventSubscriber and EdnJmsEventReader (the event reader can be obtained by EdnJmsEventSubscriber.getEventReader()).

Parameters:

eventName - - full name of event subscribe to

eventDeliverConsistencyLvl - - event delivery consistency level: OAOO or GUARANTEED

eventFilter - - xpath used to filter received event

eventHandler - - event handler for processing received event (filtered)

runAsPublisher - - a hint for EDN delivery security policy, when true, the event publisher's subject will be used when deliver event to further processing

eventRecvTimeout - - timeout (in millisecond) for event receiving

durableSubscriberName - - name of durable subscriber to be created if presents, otherwise, non-durable subscriber will be created

Returns:

the event subscriber where caller can do further event consuming with fine grained control

Throws:

Exception - - Error during subscription

subscribeOnly

public EdnJmsEventSubscriber subscribeOnly(QName eventName,
                                           String durableSubscriberName)
                                    throws Exception

Subscribe to EDN JMS topic for the event (specified as eventName), and return an instance of (EdnJmsEventSubscriber), allowing fine grained event consuming (switch on/off event delivery in-flow, read event etc.) through EdnJmsEventSubscriber and EdnJmsEventReader (the event reader can be obtained by EdnJmsEventSubscriber.getEventReader()). EDN consistency level : default to class instance consistency level EDN event filter: default to class instance event filter EDN event handler: default to class instance event handler EDN run as publisher: default to class instance value of run as publisher EDN event receiving (read) timeout (in millisecond) : default to class instance timeout value

Parameters:

eventName - - full event name to subscribe to

durableSubscriberName - - durable subscriber name if presents, otherwise, a non-durable subscriber will be created

Returns:

- the event subscriber instance where caller can do further event consuming with fine grained control

Throws:

Exception - error during subscription Internally, this method delegates to the subscribeOnly(...) as shown below with parameters not present taking defaults:

See Also:

subscribeOnly(QName, ConsistencyLevel, XPathFilter, BusinessEventHandler, boolean, long, String)

subscribeOnly

public EdnJmsEventSubscriber subscribeOnly(EdnSubscribeContext subscriptionContex)
                                    throws Exception

Subscribe to EDN JMS topic for the event (specified as eventName), and return an instance of (EdnJmsEventSubscriber), allowing fine grained event consuming (switch on/off event delivery in-flow, read event etc.) through EdnJmsEventSubscriber and EdnJmsEventReader (the event reader can be obtained by EdnJmsEventSubscriber.getEventReader()).

Parameters:

subscriptionContex - - subscribe context encapsulating parameters for creating EDN subscriber;

Returns:

- the event subscriber instance where caller can do further event consuming with fine grained control

Throws:

Exception - - Error during subscription. Internally, this method delegates to the subscribeOnly(...) as shown below with parameters not present taking defaults:

See Also:

subscribeOnly(QName, ConsistencyLevel, XPathFilter, BusinessEventHandler, boolean, long, String)

unsubscribe

public void unsubscribe(QName eventName,
                        String durableSubscriberName)
                 throws oracle.fabric.common.FabricException

Unsubscribe (remove) the event subscriber indicated by durableSubscriberName.

Specified by:

unsubscribe in interface EdnConnection

Overrides:

unsubscribe in class BaseEdnConnection

Parameters:

eventName - - the event type of the subscription

durableSubscriberName - - the durable subscriber name

Throws:

oracle.fabric.common.FabricException - - Error during unsubscribe

See Also:

BaseEdnConnection.unsubscribe(QName, String)

unsubscribe

public void unsubscribe(EdnSubscribeContext subscriptionContex)
                 throws oracle.fabric.common.FabricException

Unsubscribe using parameter of EdnSubscribeContext;

Parameters:

subscriptionContex - - the EDN subscribe context, internally parameter eventName and durableSubscriberName will be obtained from the context and invoke unsubscribe(eventName, durableSubscriberName)

Throws:

oracle.fabric.common.FabricException - - Error occurred during removing the subscriber; Internally, this method delegates to unsubscribe(...) as shown below where eventName and durableSubscriberName are obtained from the subscriptionContext:

See Also:

unsubscribe(QName, String)

setJmsConfig

public void setJmsConfig(JmsConfig config)

Custom JmsConfig for all the events to be published and subscribed via this Event Connection.

Parameters:

config - - JmsConfig object to set

getContext

public Context getContext()

get the JNDI context

Returns:

- jndi context