blob: 628c48421115105030d660891536fbc3a62f73e1 [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>XMPPBridge (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="XMPPBridge (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/XMPPBridge.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/JMSBridgeFactory.html" title="class in org.apache.cayenne.event"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/event/XMPPBridgeFactory.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/XMPPBridge.html" target="_top">Frames</a></li>
<li><a href="XMPPBridge.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 XMPPBridge" class="title">Class XMPPBridge</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.XMPPBridge</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></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">XMPPBridge</span>
extends <a href="../../../../org/apache/cayenne/event/EventBridge.html" title="class in org.apache.cayenne.event">EventBridge</a></pre>
<div class="block">An EventBridge implementation based on XMPP protocol and Smack XMPP client library.
What's good about XMPP (Extensible Messaging and Presence Protocol, an IETF standard
protocol that grew up from Jabber IM) is that generally it has fewer or no deployment
limitations (unlike JMS and JGroups that are generally a good solution for local
controlled networks). Also it provides lots of additional information for free, such as
presence, and much more.
<p>
This implementation is based on Smack XMPP client library from JiveSoftware.
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</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 <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/XMPPBridge.html#chatService">chatService</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#connected">connected</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.jivesoftware.smack.XMPPConnection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#connection">connection</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.jivesoftware.smack.GroupChat</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#groupChat">groupChat</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<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/XMPPBridge.html#loginId">loginId</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/XMPPBridge.html#password">password</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#secureConnection">secureConnection</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/XMPPBridge.html#sessionHandle">sessionHandle</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<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/XMPPBridge.html#xmppHost">xmppHost</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#xmppPort">xmppPort</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/XMPPBridge.html#XMPPBridge(java.util.Collection,%20java.lang.String)">XMPPBridge</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>
<div class="block">Creates an XMPPBridge.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#XMPPBridge(org.apache.cayenne.event.EventSubject,%20java.lang.String)">XMPPBridge</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>
<div class="block">Creates an XMPPBridge.</div>
</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><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/XMPPBridge.html#getChatService()">getChatService</a></strong>()</code>&nbsp;</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/XMPPBridge.html#getLoginId()">getLoginId</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<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/XMPPBridge.html#getPassword()">getPassword</a></strong>()</code>&nbsp;</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/XMPPBridge.html#getSessionHandle()">getSessionHandle</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<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/XMPPBridge.html#getXmppHost()">getXmppHost</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#getXmppPort()">getXmppPort</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#isSecureConnection()">isSecureConnection</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.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="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setChatService(java.lang.String)">setChatService</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;chatService)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setLoginId(java.lang.String)">setLoginId</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;loginId)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setPassword(java.lang.String)">setPassword</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;password)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setSecureConnection(boolean)">setSecureConnection</a></strong>(boolean&nbsp;secureConnection)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setSessionHandle(java.lang.String)">setSessionHandle</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;sessionHandle)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setXmppHost(java.lang.String)">setXmppHost</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;xmppHost)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#setXmppPort(int)">setXmppPort</a></strong>(int&nbsp;xmppPort)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/event/XMPPBridge.html#shutdownExternal()">shutdownExternal</a></strong>()</code>
<div class="block">Shuts down the external interface of the EventBridge, cleaning up and releasing any
resources used to communicate external events.</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/XMPPBridge.html#startupExternal()">startupExternal</a></strong>()</code>
<div class="block">Starts an external interface of the EventBridge.</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="secureConnection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>secureConnection</h4>
<pre>protected&nbsp;boolean secureConnection</pre>
</li>
</ul>
<a name="loginId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loginId</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> loginId</pre>
</li>
</ul>
<a name="password">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>password</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> password</pre>
</li>
</ul>
<a name="xmppHost">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>xmppHost</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> xmppHost</pre>
</li>
</ul>
<a name="xmppPort">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>xmppPort</h4>
<pre>protected&nbsp;int xmppPort</pre>
</li>
</ul>
<a name="chatService">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chatService</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> chatService</pre>
</li>
</ul>
<a name="sessionHandle">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sessionHandle</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> sessionHandle</pre>
</li>
</ul>
<a name="connection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connection</h4>
<pre>protected&nbsp;org.jivesoftware.smack.XMPPConnection connection</pre>
</li>
</ul>
<a name="groupChat">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupChat</h4>
<pre>protected&nbsp;org.jivesoftware.smack.GroupChat groupChat</pre>
</li>
</ul>
<a name="connected">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>connected</h4>
<pre>protected&nbsp;boolean connected</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XMPPBridge(org.apache.cayenne.event.EventSubject, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XMPPBridge</h4>
<pre>public&nbsp;XMPPBridge(<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>
<div class="block">Creates an XMPPBridge. External subject will be used as the chat group name.</div>
</li>
</ul>
<a name="XMPPBridge(java.util.Collection, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XMPPBridge</h4>
<pre>public&nbsp;XMPPBridge(<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>
<div class="block">Creates an XMPPBridge. External subject will be used as the chat group name.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getXmppHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXmppHost</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;getXmppHost()</pre>
</li>
</ul>
<a name="setXmppHost(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXmppHost</h4>
<pre>public&nbsp;void&nbsp;setXmppHost(<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;xmppHost)</pre>
</li>
</ul>
<a name="getXmppPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXmppPort</h4>
<pre>public&nbsp;int&nbsp;getXmppPort()</pre>
</li>
</ul>
<a name="setXmppPort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXmppPort</h4>
<pre>public&nbsp;void&nbsp;setXmppPort(int&nbsp;xmppPort)</pre>
</li>
</ul>
<a name="getLoginId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoginId</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;getLoginId()</pre>
</li>
</ul>
<a name="setLoginId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoginId</h4>
<pre>public&nbsp;void&nbsp;setLoginId(<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;loginId)</pre>
</li>
</ul>
<a name="getPassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</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;getPassword()</pre>
</li>
</ul>
<a name="setPassword(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;setPassword(<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;password)</pre>
</li>
</ul>
<a name="isSecureConnection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecureConnection</h4>
<pre>public&nbsp;boolean&nbsp;isSecureConnection()</pre>
</li>
</ul>
<a name="setSecureConnection(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecureConnection</h4>
<pre>public&nbsp;void&nbsp;setSecureConnection(boolean&nbsp;secureConnection)</pre>
</li>
</ul>
<a name="getChatService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChatService</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;getChatService()</pre>
</li>
</ul>
<a name="setChatService(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChatService</h4>
<pre>public&nbsp;void&nbsp;setChatService(<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;chatService)</pre>
</li>
</ul>
<a name="getSessionHandle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionHandle</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;getSessionHandle()</pre>
</li>
</ul>
<a name="setSessionHandle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionHandle</h4>
<pre>public&nbsp;void&nbsp;setSessionHandle(<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;sessionHandle)</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"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/cayenne/event/EventBridge.html#startupExternal()">EventBridge</a></code></strong></div>
<div class="block">Starts an external interface of the EventBridge.</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="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"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/cayenne/event/EventBridge.html#shutdownExternal()">EventBridge</a></code></strong></div>
<div class="block">Shuts down the external interface of the EventBridge, cleaning up and releasing any
resources used to communicate external events.</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="blockListLast">
<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>
</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/XMPPBridge.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/JMSBridgeFactory.html" title="class in org.apache.cayenne.event"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/event/XMPPBridgeFactory.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/XMPPBridge.html" target="_top">Frames</a></li>
<li><a href="XMPPBridge.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>