blob: 7d5a381c56548b34a0927317e098cbebb36fb7bc [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 (1.8.0_112) on Mon Oct 14 11:36:16 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientLocalRuntime (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-14">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClientLocalRuntime (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/ClientLocalRuntime.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/configuration/rop/client/ClientConstants.html" title="class in org.apache.cayenne.configuration.rop.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientModule.html" title="class in org.apache.cayenne.configuration.rop.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cayenne/configuration/rop/client/ClientLocalRuntime.html" target="_top">Frames</a></li>
<li><a href="ClientLocalRuntime.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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="#methods.inherited.from.class.org.apache.cayenne.configuration.rop.client.ClientRuntime">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>Method</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.configuration.rop.client</div>
<h2 title="Class ClientLocalRuntime" class="title">Class ClientLocalRuntime</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html" title="class in org.apache.cayenne.configuration">org.apache.cayenne.configuration.CayenneRuntime</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html" title="class in org.apache.cayenne.configuration.rop.client">org.apache.cayenne.configuration.rop.client.ClientRuntime</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.configuration.rop.client.ClientLocalRuntime</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 4.0, use <a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntimeBuilder.html#local-org.apache.cayenne.di.Injector-"><code>ClientRuntimeBuilder.local(Injector)</code></a></span></div>
</div>
<br>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public class <span class="typeNameLabel">ClientLocalRuntime</span>
extends <a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html" title="class in org.apache.cayenne.configuration.rop.client">ClientRuntime</a></pre>
<div class="block">A <a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html" title="class in org.apache.cayenne.configuration.rop.client"><code>ClientRuntime</code></a> that provides an ROP stack based on a local
connection on top of a server stack.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</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="memberSummary" 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>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientLocalRuntime.html#CLIENT_SERVER_CHANNEL_KEY">CLIENT_SERVER_CHANNEL_KEY</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.configuration.CayenneRuntime">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.configuration.<a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html" title="class in org.apache.cayenne.configuration">CayenneRuntime</a></h3>
<code><a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#injector">injector</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#modules">modules</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#threadInjector">threadInjector</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientLocalRuntime.html#ClientLocalRuntime-org.apache.cayenne.di.Injector-java.util.Map-java.util.Collection-">ClientLocalRuntime</a></span>(<a href="../../../../../../org/apache/cayenne/di/Injector.html" title="interface in org.apache.cayenne.di">Injector</a>&nbsp;serverInjector,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;properties,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>&gt;&nbsp;extraModules)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientLocalRuntime.html#ClientLocalRuntime-org.apache.cayenne.di.Injector-java.util.Map-org.apache.cayenne.di.Module...-">ClientLocalRuntime</a></span>(<a href="../../../../../../org/apache/cayenne/di/Injector.html" title="interface in org.apache.cayenne.di">Injector</a>&nbsp;serverInjector,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;properties,
<a href="../../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>...&nbsp;extraModules)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.configuration.rop.client.ClientRuntime">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.configuration.rop.client.<a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html" title="class in org.apache.cayenne.configuration.rop.client">ClientRuntime</a></h3>
<code><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html#builder--">builder</a>, <a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html#getConnection--">getConnection</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.configuration.CayenneRuntime">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.configuration.<a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html" title="class in org.apache.cayenne.configuration">CayenneRuntime</a></h3>
<code><a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#bindThreadInjector-org.apache.cayenne.di.Injector-">bindThreadInjector</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getChannel--">getChannel</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getContext--">getContext</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getContext-org.apache.cayenne.DataChannel-">getContext</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getInjector--">getInjector</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getModules--">getModules</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getThreadInjector--">getThreadInjector</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#newContext--">newContext</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#newContext-org.apache.cayenne.DataChannel-">newContext</a>, <a href="../../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#shutdown--">shutdown</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="CLIENT_SERVER_CHANNEL_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CLIENT_SERVER_CHANNEL_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CLIENT_SERVER_CHANNEL_KEY</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0 moved to <a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html#CLIENT_SERVER_CHANNEL_KEY"><code>ClientRuntime.CLIENT_SERVER_CHANNEL_KEY</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.cayenne.configuration.rop.client.ClientLocalRuntime.CLIENT_SERVER_CHANNEL_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ClientLocalRuntime-org.apache.cayenne.di.Injector-java.util.Map-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ClientLocalRuntime</h4>
<pre>public&nbsp;ClientLocalRuntime(<a href="../../../../../../org/apache/cayenne/di/Injector.html" title="interface in org.apache.cayenne.di">Injector</a>&nbsp;serverInjector,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;properties,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>&gt;&nbsp;extraModules)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="ClientLocalRuntime-org.apache.cayenne.di.Injector-java.util.Map-org.apache.cayenne.di.Module...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientLocalRuntime</h4>
<pre>public&nbsp;ClientLocalRuntime(<a href="../../../../../../org/apache/cayenne/di/Injector.html" title="interface in org.apache.cayenne.di">Injector</a>&nbsp;serverInjector,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;properties,
<a href="../../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>...&nbsp;extraModules)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/ClientLocalRuntime.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/configuration/rop/client/ClientConstants.html" title="class in org.apache.cayenne.configuration.rop.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/cayenne/configuration/rop/client/ClientModule.html" title="class in org.apache.cayenne.configuration.rop.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cayenne/configuration/rop/client/ClientLocalRuntime.html" target="_top">Frames</a></li>
<li><a href="ClientLocalRuntime.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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="#methods.inherited.from.class.org.apache.cayenne.configuration.rop.client.ClientRuntime">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>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>