Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / configuration / server / ServerModule.html
blob: b8630eeb604b72aeeb809aae9df1f40f46c74aa2 [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:15 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ServerModule (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="ServerModule (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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/ServerModule.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/PropertyDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntime.html" title="class in org.apache.cayenne.configuration.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/ServerModule.html" target="_top">Frames</a></li>
<li><a href="ServerModule.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="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.configuration.server</div>
<h2 title="Class ServerModule" class="title">Class ServerModule</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>org.apache.cayenne.configuration.server.ServerModule</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/di/Module.html" title="interface in org.apache.cayenne.di">Module</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ServerModule</span>
extends <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>
implements <a href="../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a></pre>
<div class="block">A DI module containing all Cayenne server runtime configuration.</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>protected <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/server/ServerModule.html#configurationLocations">configurationLocations</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
</table>
</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/server/ServerModule.html#ServerModule--">ServerModule</a></span>()</code>
<div class="block">Creates a new <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><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#ServerModule-java.lang.String-java.lang.String...-">ServerModule</a></span>(<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>&nbsp;firstConfigLocation,
<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>...&nbsp;configurationLocations)</code>
<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/server/ServerRuntimeBuilder.html#addConfig-java.lang.String-"><code>ServerRuntimeBuilder.addConfig(String)</code></a> and/or
<a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeProjectLocations-org.apache.cayenne.di.Binder-"><code>contributeProjectLocations(Binder)</code></a> to specify locations.</span></div>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#configure-org.apache.cayenne.di.Binder-">configure</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server">DbAdapterDetector</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeAdapterDetectors-org.apache.cayenne.di.Binder-">contributeAdapterDetectors</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server"><code>DbAdapterDetector</code></a>'s that allows downstream modules to
"contribute" their own adapter detectors.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeDefaultTypes-org.apache.cayenne.di.Binder-">contributeDefaultTypes</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for default adapter-agnostic <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedType</code></a>'s that allows
downstream modules to "contribute" their own types.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeDomainFilters-org.apache.cayenne.di.Binder-">contributeDomainFilters</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/DataChannelFilter.html" title="interface in org.apache.cayenne"><code>DataChannelFilter</code></a>'s that allows downstream modules to
"contribute" their own DataDomain filters</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeDomainListeners-org.apache.cayenne.di.Binder-">contributeDomainListeners</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for lifecycle events listeners.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeProjectLocations-org.apache.cayenne.di.Binder-">contributeProjectLocations</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for String locations that allows downstream modules to
"contribute" their own Cayenne project locations.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeProperties-org.apache.cayenne.di.Binder-">contributeProperties</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI map builder for runtime properties that allows downstream modules to
"contribute" their own properties.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types">ExtendedTypeFactory</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeTypeFactories-org.apache.cayenne.di.Binder-">contributeTypeFactories</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedTypeFactory</code></a>'s that allows downstream modules to
"contribute" their own factories.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeUserTypes-org.apache.cayenne.di.Binder-">contributeUserTypes</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedType</code></a>'s that allows downstream modules to "contribute"
their own types.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="interface in org.apache.cayenne.access.types">ValueObjectType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeValueObjectTypes-org.apache.cayenne.di.Binder-">contributeValueObjectTypes</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#setSnapshotCacheSize-org.apache.cayenne.di.Binder-int-">setSnapshotCacheSize</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder,
int&nbsp;size)</code>
<div class="block">Sets max size of snapshot cache, in pre 4.0 version this was set in the Modeler.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#useExternalTransactions-org.apache.cayenne.di.Binder-boolean-">useExternalTransactions</a></span>(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder,
boolean&nbsp;useExternal)</code>
<div class="block">Sets transaction management to either external or internal transactions.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="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="configurationLocations">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configurationLocations</h4>
<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>
protected&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>[] configurationLocations</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ServerModule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ServerModule</h4>
<pre>public&nbsp;ServerModule()</pre>
<div class="block">Creates a new <a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html" title="class in org.apache.cayenne.configuration.server"><code>ServerModule</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="ServerModule-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerModule</h4>
<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&nbsp;ServerModule(<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>&nbsp;firstConfigLocation,
<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>...&nbsp;configurationLocations)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 4.0 use <a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntimeBuilder.html#addConfig-java.lang.String-"><code>ServerRuntimeBuilder.addConfig(String)</code></a> and/or
<a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeProjectLocations-org.apache.cayenne.di.Binder-"><code>contributeProjectLocations(Binder)</code></a> to specify locations.</span></div>
<div class="block">Creates a ServerModule with at least one configuration location. For multi-module projects additional locations
can be specified as well.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="useExternalTransactions-org.apache.cayenne.di.Binder-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useExternalTransactions</h4>
<pre>public static&nbsp;void&nbsp;useExternalTransactions(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder,
boolean&nbsp;useExternal)</pre>
<div class="block">Sets transaction management to either external or internal transactions. Default is internally-managed transactions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dd><code>useExternal</code> - whether external (true) or internal (false) transaction management should be used.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="setSnapshotCacheSize-org.apache.cayenne.di.Binder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSnapshotCacheSize</h4>
<pre>public static&nbsp;void&nbsp;setSnapshotCacheSize(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder,
int&nbsp;size)</pre>
<div class="block">Sets max size of snapshot cache, in pre 4.0 version this was set in the Modeler.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dd><code>size</code> - max size of snapshot cache</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeProjectLocations-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeProjectLocations</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</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>&gt;&nbsp;contributeProjectLocations(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for String locations that allows downstream modules to
"contribute" their own Cayenne project locations.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for String locations.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeDomainFilters-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDomainFilters</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a>&gt;&nbsp;contributeDomainFilters(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/DataChannelFilter.html" title="interface in org.apache.cayenne"><code>DataChannelFilter</code></a>'s that allows downstream modules to
"contribute" their own DataDomain filters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for DataChannelFilter.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeDomainListeners-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDomainListeners</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<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>&gt;&nbsp;contributeDomainListeners(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for lifecycle events listeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for listener Objects.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeAdapterDetectors-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeAdapterDetectors</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server">DbAdapterDetector</a>&gt;&nbsp;contributeAdapterDetectors(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server"><code>DbAdapterDetector</code></a>'s that allows downstream modules to
"contribute" their own adapter detectors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for DbAdapterDetectors.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeProperties-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeProperties</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</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>&gt;&nbsp;contributeProperties(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI map builder for runtime properties that allows downstream modules to
"contribute" their own properties.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MapBuilder for properties.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeTypeFactories-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeTypeFactories</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types">ExtendedTypeFactory</a>&gt;&nbsp;contributeTypeFactories(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedTypeFactory</code></a>'s that allows downstream modules to
"contribute" their own factories.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for ExtendedTypes.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeDefaultTypes-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDefaultTypes</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;&nbsp;contributeDefaultTypes(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for default adapter-agnostic <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedType</code></a>'s that allows
downstream modules to "contribute" their own types. "Default" types are loaded before adapter-provided or "user"
types, so they may be overridden by those.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for ExtendedTypes.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeUserTypes-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeUserTypes</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;&nbsp;contributeUserTypes(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="block">Provides access to a DI collection builder for <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedType</code></a>'s that allows downstream modules to "contribute"
their own types. Unlike "default" types (see <a href="../../../../../org/apache/cayenne/configuration/server/ServerModule.html#contributeDefaultTypes-org.apache.cayenne.di.Binder-"><code>contributeDefaultTypes(Binder)</code></a>), "user" types are loaded
after the adapter-provided types and can override those.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to the module during injector startup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for ExtendedTypes.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="contributeValueObjectTypes-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeValueObjectTypes</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="interface in org.apache.cayenne.access.types">ValueObjectType</a>&gt;&nbsp;contributeValueObjectTypes(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binder</code> - DI binder passed to module during injector startup</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ListBuilder for user-contributed ValueObjectTypes</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a name="configure-org.apache.cayenne.di.Binder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configure</h4>
<pre>public&nbsp;void&nbsp;configure(<a href="../../../../../org/apache/cayenne/di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/cayenne/di/Module.html#configure-org.apache.cayenne.di.Binder-">configure</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di">Module</a></code></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>
<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/ServerModule.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/PropertyDataSourceFactory.html" title="class in org.apache.cayenne.configuration.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/configuration/server/ServerRuntime.html" title="class in org.apache.cayenne.configuration.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/ServerModule.html" target="_top">Frames</a></li>
<li><a href="ServerModule.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="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>