| <!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:57 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ClientChannel (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="ClientChannel (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/ClientChannel.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/remote/BootstrapMessage.html" title="class in org.apache.cayenne.remote"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/remote/ClientChannel.html" target="_top">Frames</a></li> |
| <li><a href="ClientChannel.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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</div> |
| <h2 title="Class ClientChannel" class="title">Class ClientChannel</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.ClientChannel</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ClientChannel</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/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></pre> |
| <div class="block">A <a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne"><code>DataChannel</code></a> implementation that accesses a remote server |
| via a ClientConnection.</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"> </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 boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#channelEventsEnabled">channelEventsEnabled</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#connection">connection</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/graph/GraphDiffCompressor.html" title="class in org.apache.cayenne.graph">GraphDiffCompressor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#diffCompressor">diffCompressor</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#entityResolver">entityResolver</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#eventManager">eventManager</a></strong></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.DataChannel"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.cayenne.<a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></h3> |
| <code><a href="../../../../org/apache/cayenne/DataChannel.html#FLUSH_CASCADE_SYNC">FLUSH_CASCADE_SYNC</a>, <a href="../../../../org/apache/cayenne/DataChannel.html#FLUSH_NOCASCADE_SYNC">FLUSH_NOCASCADE_SYNC</a>, <a href="../../../../org/apache/cayenne/DataChannel.html#GRAPH_CHANGED_SUBJECT">GRAPH_CHANGED_SUBJECT</a>, <a href="../../../../org/apache/cayenne/DataChannel.html#GRAPH_FLUSHED_SUBJECT">GRAPH_FLUSHED_SUBJECT</a>, <a href="../../../../org/apache/cayenne/DataChannel.html#GRAPH_ROLLEDBACK_SUBJECT">GRAPH_ROLLEDBACK_SUBJECT</a>, <a href="../../../../org/apache/cayenne/DataChannel.html#ROLLBACK_CASCADE_SYNC">ROLLBACK_CASCADE_SYNC</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </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/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection)">ClientChannel</a></strong>(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>since 3.1 use |
| <a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)"><code>ClientChannel(ClientConnection, boolean, EventManager, boolean)</code></a></i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean)">ClientChannel</a></strong>(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection, |
| boolean channelEventsEnabled)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>since 3.1 use |
| <a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)"><code>ClientChannel(ClientConnection, boolean, EventManager, boolean)</code></a></i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager)">ClientChannel</a></strong>(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection, |
| boolean channelEventsEnabled, |
| <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> eventManager)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>since 3.1 use |
| <a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)"><code>ClientChannel(ClientConnection, boolean, EventManager, boolean)</code></a></i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)">ClientChannel</a></strong>(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection, |
| boolean channelEventsEnabled, |
| <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> eventManager, |
| boolean remoteEventsOptional)</code> </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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#getConnection()">getConnection</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#getEntityResolver()">getEntityResolver</a></strong>()</code> |
| <div class="block">Returns EntityResolver obtained from the server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#getEventManager()">getEventManager</a></strong>()</code> |
| <div class="block">Returns an EventManager associated with this channel.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#isChannelEventsEnabled()">isChannelEventsEnabled</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#onQuery(org.apache.cayenne.ObjectContext,%20org.apache.cayenne.query.Query)">onQuery</a></strong>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query)</code> |
| <div class="block">Executes a query, using provided <em>context</em> to register persistent objects if |
| query returns any objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#onSync(org.apache.cayenne.ObjectContext,%20org.apache.cayenne.graph.GraphDiff,%20int)">onSync</a></strong>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> originatingContext, |
| <a href="../../../../org/apache/cayenne/graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes, |
| int syncType)</code> |
| <div class="block">Processes synchronization request from a child ObjectContext, returning a GraphDiff |
| that describes changes to objects made on the receiving end as a result of |
| synchronization.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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/ClientChannel.html#send(org.apache.cayenne.remote.ClientMessage,%20java.lang.Class)">send</a></strong>(<a href="../../../../org/apache/cayenne/remote/ClientMessage.html" title="interface in org.apache.cayenne.remote">ClientMessage</a> message, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultClass)</code> |
| <div class="block">Sends a message via connector, getting a result as an instance of a specific class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/remote/ClientChannel.html#setupRemoteChannelListener()">setupRemoteChannelListener</a></strong>()</code> |
| <div class="block">Starts up an EventBridge to listen for remote updates.</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 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="connection"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connection</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection</pre> |
| </li> |
| </ul> |
| <a name="eventManager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>eventManager</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> eventManager</pre> |
| </li> |
| </ul> |
| <a name="entityResolver"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entityResolver</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> entityResolver</pre> |
| </li> |
| </ul> |
| <a name="channelEventsEnabled"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>channelEventsEnabled</h4> |
| <pre>protected boolean channelEventsEnabled</pre> |
| </li> |
| </ul> |
| <a name="diffCompressor"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>diffCompressor</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/graph/GraphDiffCompressor.html" title="class in org.apache.cayenne.graph">GraphDiffCompressor</a> diffCompressor</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ClientChannel(org.apache.cayenne.remote.ClientConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ClientChannel</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public ClientChannel(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>since 3.1 use |
| <a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)"><code>ClientChannel(ClientConnection, boolean, EventManager, boolean)</code></a></i></div> |
| <div class="block">Creates a new channel accessing remote server via provided connection. Channel |
| created using this constructor will post no events of its own and provide its users |
| with a multithreaded EventManager.</div> |
| </li> |
| </ul> |
| <a name="ClientChannel(org.apache.cayenne.remote.ClientConnection, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ClientChannel</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public ClientChannel(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection, |
| boolean channelEventsEnabled)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>since 3.1 use |
| <a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)"><code>ClientChannel(ClientConnection, boolean, EventManager, boolean)</code></a></i></div> |
| </li> |
| </ul> |
| <a name="ClientChannel(org.apache.cayenne.remote.ClientConnection, boolean, org.apache.cayenne.event.EventManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ClientChannel</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public ClientChannel(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection, |
| boolean channelEventsEnabled, |
| <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> eventManager) |
| throws <a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>since 3.1 use |
| <a href="../../../../org/apache/cayenne/remote/ClientChannel.html#ClientChannel(org.apache.cayenne.remote.ClientConnection,%20boolean,%20org.apache.cayenne.event.EventManager,%20boolean)"><code>ClientChannel(ClientConnection, boolean, EventManager, boolean)</code></a></i></div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="ClientChannel(org.apache.cayenne.remote.ClientConnection, boolean, org.apache.cayenne.event.EventManager, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ClientChannel</h4> |
| <pre>public ClientChannel(<a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> connection, |
| boolean channelEventsEnabled, |
| <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> eventManager, |
| boolean remoteEventsOptional) |
| throws <a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>remoteEventsOptional</code> - if true, failure to start an EventBridge will not |
| result in an exception.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></code></dd><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</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="getConnection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote">ClientConnection</a> getConnection()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="isChannelEventsEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isChannelEventsEnabled</h4> |
| <pre>public boolean isChannelEventsEnabled()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getEventManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventManager</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> getEventManager()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cayenne/DataChannel.html#getEventManager()">DataChannel</a></code></strong></div> |
| <div class="block">Returns an EventManager associated with this channel. Channel may return null if |
| EventManager is not available for any reason.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/DataChannel.html#getEventManager()">getEventManager</a></code> in interface <code><a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onQuery(org.apache.cayenne.ObjectContext, org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onQuery</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a> onQuery(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cayenne/DataChannel.html#onQuery(org.apache.cayenne.ObjectContext,%20org.apache.cayenne.query.Query)">DataChannel</a></code></strong></div> |
| <div class="block">Executes a query, using provided <em>context</em> to register persistent objects if |
| query returns any objects.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/DataChannel.html#onQuery(org.apache.cayenne.ObjectContext,%20org.apache.cayenne.query.Query)">onQuery</a></code> in interface <code><a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - an ObjectContext that originated the query, used to |
| register result objects.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a generic response object that encapsulates result of the execution.</dd></dl> |
| </li> |
| </ul> |
| <a name="onSync(org.apache.cayenne.ObjectContext, org.apache.cayenne.graph.GraphDiff, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSync</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> onSync(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> originatingContext, |
| <a href="../../../../org/apache/cayenne/graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes, |
| int syncType)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cayenne/DataChannel.html#onSync(org.apache.cayenne.ObjectContext,%20org.apache.cayenne.graph.GraphDiff,%20int)">DataChannel</a></code></strong></div> |
| <div class="block">Processes synchronization request from a child ObjectContext, returning a GraphDiff |
| that describes changes to objects made on the receiving end as a result of |
| synchronization.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/DataChannel.html#onSync(org.apache.cayenne.ObjectContext,%20org.apache.cayenne.graph.GraphDiff,%20int)">onSync</a></code> in interface <code><a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>originatingContext</code> - an ObjectContext that initiated the sync. Can be null.</dd><dd><code>changes</code> - diff from the context that initiated the sync.</dd><dd><code>syncType</code> - One of <a href="../../../../org/apache/cayenne/DataChannel.html#FLUSH_NOCASCADE_SYNC"><code>DataChannel.FLUSH_NOCASCADE_SYNC</code></a>, <a href="../../../../org/apache/cayenne/DataChannel.html#FLUSH_CASCADE_SYNC"><code>DataChannel.FLUSH_CASCADE_SYNC</code></a>, |
| <a href="../../../../org/apache/cayenne/DataChannel.html#ROLLBACK_CASCADE_SYNC"><code>DataChannel.ROLLBACK_CASCADE_SYNC</code></a>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getEntityResolver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityResolver</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> getEntityResolver()</pre> |
| <div class="block">Returns EntityResolver obtained from the server. On first access, this method sends |
| a message to the server to retrieve the EntityResolver. On subsequent calls locally |
| cached resolver is used.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/DataChannel.html#getEntityResolver()">getEntityResolver</a></code> in interface <code><a href="../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setupRemoteChannelListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setupRemoteChannelListener</h4> |
| <pre>protected boolean setupRemoteChannelListener() |
| throws <a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></pre> |
| <div class="block">Starts up an EventBridge to listen for remote updates. Returns true if the listener |
| was setup, false if not. False can be returned if the underlying connection doesn't |
| support events of if there is no EventManager available.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="send(org.apache.cayenne.remote.ClientMessage, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre>protected <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> send(<a href="../../../../org/apache/cayenne/remote/ClientMessage.html" title="interface in org.apache.cayenne.remote">ClientMessage</a> message, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> resultClass)</pre> |
| <div class="block">Sends a message via connector, getting a result as an instance of a specific class.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></code> - if an underlying connector |
| exception occurred, or a result is not of expected type.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClientChannel.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/remote/BootstrapMessage.html" title="class in org.apache.cayenne.remote"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/remote/ClientConnection.html" title="interface in org.apache.cayenne.remote"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/remote/ClientChannel.html" target="_top">Frames</a></li> |
| <li><a href="ClientChannel.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |