blob: 53854e365523facf08fc1c2272066e3355adfed9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sat Sep 20 17:22:58 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>JMSBridge (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JMSBridge (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JMSBridge.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/cayenne/event/JavaGroupsBridgeFactory.html" title="class in org.apache.cayenne.event"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/event/JMSBridgeFactory.html" title="class in org.apache.cayenne.event"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/event/JMSBridge.html" target="_top">Frames</a></li>
<li><a href="JMSBridge.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.event</div>
<h2 title="Class JMSBridge" class="title">Class JMSBridge</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">org.apache.cayenne.event.EventBridge</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.event.JMSBridge</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a>, javax.jms.MessageListener</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">JMSBridge</span>
extends <a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a>
implements javax.jms.MessageListener</pre>
<div class="block">Implementation of EventBridge that passes and receives events via JMS (Java Messaging
Service). JMSBridge uses "publish/subscribe" model for communication with external
agents.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected javax.jms.TopicPublisher</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#publisher">publisher</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected javax.jms.TopicConnection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#receivedConnection">receivedConnection</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected javax.jms.TopicConnection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#sendConnection">sendConnection</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected javax.jms.TopicSession</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#sendSession">sendSession</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected javax.jms.TopicSubscriber</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#subscriber">subscriber</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#topicConnectionFactoryName">topicConnectionFactoryName</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.event.EventBridge">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.event.<a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a></h3>
<code><a href="../../../../org/apache/cayenne/event/EventBridge.html#eventManager">eventManager</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#externalEventSource">externalEventSource</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#externalSubject">externalSubject</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#localSubjects">localSubjects</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#mode">mode</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#RECEIVE_EXTERNAL">RECEIVE_EXTERNAL</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#RECEIVE_LOCAL">RECEIVE_LOCAL</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#RECEIVE_LOCAL_EXTERNAL">RECEIVE_LOCAL_EXTERNAL</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#JMSBridge(java.util.Collection,%20java.lang.String)">JMSBridge</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/cayenne/event/EventSubject.html" title="class in org.apache.cayenne.event">EventSubject</a>&gt;&nbsp;localSubjects,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;externalSubject)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#JMSBridge(org.apache.cayenne.event.EventSubject,%20java.lang.String)">JMSBridge</a></strong>(<a href="../../../../org/apache/cayenne/event/EventSubject.html" title="class in org.apache.cayenne.event">EventSubject</a>&nbsp;localSubject,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;externalSubject)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#eventToMessageObject(org.apache.cayenne.event.CayenneEvent)">eventToMessageObject</a></strong>(<a href="../../../../org/apache/cayenne/event/CayenneEvent.html" title="class in org.apache.cayenne.event">CayenneEvent</a>&nbsp;event)</code>
<div class="block">Converts CayenneEvent to a serializable object that will be sent via JMS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#getTopicConnectionFactoryName()">getTopicConnectionFactoryName</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/event/CayenneEvent.html" title="class in org.apache.cayenne.event">CayenneEvent</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#messageObjectToEvent(java.io.Serializable)">messageObjectToEvent</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;object)</code>
<div class="block">Converts a Serializable instance to CayenneEvent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#onMessage(javax.jms.Message)">onMessage</a></strong>(javax.jms.Message&nbsp;message)</code>
<div class="block">JMS MessageListener implementation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#sendExternalEvent(org.apache.cayenne.event.CayenneEvent)">sendExternalEvent</a></strong>(<a href="../../../../org/apache/cayenne/event/CayenneEvent.html" title="class in org.apache.cayenne.event">CayenneEvent</a>&nbsp;localEvent)</code>
<div class="block">Sends a Cayenne event over the transport supported by this bridge.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#setTopicConnectionFactoryName(java.lang.String)">setTopicConnectionFactoryName</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#shutdownExternal()">shutdownExternal</a></strong>()</code>
<div class="block">Closes all resources used to communicate via JMS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#startupExternal()">startupExternal</a></strong>()</code>
<div class="block">Starts up JMS machinery for "publish/subscribe" model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected javax.jms.Topic</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/JMSBridge.html#topicNotFound(javax.naming.Context,%20javax.naming.NamingException)">topicNotFound</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/naming/Context.html?is-external=true" title="class or interface in javax.naming">Context</a>&nbsp;jndiContext,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a>&nbsp;ex)</code>
<div class="block">Attempts to create missing Topic.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.event.EventBridge">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.event.<a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a></h3>
<code><a href="../../../../org/apache/cayenne/event/EventBridge.html#convertToExternalSubject(org.apache.cayenne.event.EventSubject)">convertToExternalSubject</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#getEventManager()">getEventManager</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#getExternalEventSource()">getExternalEventSource</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#getExternalSubject()">getExternalSubject</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#getLocalSubjects()">getLocalSubjects</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#isRunning()">isRunning</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#onExternalEvent(org.apache.cayenne.event.CayenneEvent)">onExternalEvent</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#receivesExternalEvents()">receivesExternalEvents</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#receivesLocalEvents()">receivesLocalEvents</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#shutdown()">shutdown</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#startup(org.apache.cayenne.event.EventManager,%20int)">startup</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#startup(org.apache.cayenne.event.EventManager,%20int,%20java.lang.Object)">startup</a>, <a href="../../../../org/apache/cayenne/event/EventBridge.html#startup(org.apache.cayenne.event.EventManager,%20int,%20java.lang.Object,%20java.lang.Object)">startup</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="topicConnectionFactoryName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topicConnectionFactoryName</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicConnectionFactoryName</pre>
</li>
</ul>
<a name="sendConnection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendConnection</h4>
<pre>protected&nbsp;javax.jms.TopicConnection sendConnection</pre>
</li>
</ul>
<a name="sendSession">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendSession</h4>
<pre>protected&nbsp;javax.jms.TopicSession sendSession</pre>
</li>
</ul>
<a name="receivedConnection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receivedConnection</h4>
<pre>protected&nbsp;javax.jms.TopicConnection receivedConnection</pre>
</li>
</ul>
<a name="publisher">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>publisher</h4>
<pre>protected&nbsp;javax.jms.TopicPublisher publisher</pre>
</li>
</ul>
<a name="subscriber">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>subscriber</h4>
<pre>protected&nbsp;javax.jms.TopicSubscriber subscriber</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JMSBridge(org.apache.cayenne.event.EventSubject, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JMSBridge</h4>
<pre>public&nbsp;JMSBridge(<a href="../../../../org/apache/cayenne/event/EventSubject.html" title="class in org.apache.cayenne.event">EventSubject</a>&nbsp;localSubject,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;externalSubject)</pre>
</li>
</ul>
<a name="JMSBridge(java.util.Collection, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JMSBridge</h4>
<pre>public&nbsp;JMSBridge(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/cayenne/event/EventSubject.html" title="class in org.apache.cayenne.event">EventSubject</a>&gt;&nbsp;localSubjects,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;externalSubject)</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onMessage(javax.jms.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onMessage</h4>
<pre>public&nbsp;void&nbsp;onMessage(javax.jms.Message&nbsp;message)</pre>
<div class="block">JMS MessageListener implementation. Injects received events to the EventManager
local event queue.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>onMessage</code>&nbsp;in interface&nbsp;<code>javax.jms.MessageListener</code></dd>
</dl>
</li>
</ul>
<a name="getTopicConnectionFactoryName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopicConnectionFactoryName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTopicConnectionFactoryName()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Name of javax.jms.TopicConnectionFactory accessible via JNDI.</dd></dl>
</li>
</ul>
<a name="setTopicConnectionFactoryName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopicConnectionFactoryName</h4>
<pre>public&nbsp;void&nbsp;setTopicConnectionFactoryName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
</li>
</ul>
<a name="startupExternal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startupExternal</h4>
<pre>protected&nbsp;void&nbsp;startupExternal()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Starts up JMS machinery for "publish/subscribe" model.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/event/EventBridge.html#startupExternal()">startupExternal</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="topicNotFound(javax.naming.Context, javax.naming.NamingException)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topicNotFound</h4>
<pre>protected&nbsp;javax.jms.Topic&nbsp;topicNotFound(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/naming/Context.html?is-external=true" title="class or interface in javax.naming">Context</a>&nbsp;jndiContext,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a>&nbsp;ex)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Attempts to create missing Topic. Since Topic creation is JMS-implementation
specific, this task is left to subclasses. Current implementation simply rethrows
the exception.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="shutdownExternal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdownExternal</h4>
<pre>protected&nbsp;void&nbsp;shutdownExternal()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Closes all resources used to communicate via JMS.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/event/EventBridge.html#shutdownExternal()">shutdownExternal</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="sendExternalEvent(org.apache.cayenne.event.CayenneEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendExternalEvent</h4>
<pre>protected&nbsp;void&nbsp;sendExternalEvent(<a href="../../../../org/apache/cayenne/event/CayenneEvent.html" title="class in org.apache.cayenne.event">CayenneEvent</a>&nbsp;localEvent)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/cayenne/event/EventBridge.html#sendExternalEvent(org.apache.cayenne.event.CayenneEvent)">EventBridge</a></code></strong></div>
<div class="block">Sends a Cayenne event over the transport supported by this bridge.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/event/EventBridge.html#sendExternalEvent(org.apache.cayenne.event.CayenneEvent)">sendExternalEvent</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="eventToMessageObject(org.apache.cayenne.event.CayenneEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eventToMessageObject</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;eventToMessageObject(<a href="../../../../org/apache/cayenne/event/CayenneEvent.html" title="class in org.apache.cayenne.event">CayenneEvent</a>&nbsp;event)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Converts CayenneEvent to a serializable object that will be sent via JMS. Default
implementation simply returns the event, but subclasses can customize this
behavior.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="messageObjectToEvent(java.io.Serializable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>messageObjectToEvent</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/event/CayenneEvent.html" title="class in org.apache.cayenne.event">CayenneEvent</a>&nbsp;messageObjectToEvent(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;object)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Converts a Serializable instance to CayenneEvent. Returns null if the object is not
supported. Default implementation simply tries to cast the object to CayenneEvent,
but subclasses can customize this behavior.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JMSBridge.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/cayenne/event/JavaGroupsBridgeFactory.html" title="class in org.apache.cayenne.event"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/event/JMSBridgeFactory.html" title="class in org.apache.cayenne.event"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/event/JMSBridge.html" target="_top">Frames</a></li>
<li><a href="JMSBridge.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>