Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / configuration / server / ServerModule.html
blob: 4da3636f012925a762575d409ec7f1c91c74b8f5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>ServerModule (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.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.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":9,"i3":41,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.configuration.server</a></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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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><code><a href="../../di/Module.html" title="interface in org.apache.cayenne.di">Module</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ServerModule</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="../../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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ServerModule</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="ServerModule.html" title="class in org.apache.cayenne.configuration.server"><code>ServerModule</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.apache.cayenne.di.Binder)">configure</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server">DbAdapterDetector</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeAdapterDetectors(org.apache.cayenne.di.Binder)">contributeAdapterDetectors</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI collection builder for <a href="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="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeDefaultTypes(org.apache.cayenne.di.Binder)">contributeDefaultTypes</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI collection builder for default adapter-agnostic <a href="../../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="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeDomainFilters(org.apache.cayenne.di.Binder)">contributeDomainFilters</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since 4.1 use <a href="#contributeDomainQueryFilters(org.apache.cayenne.di.Binder)"><code>contributeDomainQueryFilters(Binder)</code></a> and <a href="#contributeDomainSyncFilters(org.apache.cayenne.di.Binder)"><code>contributeDomainSyncFilters(Binder)</code></a></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeDomainListeners(org.apache.cayenne.di.Binder)">contributeDomainListeners</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<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="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../DataChannelQueryFilter.html" title="interface in org.apache.cayenne">DataChannelQueryFilter</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeDomainQueryFilters(org.apache.cayenne.di.Binder)">contributeDomainQueryFilters</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI collection builder for <a href="../../DataChannelQueryFilter.html" title="interface in org.apache.cayenne"><code>DataChannelQueryFilter</code></a>'s that allows downstream modules to
"contribute" their own DataDomain query filters</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../DataChannelSyncFilter.html" title="interface in org.apache.cayenne">DataChannelSyncFilter</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeDomainSyncFilters(org.apache.cayenne.di.Binder)">contributeDomainSyncFilters</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI collection builder for <a href="../../DataChannelSyncFilter.html" title="interface in org.apache.cayenne"><code>DataChannelSyncFilter</code></a>'s that allows downstream modules to
"contribute" their own DataDomain sync filters</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</a>&lt;<a href="../../dba/PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributePkGenerators(org.apache.cayenne.di.Binder)">contributePkGenerators</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI map builder for <a href="../../dba/PkGenerator.html" title="interface in org.apache.cayenne.dba"><code>PkGenerator</code></a>'s that allows downstream modules to
"contribute" their own pk generators.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeProjectLocations(org.apache.cayenne.di.Binder)">contributeProjectLocations</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<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="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeProperties(org.apache.cayenne.di.Binder)">contributeProperties</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<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="i10" class="altColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types">ExtendedTypeFactory</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeTypeFactories(org.apache.cayenne.di.Binder)">contributeTypeFactories</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI collection builder for <a href="../../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="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeUserTypes(org.apache.cayenne.di.Binder)">contributeUserTypes</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">
<div class="block">Provides access to a DI collection builder for <a href="../../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="i12" class="altColor">
<td class="colFirst"><code>static <a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ValueObjectType.html" title="interface in org.apache.cayenne.access.types">ValueObjectType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contributeValueObjectTypes(org.apache.cayenne.di.Binder)">contributeValueObjectTypes</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSnapshotCacheSize(org.apache.cayenne.di.Binder,int)">setSnapshotCacheSize</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder,
int&nbsp;size)</code></th>
<td class="colLast">
<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="i14" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useExternalTransactions(org.apache.cayenne.di.Binder,boolean)">useExternalTransactions</a></span>&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder,
boolean&nbsp;useExternal)</code></th>
<td class="colLast">
<div class="block">Sets transaction management to either external or internal transactions.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerModule</h4>
<pre>public&nbsp;ServerModule()</pre>
<div class="block">Creates a new <a href="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>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="useExternalTransactions(org.apache.cayenne.di.Binder,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useExternalTransactions</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;useExternalTransactions&#8203;(<a href="../../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 id="setSnapshotCacheSize(org.apache.cayenne.di.Binder,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSnapshotCacheSize</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setSnapshotCacheSize&#8203;(<a href="../../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 id="contributeProjectLocations(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeProjectLocations</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;contributeProjectLocations&#8203;(<a href="../../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 id="contributeDomainFilters(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDomainFilters</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a>&gt;&nbsp;contributeDomainFilters&#8203;(<a href="../../di/Binder.html" title="interface in org.apache.cayenne.di">Binder</a>&nbsp;binder)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">since 4.1 use <a href="#contributeDomainQueryFilters(org.apache.cayenne.di.Binder)"><code>contributeDomainQueryFilters(Binder)</code></a> and <a href="#contributeDomainSyncFilters(org.apache.cayenne.di.Binder)"><code>contributeDomainSyncFilters(Binder)</code></a></div>
</div>
<div class="block">Provides access to a DI collection builder for <a href="../../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 id="contributeDomainQueryFilters(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDomainQueryFilters</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../DataChannelQueryFilter.html" title="interface in org.apache.cayenne">DataChannelQueryFilter</a>&gt;&nbsp;contributeDomainQueryFilters&#8203;(<a href="../../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="../../DataChannelQueryFilter.html" title="interface in org.apache.cayenne"><code>DataChannelQueryFilter</code></a>'s that allows downstream modules to
"contribute" their own DataDomain query 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 DataChannelQueryFilter.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a id="contributeDomainSyncFilters(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDomainSyncFilters</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../DataChannelSyncFilter.html" title="interface in org.apache.cayenne">DataChannelSyncFilter</a>&gt;&nbsp;contributeDomainSyncFilters&#8203;(<a href="../../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="../../DataChannelSyncFilter.html" title="interface in org.apache.cayenne"><code>DataChannelSyncFilter</code></a>'s that allows downstream modules to
"contribute" their own DataDomain sync 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 DataChannelSyncFilter.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a id="contributeDomainListeners(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDomainListeners</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;contributeDomainListeners&#8203;(<a href="../../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 id="contributeAdapterDetectors(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeAdapterDetectors</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="DbAdapterDetector.html" title="interface in org.apache.cayenne.configuration.server">DbAdapterDetector</a>&gt;&nbsp;contributeAdapterDetectors&#8203;(<a href="../../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="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 id="contributePkGenerators(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributePkGenerators</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</a>&lt;<a href="../../dba/PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a>&gt;&nbsp;contributePkGenerators&#8203;(<a href="../../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 <a href="../../dba/PkGenerator.html" title="interface in org.apache.cayenne.dba"><code>PkGenerator</code></a>'s that allows downstream modules to
"contribute" their own pk generators.</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.1</dd>
</dl>
</li>
</ul>
<a id="contributeProperties(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeProperties</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;contributeProperties&#8203;(<a href="../../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 id="contributeTypeFactories(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeTypeFactories</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types">ExtendedTypeFactory</a>&gt;&nbsp;contributeTypeFactories&#8203;(<a href="../../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="../../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 id="contributeDefaultTypes(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeDefaultTypes</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;&nbsp;contributeDefaultTypes&#8203;(<a href="../../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="../../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 id="contributeUserTypes(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeUserTypes</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&gt;&nbsp;contributeUserTypes&#8203;(<a href="../../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="../../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="#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 id="contributeValueObjectTypes(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contributeValueObjectTypes</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a>&lt;<a href="../../access/types/ValueObjectType.html" title="interface in org.apache.cayenne.access.types">ValueObjectType</a>&gt;&nbsp;contributeValueObjectTypes&#8203;(<a href="../../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 id="configure(org.apache.cayenne.di.Binder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configure&#8203;(<a href="../../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="../../di/Module.html#configure(org.apache.cayenne.di.Binder)">configure</a></code>&nbsp;in interface&nbsp;<code><a href="../../di/Module.html" title="interface in org.apache.cayenne.di">Module</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>