Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.1 / api / org / apache / cayenne / remote / service / BaseRemoteService.html
blob: f3be311999a1947568a5ae0f6a99e3bbcd56942b [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:59 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>BaseRemoteService (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="BaseRemoteService (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/BaseRemoteService.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>Prev Class</li>
<li><a href="../../../../../org/apache/cayenne/remote/service/HttpRemoteService.html" title="class in org.apache.cayenne.remote.service"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/remote/service/BaseRemoteService.html" target="_top">Frames</a></li>
<li><a href="BaseRemoteService.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.remote.service</div>
<h2 title="Class BaseRemoteService" class="title">Class BaseRemoteService</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>org.apache.cayenne.remote.service.BaseRemoteService</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/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a>, <a href="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/cayenne/remote/service/HttpRemoteService.html" title="class in org.apache.cayenne.remote.service">HttpRemoteService</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">BaseRemoteService</span>
extends <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>
implements <a href="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</a></pre>
<div class="block">A generic implementation of an RemoteService. Can be subclassed to work with different
remoting mechanisms, such as Hessian or JAXRPC.</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="../../../../../org/apache/cayenne/configuration/ObjectContextFactory.html" title="interface in org.apache.cayenne.configuration">ObjectContextFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#contextFactory">contextFactory</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/remote/service/BaseRemoteService.html#eventBridgeFactoryName">eventBridgeFactoryName</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/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#eventBridgeParameters">eventBridgeParameters</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.commons.logging.Log</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#logger">logger</a></strong></code>&nbsp;</td>
</tr>
</table>
</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/remote/service/BaseRemoteService.html#BaseRemoteService(org.apache.cayenne.configuration.ObjectContextFactory,%20java.util.Map)">BaseRemoteService</a></strong>(<a href="../../../../../org/apache/cayenne/configuration/ObjectContextFactory.html" title="interface in org.apache.cayenne.configuration">ObjectContextFactory</a>&nbsp;contextFactory,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;eventBridgeProperties)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createChannel()">createChannel</a></strong>()</code>
<div class="block">Creates a server-side channel that will handle all client requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createRemoteSession(java.lang.String,%20java.lang.String,%20boolean)">createRemoteSession</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;sessionId,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
boolean&nbsp;enableEvents)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createServerSession()">createServerSession</a></strong>()</code>
<div class="block">Creates a new ServerSession with a dedicated DataChannel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#createServerSession(java.lang.String)">createServerSession</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Creates a new ServerSession based on a shared DataChannel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#establishSession()">establishSession</a></strong>()</code>
<div class="block">Establishes a dedicated session with Cayenne DataChannel, returning session id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#establishSharedSession(java.lang.String)">establishSharedSession</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Creates a new session with the specified or joins an existing one.</div>
</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/remote/service/BaseRemoteService.html#getEventBridgeFactoryName()">getEventBridgeFactoryName</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/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#getEventBridgeParameters()">getEventBridgeParameters</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#getServerSession()">getServerSession</a></strong>()</code>
<div class="block">Returns a ServerSession object that represents Cayenne-related state associated
with the current session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#initEventBridgeParameters(java.util.Map)">initEventBridgeParameters</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;properties)</code>
<div class="block">Initializes EventBridge parameters for remote clients peer-to-peer communications.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/remote/service/BaseRemoteService.html#processMessage(org.apache.cayenne.remote.ClientMessage)">processMessage</a></strong>(<a href="../../../../../org/apache/cayenne/remote/ClientMessage.html" title="interface in org.apache.cayenne.remote">ClientMessage</a>&nbsp;message)</code>
<div class="block">Processes message on a remote server, returning the result of such processing.</div>
</td>
</tr>
</table>
<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="logger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
<a name="contextFactory">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextFactory</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/cayenne/configuration/ObjectContextFactory.html" title="interface in org.apache.cayenne.configuration">ObjectContextFactory</a> contextFactory</pre>
</li>
</ul>
<a name="eventBridgeFactoryName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eventBridgeFactoryName</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> eventBridgeFactoryName</pre>
</li>
</ul>
<a name="eventBridgeParameters">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>eventBridgeParameters</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt; eventBridgeParameters</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BaseRemoteService(org.apache.cayenne.configuration.ObjectContextFactory, java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseRemoteService</h4>
<pre>public&nbsp;BaseRemoteService(<a href="../../../../../org/apache/cayenne/configuration/ObjectContextFactory.html" title="interface in org.apache.cayenne.configuration">ObjectContextFactory</a>&nbsp;contextFactory,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;eventBridgeProperties)</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEventBridgeFactoryName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventBridgeFactoryName</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;getEventBridgeFactoryName()</pre>
</li>
</ul>
<a name="getEventBridgeParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventBridgeParameters</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;getEventBridgeParameters()</pre>
</li>
</ul>
<a name="createServerSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createServerSession</h4>
<pre>protected abstract&nbsp;<a href="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</a>&nbsp;createServerSession()</pre>
<div class="block">Creates a new ServerSession with a dedicated DataChannel.</div>
</li>
</ul>
<a name="createServerSession(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createServerSession</h4>
<pre>protected abstract&nbsp;<a href="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</a>&nbsp;createServerSession(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Creates a new ServerSession based on a shared DataChannel.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - shared session name used to lookup a shared DataChannel.</dd></dl>
</li>
</ul>
<a name="getServerSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerSession</h4>
<pre>protected abstract&nbsp;<a href="../../../../../org/apache/cayenne/remote/service/ServerSession.html" title="class in org.apache.cayenne.remote.service">ServerSession</a>&nbsp;getServerSession()</pre>
<div class="block">Returns a ServerSession object that represents Cayenne-related state associated
with the current session. If ServerSession hasn't been previously saved, returns
null.</div>
</li>
</ul>
<a name="establishSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>establishSession</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</a>&nbsp;establishSession()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSession()">RemoteService</a></code></strong></div>
<div class="block">Establishes a dedicated session with Cayenne DataChannel, returning session id.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSession()">establishSession</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</a></code></dd>
</dl>
</li>
</ul>
<a name="establishSharedSession(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>establishSharedSession</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</a>&nbsp;establishSharedSession(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSharedSession(java.lang.String)">RemoteService</a></code></strong></div>
<div class="block">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".</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html#establishSharedSession(java.lang.String)">establishSharedSession</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</a></code></dd>
</dl>
</li>
</ul>
<a name="processMessage(org.apache.cayenne.remote.ClientMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processMessage</h4>
<pre>public&nbsp;<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>&nbsp;processMessage(<a href="../../../../../org/apache/cayenne/remote/ClientMessage.html" title="interface in org.apache.cayenne.remote">ClientMessage</a>&nbsp;message)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html#processMessage(org.apache.cayenne.remote.ClientMessage)">RemoteService</a></code></strong></div>
<div class="block">Processes message on a remote server, returning the result of such processing.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html#processMessage(org.apache.cayenne.remote.ClientMessage)">processMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/remote/RemoteService.html" title="interface in org.apache.cayenne.remote">RemoteService</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/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></code></dd></dl>
</li>
</ul>
<a name="createRemoteSession(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRemoteSession</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/cayenne/remote/RemoteSession.html" title="class in org.apache.cayenne.remote">RemoteSession</a>&nbsp;createRemoteSession(<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;sessionId,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
boolean&nbsp;enableEvents)</pre>
</li>
</ul>
<a name="createChannel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChannel</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a>&nbsp;createChannel()</pre>
<div class="block">Creates a server-side channel that will handle all client requests. For shared
sessions the same channel instance is reused for the entire group of clients. For
dedicated sessions, one channel per client is created.
<p/>
This implementation returns <a href="../../../../../org/apache/cayenne/access/ClientServerChannel.html" title="class in org.apache.cayenne.access"><code>ClientServerChannel</code></a> instance wrapping a
DataContext. Subclasses may override the method to customize channel creation. For
instance they may wrap channel in the custom interceptors to handle transactions or
security.</div>
</li>
</ul>
<a name="initEventBridgeParameters(java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>initEventBridgeParameters</h4>
<pre>protected&nbsp;void&nbsp;initEventBridgeParameters(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;properties)</pre>
<div class="block">Initializes EventBridge parameters for remote clients peer-to-peer communications.</div>
</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/BaseRemoteService.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>Prev Class</li>
<li><a href="../../../../../org/apache/cayenne/remote/service/HttpRemoteService.html" title="class in org.apache.cayenne.remote.service"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/remote/service/BaseRemoteService.html" target="_top">Frames</a></li>
<li><a href="BaseRemoteService.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>