| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_06) on Wed Jul 19 14:42:47 EDT 2006 --> |
| <TITLE> |
| XMPPBridge (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.event.XMPPBridge class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="XMPPBridge (Cayenne API Documentation - v.1.2)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/event/JMSBridgeFactory.html" title="class in org.objectstyle.cayenne.event"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridgeFactory.html" title="class in org.objectstyle.cayenne.event"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/event/XMPPBridge.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="XMPPBridge.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.objectstyle.cayenne.event</FONT> |
| <BR> |
| Class XMPPBridge</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">org.objectstyle.cayenne.event.EventBridge</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.event.XMPPBridge</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.util.EventListener</DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>XMPPBridge</B><DT>extends <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></DL> |
| </PRE> |
| |
| <P> |
| 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> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Andrus Adamchik</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#chatService">chatService</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#connected">connected</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected org.jivesoftware.smack.XMPPConnection</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#connection">connection</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected org.jivesoftware.smack.GroupChat</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#groupChat">groupChat</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#loginId">loginId</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#password">password</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#secureConnection">secureConnection</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#sessionHandle">sessionHandle</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#xmppHost">xmppHost</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#xmppPort">xmppPort</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.objectstyle.cayenne.event.EventBridge"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.objectstyle.cayenne.event.<A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#eventManager">eventManager</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#externalEventSource">externalEventSource</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#externalSubject">externalSubject</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#localSubjects">localSubjects</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#mode">mode</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#RECEIVE_EXTERNAL">RECEIVE_EXTERNAL</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#RECEIVE_LOCAL">RECEIVE_LOCAL</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#RECEIVE_LOCAL_EXTERNAL">RECEIVE_LOCAL_EXTERNAL</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#VM_ID">VM_ID</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#VM_ID_PROPERRTY">VM_ID_PROPERRTY</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#XMPPBridge(java.util.Collection, java.lang.String)">XMPPBridge</A></B>(java.util.Collection localSubjects, |
| java.lang.String externalSubject)</CODE> |
| |
| <BR> |
| Creates an XMPPBridge.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#XMPPBridge(org.objectstyle.cayenne.event.EventSubject, java.lang.String)">XMPPBridge</A></B>(<A HREF="../../../../org/objectstyle/cayenne/event/EventSubject.html" title="class in org.objectstyle.cayenne.event">EventSubject</A> localSubject, |
| java.lang.String externalSubject)</CODE> |
| |
| <BR> |
| Creates an XMPPBridge.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#getChatService()">getChatService</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#getLoginId()">getLoginId</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#getPassword()">getPassword</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#getSessionHandle()">getSessionHandle</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#getXmppHost()">getXmppHost</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#getXmppPort()">getXmppPort</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#isSecureConnection()">isSecureConnection</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#sendExternalEvent(org.objectstyle.cayenne.event.CayenneEvent)">sendExternalEvent</A></B>(<A HREF="../../../../org/objectstyle/cayenne/event/CayenneEvent.html" title="class in org.objectstyle.cayenne.event">CayenneEvent</A> localEvent)</CODE> |
| |
| <BR> |
| Sends a Cayenne event over the transport supported by this bridge.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setChatService(java.lang.String)">setChatService</A></B>(java.lang.String chatService)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setLoginId(java.lang.String)">setLoginId</A></B>(java.lang.String loginId)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String password)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setSecureConnection(boolean)">setSecureConnection</A></B>(boolean secureConnection)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setSessionHandle(java.lang.String)">setSessionHandle</A></B>(java.lang.String sessionHandle)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setXmppHost(java.lang.String)">setXmppHost</A></B>(java.lang.String xmppHost)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#setXmppPort(int)">setXmppPort</A></B>(int xmppPort)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#shutdownExternal()">shutdownExternal</A></B>()</CODE> |
| |
| <BR> |
| Shuts down the external interface of the EventBridge, cleaning up and releasing any |
| resources used to communicate external events.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridge.html#startupExternal()">startupExternal</A></B>()</CODE> |
| |
| <BR> |
| Starts an external interface of the EventBridge.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.objectstyle.cayenne.event.EventBridge"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.objectstyle.cayenne.event.<A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#convertToExternalSubject(org.objectstyle.cayenne.event.EventSubject)">convertToExternalSubject</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#getEventManager()">getEventManager</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#getExternalEventSource()">getExternalEventSource</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#getExternalSubject()">getExternalSubject</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#getLocalSubject()">getLocalSubject</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#getLocalSubjects()">getLocalSubjects</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#isRunning()">isRunning</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#onExternalEvent(org.objectstyle.cayenne.event.CayenneEvent)">onExternalEvent</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#onLocalEvent(org.objectstyle.cayenne.event.CayenneEvent)">onLocalEvent</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#receivesExternalEvents()">receivesExternalEvents</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#receivesLocalEvents()">receivesLocalEvents</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#shutdown()">shutdown</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#startup(org.objectstyle.cayenne.event.EventManager, int)">startup</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#startup(org.objectstyle.cayenne.event.EventManager, int, java.lang.Object)">startup</A>, <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#startup(org.objectstyle.cayenne.event.EventManager, int, java.lang.Object, java.lang.Object)">startup</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="secureConnection"><!-- --></A><H3> |
| secureConnection</H3> |
| <PRE> |
| protected boolean <B>secureConnection</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="loginId"><!-- --></A><H3> |
| loginId</H3> |
| <PRE> |
| protected java.lang.String <B>loginId</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="password"><!-- --></A><H3> |
| password</H3> |
| <PRE> |
| protected java.lang.String <B>password</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="xmppHost"><!-- --></A><H3> |
| xmppHost</H3> |
| <PRE> |
| protected java.lang.String <B>xmppHost</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="xmppPort"><!-- --></A><H3> |
| xmppPort</H3> |
| <PRE> |
| protected int <B>xmppPort</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="chatService"><!-- --></A><H3> |
| chatService</H3> |
| <PRE> |
| protected java.lang.String <B>chatService</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="sessionHandle"><!-- --></A><H3> |
| sessionHandle</H3> |
| <PRE> |
| protected java.lang.String <B>sessionHandle</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="connection"><!-- --></A><H3> |
| connection</H3> |
| <PRE> |
| protected org.jivesoftware.smack.XMPPConnection <B>connection</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="groupChat"><!-- --></A><H3> |
| groupChat</H3> |
| <PRE> |
| protected org.jivesoftware.smack.GroupChat <B>groupChat</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="connected"><!-- --></A><H3> |
| connected</H3> |
| <PRE> |
| protected boolean <B>connected</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="XMPPBridge(org.objectstyle.cayenne.event.EventSubject, java.lang.String)"><!-- --></A><H3> |
| XMPPBridge</H3> |
| <PRE> |
| public <B>XMPPBridge</B>(<A HREF="../../../../org/objectstyle/cayenne/event/EventSubject.html" title="class in org.objectstyle.cayenne.event">EventSubject</A> localSubject, |
| java.lang.String externalSubject)</PRE> |
| <DL> |
| <DD>Creates an XMPPBridge. External subject will be used as the chat group name. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="XMPPBridge(java.util.Collection, java.lang.String)"><!-- --></A><H3> |
| XMPPBridge</H3> |
| <PRE> |
| public <B>XMPPBridge</B>(java.util.Collection localSubjects, |
| java.lang.String externalSubject)</PRE> |
| <DL> |
| <DD>Creates an XMPPBridge. External subject will be used as the chat group name. |
| <P> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getXmppHost()"><!-- --></A><H3> |
| getXmppHost</H3> |
| <PRE> |
| public java.lang.String <B>getXmppHost</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setXmppHost(java.lang.String)"><!-- --></A><H3> |
| setXmppHost</H3> |
| <PRE> |
| public void <B>setXmppHost</B>(java.lang.String xmppHost)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getXmppPort()"><!-- --></A><H3> |
| getXmppPort</H3> |
| <PRE> |
| public int <B>getXmppPort</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setXmppPort(int)"><!-- --></A><H3> |
| setXmppPort</H3> |
| <PRE> |
| public void <B>setXmppPort</B>(int xmppPort)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLoginId()"><!-- --></A><H3> |
| getLoginId</H3> |
| <PRE> |
| public java.lang.String <B>getLoginId</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLoginId(java.lang.String)"><!-- --></A><H3> |
| setLoginId</H3> |
| <PRE> |
| public void <B>setLoginId</B>(java.lang.String loginId)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPassword()"><!-- --></A><H3> |
| getPassword</H3> |
| <PRE> |
| public java.lang.String <B>getPassword</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPassword(java.lang.String)"><!-- --></A><H3> |
| setPassword</H3> |
| <PRE> |
| public void <B>setPassword</B>(java.lang.String password)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSecureConnection()"><!-- --></A><H3> |
| isSecureConnection</H3> |
| <PRE> |
| public boolean <B>isSecureConnection</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSecureConnection(boolean)"><!-- --></A><H3> |
| setSecureConnection</H3> |
| <PRE> |
| public void <B>setSecureConnection</B>(boolean secureConnection)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getChatService()"><!-- --></A><H3> |
| getChatService</H3> |
| <PRE> |
| public java.lang.String <B>getChatService</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setChatService(java.lang.String)"><!-- --></A><H3> |
| setChatService</H3> |
| <PRE> |
| public void <B>setChatService</B>(java.lang.String chatService)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSessionHandle()"><!-- --></A><H3> |
| getSessionHandle</H3> |
| <PRE> |
| public java.lang.String <B>getSessionHandle</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSessionHandle(java.lang.String)"><!-- --></A><H3> |
| setSessionHandle</H3> |
| <PRE> |
| public void <B>setSessionHandle</B>(java.lang.String sessionHandle)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="startupExternal()"><!-- --></A><H3> |
| startupExternal</H3> |
| <PRE> |
| protected void <B>startupExternal</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#startupExternal()">EventBridge</A></CODE></B></DD> |
| <DD>Starts an external interface of the EventBridge. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#startupExternal()">startupExternal</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="shutdownExternal()"><!-- --></A><H3> |
| shutdownExternal</H3> |
| <PRE> |
| protected void <B>shutdownExternal</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#shutdownExternal()">EventBridge</A></CODE></B></DD> |
| <DD>Shuts down the external interface of the EventBridge, cleaning up and releasing any |
| resources used to communicate external events. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#shutdownExternal()">shutdownExternal</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="sendExternalEvent(org.objectstyle.cayenne.event.CayenneEvent)"><!-- --></A><H3> |
| sendExternalEvent</H3> |
| <PRE> |
| protected void <B>sendExternalEvent</B>(<A HREF="../../../../org/objectstyle/cayenne/event/CayenneEvent.html" title="class in org.objectstyle.cayenne.event">CayenneEvent</A> localEvent) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#sendExternalEvent(org.objectstyle.cayenne.event.CayenneEvent)">EventBridge</A></CODE></B></DD> |
| <DD>Sends a Cayenne event over the transport supported by this bridge. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html#sendExternalEvent(org.objectstyle.cayenne.event.CayenneEvent)">sendExternalEvent</A></CODE> in class <CODE><A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/event/JMSBridgeFactory.html" title="class in org.objectstyle.cayenne.event"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/event/XMPPBridgeFactory.html" title="class in org.objectstyle.cayenne.event"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/event/XMPPBridge.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="XMPPBridge.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= |
| "http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
