blob: e334e4859f7172c775cb5dee69f741fce0860391 [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:20 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.cayenne.configuration.server (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="org.apache.cayenne.configuration.server (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/server/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/cayenne/configuration/web/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.cayenne.configuration.server</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/CayenneServerModuleProvider.html" title="interface in org.apache.cayenne.configuration.server">CayenneServerModuleProvider</a></td>
<td class="colLast">
<div class="block">This interface implementations will be used by <a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntimeBuilder.html" title="class in org.apache.cayenne.configuration.server"><code>ServerRuntimeBuilder</code></a> to auto-load server modules.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DataNodeFactory.html" title="interface in org.apache.cayenne.configuration.server">DataNodeFactory</a></td>
<td class="colLast">
<div class="block">A factory for creating DataNodes from descriptors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DataSourceFactory.html" title="interface in org.apache.cayenne.configuration.server">DataSourceFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server">DbAdapterDetector</a></td>
<td class="colLast">
<div class="block">A factory interface providing DbAdapter based on JDBC metadata.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterFactory.html" title="interface in org.apache.cayenne.configuration.server">DbAdapterFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DataContextFactory.html" title="class in org.apache.cayenne.configuration.server">DataContextFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DataDomainProvider.html" title="class in org.apache.cayenne.configuration.server">DataDomainProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne"><code>DataChannel</code></a> provider that provides a single instance of DataDomain
configured per configuration supplied via injected
<a href="../../../../../org/apache/cayenne/configuration/DataChannelDescriptorLoader.html" title="interface in org.apache.cayenne.configuration"><code>DataChannelDescriptorLoader</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DefaultDataNodeFactory.html" title="class in org.apache.cayenne.configuration.server">DefaultDataNodeFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DefaultDbAdapterFactory.html" title="class in org.apache.cayenne.configuration.server">DefaultDbAdapterFactory</a></td>
<td class="colLast">
<div class="block">A factory of DbAdapters that either loads user-provided adapter or guesses
the adapter type from the database metadata.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DelegatingDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server">DelegatingDataSourceFactory</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/cayenne/configuration/server/DataSourceFactory.html" title="interface in org.apache.cayenne.configuration.server"><code>DataSourceFactory</code></a> that delegates DataSource creation to another factory,
which is determined dynamically per DataNodeDescriptor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DomainDataChannelProvider.html" title="class in org.apache.cayenne.configuration.server">DomainDataChannelProvider</a></td>
<td class="colLast">
<div class="block">This is a default implementation of a DataChannel provider that simply returns a
DataDomain for a given runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/JNDIDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server">JNDIDataSourceFactory</a></td>
<td class="colLast">
<div class="block">Locates DataSource mapped via JNDI.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/MainCayenneServerModuleProvider.html" title="class in org.apache.cayenne.configuration.server">MainCayenneServerModuleProvider</a></td>
<td class="colLast">
<div class="block">ServerModule auto-loading facility.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/PropertyDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server">PropertyDataSourceFactory</a></td>
<td class="colLast">
<div class="block">A DataSourceFactrory that creates a DataSource based on system properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server">ServerModule</a></td>
<td class="colLast">
<div class="block">A DI module containing all Cayenne server runtime configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntime.html" title="class in org.apache.cayenne.configuration.server">ServerRuntime</a></td>
<td class="colLast">
<div class="block">Object representing Cayenne stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntimeBuilder.html" title="class in org.apache.cayenne.configuration.server">ServerRuntimeBuilder</a></td>
<td class="colLast">
<div class="block">A convenience class to assemble custom ServerRuntime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/XMLPoolingDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server">XMLPoolingDataSourceFactory</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/cayenne/configuration/server/DataSourceFactory.html" title="interface in org.apache.cayenne.configuration.server"><code>DataSourceFactory</code></a> that loads JDBC connection information from an
XML resource associated with the DataNodeDescriptor, returning a DataSource
with simple connection pooling.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/cayenne/configuration/server/DataDomainLoadException.html" title="class in org.apache.cayenne.configuration.server">DataDomainLoadException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/server/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/cayenne/configuration/web/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>