| <!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>ServerRuntime (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="ServerRuntime (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/ServerRuntime.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/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cayenne/configuration/server/XMLPoolingDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/ServerRuntime.html" target="_top">Frames</a></li> |
| <li><a href="ServerRuntime.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="#fields_inherited_from_class_org.apache.cayenne.configuration.CayenneRuntime">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>Field | </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.configuration.server</div> |
| <h2 title="Class ServerRuntime" class="title">Class ServerRuntime</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><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>org.apache.cayenne.configuration.server.ServerRuntime</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ServerRuntime</span> |
| extends <a href="../../../../../org/apache/cayenne/configuration/CayenneRuntime.html" title="class in org.apache.cayenne.configuration">CayenneRuntime</a></pre> |
| <div class="block">An object representing Cayenne server-stack that connects directly to the database via |
| JDBC. This is an entry point for user applications to access Cayenne, which |
| encapsulates the dependency injection internals. The term "server" is used as opposed |
| to ROP "client" (see <a href="../../../../../org/apache/cayenne/configuration/rop/client/ClientRuntime.html" title="class in org.apache.cayenne.configuration.rop.client"><code>ClientRuntime</code></a>). Any application, desktop, server, etc. |
| that has a direct JDBC connection should be using this runtime.</div> |
| <dl><dt><span class="strong">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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.configuration.CayenneRuntime"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class 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="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/configuration/server/ServerRuntime.html#ServerRuntime(java.lang.String[],%20org.apache.cayenne.di.Module...)">ServerRuntime</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>[] configurationLocations, |
| <a href="../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>... extraModules)</code> |
| <div class="block">Creates a server runtime configuring it with a standard set of services contained |
| in <a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><code>ServerModule</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntime.html#ServerRuntime(java.lang.String,%20org.apache.cayenne.di.Module...)">ServerRuntime</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> configurationLocation, |
| <a href="../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>... extraModules)</code> |
| <div class="block">Creates a server runtime configuring it with a standard set of services contained |
| in <a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><code>ServerModule</code></a>.</div> |
| </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/access/DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntime.html#getDataDomain()">getDataDomain</a></strong>()</code> |
| <div class="block">Returns the main runtime DataDomain.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql">DataSource</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntime.html#getDataSource(java.lang.String)">getDataSource</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> dataNodeName)</code> |
| <div class="block">Provides access to the JDBC DataSource assigned to a given DataNode.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.configuration.CayenneRuntime"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#mergeModules(org.apache.cayenne.di.Module,%20java.util.Collection)">mergeModules</a>, <a href="../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#mergeModules(org.apache.cayenne.di.Module,%20org.apache.cayenne.di.Module...)">mergeModules</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 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ServerRuntime(java.lang.String, org.apache.cayenne.di.Module...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServerRuntime</h4> |
| <pre>public ServerRuntime(<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> configurationLocation, |
| <a href="../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>... extraModules)</pre> |
| <div class="block">Creates a server runtime configuring it with a standard set of services contained |
| in <a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><code>ServerModule</code></a>. CayenneServerModule is created with provided |
| 'configurationLocation'. An optional array of extra modules may contain service |
| overrides and/or user services.</div> |
| </li> |
| </ul> |
| <a name="ServerRuntime(java.lang.String[], org.apache.cayenne.di.Module...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServerRuntime</h4> |
| <pre>public ServerRuntime(<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>[] configurationLocations, |
| <a href="../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a>... extraModules)</pre> |
| <div class="block">Creates a server runtime configuring it with a standard set of services contained |
| in <a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><code>ServerModule</code></a>. CayenneServerModule is created with one or more |
| 'configurationLocations'. An optional array of extra modules may contain service |
| overrides and/or user services.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDataDomain()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataDomain</h4> |
| <pre>public <a href="../../../../../org/apache/cayenne/access/DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a> getDataDomain()</pre> |
| <div class="block">Returns the main runtime DataDomain. Note that by default the returned DataDomain |
| is the same as the main DataChannel returned by <a href="../../../../../org/apache/cayenne/configuration/CayenneRuntime.html#getChannel()"><code>CayenneRuntime.getChannel()</code></a>. Although |
| users may redefine DataChannel provider in the DI registry, for instance to |
| decorate this DataDomain with a custom wrapper.</div> |
| </li> |
| </ul> |
| <a name="getDataSource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDataSource</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql">DataSource</a> getDataSource(<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> dataNodeName)</pre> |
| <div class="block">Provides access to the JDBC DataSource assigned to a given DataNode. A null |
| argument will work if there's only one DataNode configured. |
| <p> |
| Normally Cayenne applications don't need to access DataSource or any other JDBC |
| code directly, however in some unusual conditions it may be needed, and this method |
| provides a shortcut to raw JDBC.</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/ServerRuntime.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/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cayenne/configuration/server/XMLPoolingDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/ServerRuntime.html" target="_top">Frames</a></li> |
| <li><a href="ServerRuntime.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="#fields_inherited_from_class_org.apache.cayenne.configuration.CayenneRuntime">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>Field | </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> |
