| <!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:45:53 EDT 2006 --> |
| <TITLE> |
| BaseRemoteService (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.remote.service.BaseRemoteService class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="BaseRemoteService (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </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"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/cayenne/remote/service/HttpRemoteService.html" title="class in org.apache.cayenne.remote.service"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/cayenne/remote/service/BaseRemoteService.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BaseRemoteService.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.apache.cayenne.remote.service</FONT> |
| <BR> |
| Class BaseRemoteService</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.remote.service.BaseRemoteService</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.rmi.Remote, <A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/cayenne/remote/service/HttpRemoteService.html" title="class in org.apache.cayenne.remote.service">HttpRemoteService</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>BaseRemoteService</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</A></DL> |
| </PRE> |
| |
| <P> |
| A generic implementation of an RemoteService. Subclasses can be customized to work with |
| different remoting mechanisms, such as Hessian or JAXRPC. |
| <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 <A HREF="../../../../../org/apache/cayenne/access/DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#domain">domain</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#EVENT_BRIDGE_FACTORY_PROPERTY">EVENT_BRIDGE_FACTORY_PROPERTY</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/apache/cayenne/remote/service/BaseRemoteService.html#eventBridgeFactoryName">eventBridgeFactoryName</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#eventBridgeParameters">eventBridgeParameters</A></B></CODE> |
| |
| <BR> |
| </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/apache/cayenne/remote/service/BaseRemoteService.html#BaseRemoteService()">BaseRemoteService</A></B>()</CODE> |
| |
| <BR> |
| </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>protected <A HREF="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createChannel()">createChannel</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createRemoteSession(java.lang.String, java.lang.String, boolean)">createRemoteSession</A></B>(java.lang.String sessionId, |
| java.lang.String name, |
| boolean enableEvents)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createServerSession()">createServerSession</A></B>()</CODE> |
| |
| <BR> |
| Creates a new ServerSession with a dedicated DataChannel.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createServerSession(java.lang.String)">createServerSession</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Creates a new ServerSession based on a shared DataChannel.</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/apache/cayenne/remote/service/BaseRemoteService.html#destroyService()">destroyService</A></B>()</CODE> |
| |
| <BR> |
| Shuts down this service.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#establishSession()">establishSession</A></B>()</CODE> |
| |
| <BR> |
| Establishes a dedicated session with Cayenne DataChannel, returning session id.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#establishSharedSession(java.lang.String)">establishSharedSession</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Creates a new session with the specified or joins an existing one.</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/apache/cayenne/remote/service/BaseRemoteService.html#getEventBridgeFactoryName()">getEventBridgeFactoryName</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#getEventBridgeParameters()">getEventBridgeParameters</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#getRootChannel()">getRootChannel</A></B>()</CODE> |
| |
| <BR> |
| Returns a DataChannel that is a parent of all session DataChannels.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#getServerSession()">getServerSession</A></B>()</CODE> |
| |
| <BR> |
| Returns a ServerSession object that represents Cayenne-related state associated |
| with the current session.</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/apache/cayenne/remote/service/BaseRemoteService.html#initCayenneStack(java.util.Map)">initCayenneStack</A></B>(java.util.Map properties)</CODE> |
| |
| <BR> |
| Sets up Cayenne stack.</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/apache/cayenne/remote/service/BaseRemoteService.html#initEventBridgeParameters(java.util.Map)">initEventBridgeParameters</A></B>(java.util.Map properties)</CODE> |
| |
| <BR> |
| Initializes EventBridge parameters for remote clients peer-to-peer communications.</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/apache/cayenne/remote/service/BaseRemoteService.html#initService(java.util.Map)">initService</A></B>(java.util.Map properties)</CODE> |
| |
| <BR> |
| A method that sets up a service, initializing Cayenne stack.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#processMessage(org.apache.cayenne.remote.ClientMessage)">processMessage</A></B>(<A HREF="../../../../../org/apache/cayenne/remote/ClientMessage.html" title="interface in org.apache.cayenne.remote">ClientMessage</A> message)</CODE> |
| |
| <BR> |
| Processes message on a remote server, returning the result of such processing.</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="EVENT_BRIDGE_FACTORY_PROPERTY"><!-- --></A><H3> |
| EVENT_BRIDGE_FACTORY_PROPERTY</H3> |
| <PRE> |
| public static final java.lang.String <B>EVENT_BRIDGE_FACTORY_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.cayenne.remote.service.BaseRemoteService.EVENT_BRIDGE_FACTORY_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="domain"><!-- --></A><H3> |
| domain</H3> |
| <PRE> |
| protected <A HREF="../../../../../org/apache/cayenne/access/DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</A> <B>domain</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="eventBridgeFactoryName"><!-- --></A><H3> |
| eventBridgeFactoryName</H3> |
| <PRE> |
| protected java.lang.String <B>eventBridgeFactoryName</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="eventBridgeParameters"><!-- --></A><H3> |
| eventBridgeParameters</H3> |
| <PRE> |
| protected java.util.Map <B>eventBridgeParameters</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="BaseRemoteService()"><!-- --></A><H3> |
| BaseRemoteService</H3> |
| <PRE> |
| public <B>BaseRemoteService</B>()</PRE> |
| <DL> |
| </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="getEventBridgeFactoryName()"><!-- --></A><H3> |
| getEventBridgeFactoryName</H3> |
| <PRE> |
| public java.lang.String <B>getEventBridgeFactoryName</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEventBridgeParameters()"><!-- --></A><H3> |
| getEventBridgeParameters</H3> |
| <PRE> |
| public java.util.Map <B>getEventBridgeParameters</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initService(java.util.Map)"><!-- --></A><H3> |
| initService</H3> |
| <PRE> |
| protected void <B>initService</B>(java.util.Map properties) |
| throws <A HREF="../../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</A></PRE> |
| <DL> |
| <DD>A method that sets up a service, initializing Cayenne stack. Should be invoked by |
| subclasses from their appropriate service lifecycle methods. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="destroyService()"><!-- --></A><H3> |
| destroyService</H3> |
| <PRE> |
| protected void <B>destroyService</B>()</PRE> |
| <DL> |
| <DD>Shuts down this service. Should be invoked by subclasses from their appropriate |
| service lifecycle methods. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRootChannel()"><!-- --></A><H3> |
| getRootChannel</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</A> <B>getRootChannel</B>()</PRE> |
| <DL> |
| <DD>Returns a DataChannel that is a parent of all session DataChannels. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createServerSession()"><!-- --></A><H3> |
| createServerSession</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</A> <B>createServerSession</B>()</PRE> |
| <DL> |
| <DD>Creates a new ServerSession with a dedicated DataChannel. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createServerSession(java.lang.String)"><!-- --></A><H3> |
| createServerSession</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</A> <B>createServerSession</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Creates a new ServerSession based on a shared DataChannel. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - shared session name used to lookup a shared DataChannel.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServerSession()"><!-- --></A><H3> |
| getServerSession</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</A> <B>getServerSession</B>()</PRE> |
| <DL> |
| <DD>Returns a ServerSession object that represents Cayenne-related state associated |
| with the current session. If ServerSession hasn't been previously saved, returns |
| null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="establishSession()"><!-- --></A><H3> |
| establishSession</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</A> <B>establishSession</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSession()">RemoteService</A></CODE></B></DD> |
| <DD>Establishes a dedicated session with Cayenne DataChannel, returning session id. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSession()">establishSession</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="establishSharedSession(java.lang.String)"><!-- --></A><H3> |
| establishSharedSession</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</A> <B>establishSharedSession</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSharedSession(java.lang.String)">RemoteService</A></CODE></B></DD> |
| <DD>Creates a new session with the specified or joins an existing one. This method is |
| used to bootstrap collaborating clients of a single "group chat". |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSharedSession(java.lang.String)">establishSharedSession</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processMessage(org.apache.cayenne.remote.ClientMessage)"><!-- --></A><H3> |
| processMessage</H3> |
| <PRE> |
| public java.lang.Object <B>processMessage</B>(<A HREF="../../../../../org/apache/cayenne/remote/ClientMessage.html" title="interface in org.apache.cayenne.remote">ClientMessage</A> message) |
| throws java.lang.Throwable</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html#processMessage(org.apache.cayenne.remote.ClientMessage)">RemoteService</A></CODE></B></DD> |
| <DD>Processes message on a remote server, returning the result of such processing. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html#processMessage(org.apache.cayenne.remote.ClientMessage)">processMessage</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Throwable</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createRemoteSession(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> |
| createRemoteSession</H3> |
| <PRE> |
| protected <A HREF="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</A> <B>createRemoteSession</B>(java.lang.String sessionId, |
| java.lang.String name, |
| boolean enableEvents)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createChannel()"><!-- --></A><H3> |
| createChannel</H3> |
| <PRE> |
| protected <A HREF="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</A> <B>createChannel</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initCayenneStack(java.util.Map)"><!-- --></A><H3> |
| initCayenneStack</H3> |
| <PRE> |
| protected void <B>initCayenneStack</B>(java.util.Map properties)</PRE> |
| <DL> |
| <DD>Sets up Cayenne stack. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initEventBridgeParameters(java.util.Map)"><!-- --></A><H3> |
| initEventBridgeParameters</H3> |
| <PRE> |
| protected void <B>initEventBridgeParameters</B>(java.util.Map properties)</PRE> |
| <DL> |
| <DD>Initializes EventBridge parameters for remote clients peer-to-peer communications. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </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"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/cayenne/remote/service/HttpRemoteService.html" title="class in org.apache.cayenne.remote.service"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/cayenne/remote/service/BaseRemoteService.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BaseRemoteService.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> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
