Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / 7bae487f45ea47ce0120322304c66c82f6be5da6 / . / documentation / 2.6 / jpa / extensions / persistenceproperties_ref.htm
blob: 34f49ecee6d37c2841b7848032c4edeee9204c86 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<title>Persistence Property Extensions Reference | EclipseLink 2.6.x Java Persistence API (JPA) Extensions Reference</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" />
<meta name="date" content="2014-06-10T10:29:49Z" />
<meta name="description" content="This chapter describes the persistence property extensions.You configure persistence units in the JPA persistence descriptor file: persistence.xml. EclipseLink includes many persistence property enhancements and extensions that can be configured in the persistence." />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Persistence Property Extensions Reference" />
<meta name="relnum" content="Release 2.6" />
<link rel="stylesheet" type="text/css" href="../../../dcommon/style.css" media="screen" />
<link rel="copyright" href="http://www.eclipse.org/org/documents/epl-v10.php" title="Copyright" type="text/html" />
<link rel="start" href="../../index.htm" title="Home" type="text/html" />
<link rel="contents" href="toc.htm" title="Contents" type="text/html" />
<link rel="prev" href="queryhints.htm" title="Previous" type="text/html" />
<link rel="next" href="schema.htm" title="Next" type="text/html" />
<!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head>
<body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:4sqnhke2any', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div>
<div class="header"><a id="top" name="top"></a>
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" valign="top"><div class="booktitle">Java Persistence API (JPA) Extensions Reference for EclipseLink,
Release 2.6</div></td>
<td valign="bottom" align="right" width="144">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../../eclipselink_jpa_extensions.pdf" title="PDF" target="_blank"><img src="../../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td><td align="center"><a href="#disqus_thread" title="Comments""><img src="../../../dcommon/images/comments.png" style="padding-right:5px;border:0" alt="Comments"><br /><span class="mini">Comments</span></a>
</tr>
</table>
</td>
</tr>
</table>
<hr />
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<tr>
<td align="center"><a href="queryhints.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="schema.htm"><img src="../../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
<td>&nbsp;</td>
</tr>
</table>
</div>
<!-- class="header" -->
<div class="ind"><!-- End Header --><a id="TLJPA826" name="TLJPA826"></a> <a id="sthref733" name="sthref733"></a>
<h1 class="chapter"><font face="arial, helvetica, sans-serif" color="#330099"><span class="secnum">5</span> Persistence Property Extensions Reference</font></h1>
<a id="TLJPA54085" name="TLJPA54085"></a>
<p>This chapter describes the persistence property extensions.You configure persistence units in the JPA persistence descriptor file: <code>persistence.xml</code>. EclipseLink includes many persistence property enhancements and extensions that can be configured in the <code>persistence.xml</code> file.</p>
<p>This chapter includes the following sections:</p>
<ul>
<li>
<p><a href="#CACGDIBI2">Functional Listing of Persistence Property Extensions</a></p>
</li>
<li>
<p><a href="#CACBGBJG2">Alphabetical Listing of Persistence Property Extensions</a></p>
</li>
</ul>
<a id="CACGDIBI2" name="CACGDIBI2"></a><a id="TLJPA1047" name="TLJPA1047"></a>
<div class="sect1">
<h2 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Functional Listing of Persistence Property Extensions</font></h2>
<p>The following lists the EclipseLink persistence property (<code>persistence.xml</code> file) extensions, categorized by function:</p>
<ul>
<li>
<p><a href="#CACGCEIJ2">Weaving</a></p>
</li>
<li>
<p><a href="#CACDIEID2">Customizers</a></p>
</li>
<li>
<p><a href="#CACJHFEC2">Validation and Optimization</a></p>
</li>
<li>
<p><a href="#CACDCCEG2">Caching</a></p>
</li>
<li>
<p><a href="#CHDBDCHB2">Mapping</a></p>
</li>
<li>
<p><a href="#CHDFDDBF">Schema generation</a></p>
</li>
<li>
<p><a href="#CHDICECH2">JDBC configuration</a></p>
</li>
<li>
<p><a href="#CHDFDDBF1">Concurrency manager</a></p>
</li>
</ul>
<a id="CACGCEIJ2" name="CACGCEIJ2"></a><a id="TLJPA1049" name="TLJPA1049"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Weaving</font></h3>
<p>EclipseLink includes the following persistence property extensions for weaving:</p>
<ul>
<li>
<p><code><a href="#weaving">weaving</a></code></p>
</li>
<li>
<p><code><a href="#CHDCEEFC">weaving.changetracking</a></code></p>
</li>
<li>
<p><code><a href="#BABGGCGC">weaving.eager</a></code></p>
</li>
<li>
<p><code><a href="#CHDDIFGE">weaving.fetchgroups</a></code></p>
</li>
<li>
<p><code><a href="#BABJICDJ">weaving.internal</a></code></p>
</li>
<li>
<p><code><a href="#BABDBIFE">weaving.lazy</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CACDIEID2" name="CACDIEID2"></a><a id="TLJPA1050" name="TLJPA1050"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Customizers</font></h3>
<p>EclipseLink includes the following persistence property extensions for customizing descriptors and sessions:</p>
<ul>
<li>
<p><code><a href="#delayonstartup">deploy-on-startup</a></code></p>
</li>
<li>
<p><code><a href="#CCHIEAIA">descriptor.customizer</a></code></p>
</li>
<li>
<p><code><a href="#session.customizer">session.customizer</a></code></p>
</li>
<li>
<p><code><a href="#CHDFDJJD">session.include.descriptor.queries</a></code></p>
</li>
<li>
<p><code><a href="#session-event-listener">session-event-listener</a></code></p>
</li>
<li>
<p><code><a href="#CHDFHEAC">session-name</a></code></p>
</li>
<li>
<p><code><a href="#sessions-xml">sessions-xml</a></code></p>
</li>
<li>
<p><code><a href="#target-database">target-database</a></code></p>
</li>
<li>
<p><code><a href="#target-server">target-server</a></code></p>
</li>
<li>
<p><code><a href="#CHDJDEDE">metadata-source</a></code></p>
</li>
<li>
<p><code><a href="#CHDEFFGG2">metadata-source.properties.file</a></code></p>
</li>
<li>
<p><code><a href="#CHDICFHG">metadata-source.send-refresh-command</a></code></p>
</li>
<li>
<p><code><a href="#CHDBFJEB">metadata-source.xml.url</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CACJHFEC2" name="CACJHFEC2"></a><a id="TLJPA1051" name="TLJPA1051"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Validation and Optimization</font></h3>
<p>EclipseLink includes the following persistence property extensions for validation.</p>
<ul>
<li>
<p><code><a href="#CCHCJCDJ">exception-handler</a></code></p>
</li>
<li>
<p><code><a href="#partitioning">partitioning</a></code></p>
</li>
<li>
<p><code><a href="#BJFEFCFC">partitioning.callback</a></code></p>
</li>
<li>
<p><code><a href="#profiler">profiler</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="TLJPA827" name="TLJPA827"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" --><a id="sthref734" name="sthref734"></a>
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Logging</font></h3>
<p>EclipseLink includes the following persistence property extensions for logging.</p>
<ul>
<li>
<p><code><a href="#CHDJCBIF">logging.connection</a></code></p>
</li>
<li>
<p><code><a href="#BEIFJBIE">logging.exceptions</a></code></p>
</li>
<li>
<p><code><a href="#BEIHGBBC">logging.file</a></code></p>
</li>
<li>
<p><code><a href="#CHDGFDDH">logging.level</a></code></p>
</li>
<li>
<p><code><a href="#BEIHGGHH">logging.session</a></code></p>
</li>
<li>
<p><code><a href="#BEIFFGGB">logging.thread</a></code></p>
</li>
<li>
<p><code><a href="#BEIJCEBJ">logging.timestamp</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CACDCCEG2" name="CACDCCEG2"></a><a id="TLJPA1052" name="TLJPA1052"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Caching</font></h3>
<p>EclipseLink includes the following persistence property extensions for caching:</p>
<ul>
<li>
<p><code><a href="#BABGBAEC">cache.coordination.channel</a></code></p>
</li>
<li>
<p><code><a href="#BABJGCIF">cache.coordination.jms.factory</a></code></p>
</li>
<li>
<p><code><a href="#BABJGJGI">cache.coordination.jms.host</a></code></p>
</li>
<li>
<p><code><a href="#CHDHJECA">cache.coordination.jms.reuse-topic-publisher</a></code></p>
</li>
<li>
<p><code><a href="#BABHEFCJ">cache.coordination.jms.topic</a></code></p>
</li>
<li>
<p><code><a href="#BABFBHGI">cache.coordination.jndi.initial-context-factory</a></code></p>
</li>
<li>
<p><code><a href="#BABJBCCF">cache.coordination.jndi.password</a></code></p>
</li>
<li>
<p><code><a href="#BABGAEHE">cache.coordination.jndi.user</a></code></p>
</li>
<li>
<p><code><a href="#BABIEEBH">cache.coordination.naming-service</a></code></p>
</li>
<li>
<p><code><a href="#BABDFGGD">cache.coordination.propagate-asynchronously</a></code></p>
</li>
<li>
<p><code><a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code></p>
</li>
<li>
<p><code><a href="#BABIEJED">cache.coordination.remove-connection-on-error</a></code></p>
</li>
<li>
<p><code><a href="#BABDGCDE">cache.coordination.rmi.announcement-delay</a></code></p>
</li>
<li>
<p><code><a href="#BABDGFEI">cache.coordination.rmi.multicast-group</a></code></p>
</li>
<li>
<p><code><a href="#BABDGFEI">cache.coordination.rmi.multicast-group</a></code></p>
</li>
<li>
<p><code><a href="#BABFBDBJ">cache.coordination.rmi.packet-time-to-live</a></code></p>
</li>
<li>
<p><code><a href="#BABCJIFC">cache.coordination.rmi.url</a></code></p>
</li>
<li>
<p><code><a href="#BABFJGIF">cache.coordination.thread.pool.size</a></code></p>
</li>
<li>
<p><code><a href="#CCHEEFGA">cache.database-event-listener</a></code></p>
</li>
<li>
<p><code><a href="#CHDEJCJJ">cache.shared</a></code></p>
</li>
<li>
<p><code><a href="#CHDIGIEC">cache.size</a></code></p>
</li>
<li>
<p><code><a href="#CHDGDIEI">cache.type</a></code></p>
</li>
<li>
<p><code><a href="#CDEJGBEI">flush-clear.cache</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CHDBDCHB2" name="CHDBDCHB2"></a><a id="TLJPA1053" name="TLJPA1053"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping</font></h3>
<p>EclipseLink includes the following persistence property extensions for mappings:</p>
<ul>
<li>
<p><code><a href="#BIICFIDB">composite-unit</a></code></p>
</li>
<li>
<p><code><a href="#CHDHCIDH">composite-unit.member</a></code></p>
</li>
<li>
<p><code><a href="#CIHGHJGA">composite-unit.properties</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CHDFDDBF" name="CHDFDDBF"></a><a id="TLJPA54051" name="TLJPA54051"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Schema generation</font></h3>
<p>EclipseLink includes the following persistence property extensions for mappings:</p>
<ul>
<li>
<p><code><a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code></p>
</li>
<li>
<p><code><a href="#BEHBIEJG">ddl.table-creation-suffix</a></code></p>
</li>
<li>
<p><code><a href="#BABHEJJI">ddl-generation</a></code></p>
</li>
<li>
<p><code><a href="#BABCDHBB">ddl-generation.output-mode</a></code></p>
</li>
<li>
<p><code><a href="#BABFEBCG">drop-ddl-jdbc-file-name</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CHDICECH2" name="CHDICECH2"></a><a id="TLJPA1054" name="TLJPA1054"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">JDBC configuration</font></h3>
<p>EclipseLink includes the following persistence property extensions for configuring JDBC connections and connection pooling:</p>
<ul>
<li>
<p><code><a href="#connectionpool">connection-pool</a></code></p>
</li>
<li>
<p><code><a href="#CHDDIIFD">connection-pool.read</a></code></p>
</li>
<li>
<p><code><a href="#BABIDAGH">connection-pool.sequence</a></code></p>
</li>
<li>
<p><code><a href="#CIHHJBFB">jdbc.allow-native-sql-queries</a></code></p>
</li>
<li>
<p><code><a href="#CIHIAGAF">jdbc.batch-writing</a></code></p>
</li>
<li>
<p><code><a href="#CIHJADHF">jdbc.batch-writing.size</a></code></p>
</li>
<li>
<p><code><a href="#CHDHAFAA">jdbc.cache-statements</a></code></p>
</li>
<li>
<p><code><a href="#CACBICGG">jdbc.cache-statements.size</a></code></p>
</li>
<li>
<p><code><a href="#CFAJHIJA">jdbc.connector</a></code></p>
</li>
<li>
<p><code><a href="#CHDCJIBF">jdbc.exclusive-connection.is-lazy</a></code></p>
</li>
<li>
<p><code><a href="#CACBICGG2">jdbc.exclusive-connection.mode</a></code></p>
</li>
<li>
<p><code><a href="#CIHEACBE">jdbc.native-sql</a></code></p>
</li>
<li>
<p><code><a href="#CIHHJHHD">jdbc.property</a></code></p>
</li>
<li>
<p><code><a href="#CIHBHCID">jdbc.sql-cast</a></code></p>
</li>
<li>
<p><code><a href="#CIHIIAFD">jdbc.uppercase-columns</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<a id="CHDFDDBF1" name="CHDFDDBF1"></a><a id="TLJPA540511" name="TLJPA540511"></a>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h3 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Concurrency manager</font></h3>
<p>EclipseLink includes the following persistence property extensions for concurrency management:</p>
<ul>
<li>
<p><code><a href="#concurrency.manager.waittime">concurrency.manager.waittime</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.maxsleeptime">concurrency.manager.maxsleeptime</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.maxfrequencytodumptinymessage">concurrency.manager.maxfrequencytodumptinymessage</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.maxfrequencytodumpmassivemessage">concurrency.manager.maxfrequencytodumpmassivemessage</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.allow.interruptedexception">concurrency.manager.allow.interruptedexception</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.allow.concurrencyexception">concurrency.manager.allow.concurrencyexception</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.allow.readlockstacktrace">concurrency.manager.allow.readlockstacktrace</a></code></p>
</li>
</ul>
</div>
<!-- class="sect2" --></div>
<!-- class="sect1" -->
<a id="CACBGBJG2" name="CACBGBJG2"></a><a id="TLJPA1055" name="TLJPA1055"></a>
<div class="sect1">
<h2 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Alphabetical Listing of Persistence Property Extensions</font></h2>
<p>The following lists the EclipseLink persistence property (<code>persitence.xml</code> file) extensions, in alphabetical order:</p>
<ul>
<li>
<p><code><a href="#CACHGDEJ">application-location</a></code></p>
</li>
<li>
<p><code><a href="#BABGBAEC">cache.coordination.channel</a></code></p>
</li>
<li>
<p><code><a href="#BABJGCIF">cache.coordination.jms.factory</a></code></p>
</li>
<li>
<p><code><a href="#BABJGJGI">cache.coordination.jms.host</a></code></p>
</li>
<li>
<p><code><a href="#CHDHJECA">cache.coordination.jms.reuse-topic-publisher</a></code></p>
</li>
<li>
<p><code><a href="#BABHEFCJ">cache.coordination.jms.topic</a></code></p>
</li>
<li>
<p><code><a href="#BABFBHGI">cache.coordination.jndi.initial-context-factory</a></code></p>
</li>
<li>
<p><code><a href="#BABJBCCF">cache.coordination.jndi.password</a></code></p>
</li>
<li>
<p><code><a href="#BABGAEHE">cache.coordination.jndi.user</a></code></p>
</li>
<li>
<p><code><a href="#BABIEEBH">cache.coordination.naming-service</a></code></p>
</li>
<li>
<p><code><a href="#BABDFGGD">cache.coordination.propagate-asynchronously</a></code></p>
</li>
<li>
<p><code><a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code></p>
</li>
<li>
<p><code><a href="#BABIEJED">cache.coordination.remove-connection-on-error</a></code></p>
</li>
<li>
<p><code><a href="#BABDGCDE">cache.coordination.rmi.announcement-delay</a></code></p>
</li>
<li>
<p><code><a href="#BABDGFEI">cache.coordination.rmi.multicast-group</a></code></p>
</li>
<li>
<p><code><a href="#BABDGFEI">cache.coordination.rmi.multicast-group</a></code></p>
</li>
<li>
<p><code><a href="#BABFBDBJ">cache.coordination.rmi.packet-time-to-live</a></code></p>
</li>
<li>
<p><code><a href="#BABCJIFC">cache.coordination.rmi.url</a></code></p>
</li>
<li>
<p><code><a href="#BABFJGIF">cache.coordination.thread.pool.size</a></code></p>
</li>
<li>
<p><code><a href="#CCHEEFGA">cache.database-event-listener</a></code></p>
</li>
<li>
<p><code><a href="#CHDEJCJJ">cache.shared</a></code></p>
</li>
<li>
<p><code><a href="#CHDIGIEC">cache.size</a></code></p>
</li>
<li>
<p><code><a href="#CHDGDIEI">cache.type</a></code></p>
</li>
<li>
<p><code><a href="#classloader">classloader</a></code></p>
</li>
<li>
<p><code><a href="#BIICFIDB">composite-unit</a></code></p>
</li>
<li>
<p><code><a href="#CHDHCIDH">composite-unit.member</a></code></p>
</li>
<li>
<p><code><a href="#CIHGHJGA">composite-unit.properties</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.waittime">concurrency.manager.waittime</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.maxsleeptime">concurrency.manager.maxsleeptime</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.maxfrequencytodumptinymessage">concurrency.manager.maxfrequencytodumptinymessage</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.maxfrequencytodumpmassivemessage">concurrency.manager.maxfrequencytodumpmassivemessage</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.allow.interruptedexception">concurrency.manager.allow.interruptedexception</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.allow.concurrencyexception">concurrency.manager.allow.concurrencyexception</a></code></p>
</li>
<li>
<p><code><a href="#concurrency.manager.allow.readlockstacktrace">concurrency.manager.allow.readlockstacktrace</a></code></p>
</li>
<li>
<p><code><a href="#connectionpool">connection-pool</a></code></p>
</li>
<li>
<p><code><a href="#CHDDIIFD">connection-pool.read</a></code></p>
</li>
<li>
<p><code><a href="#BABIDAGH">connection-pool.sequence</a></code></p>
</li>
<li>
<p><code><a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code></p>
</li>
<li>
<p><code><a href="#BEHBIEJG">ddl.table-creation-suffix</a></code></p>
</li>
<li>
<p><code><a href="#BABHEJJI">ddl-generation</a></code></p>
</li>
<li>
<p><code><a href="#BABCDHBB">ddl-generation.output-mode</a></code></p>
</li>
<li>
<p><code><a href="#BEHBIEJG">ddl.table-creation-suffix</a></code></p>
</li>
<li>
<p><code><a href="#delayonstartup">deploy-on-startup</a></code></p>
</li>
<li>
<p><code><a href="#CCHIEAIA">descriptor.customizer</a></code></p>
</li>
<li>
<p><code><a href="#BABFEBCG">drop-ddl-jdbc-file-name</a></code></p>
</li>
<li>
<p><code><a href="#CCHCJCDJ">exception-handler</a></code></p>
</li>
<li>
<p><code><a href="#CHDBIAAC">exclude-eclipselink-orm</a></code></p>
</li>
<li>
<p><code><a href="#CDEJGBEI">flush-clear.cache</a></code></p>
</li>
<li>
<p><code><a href="#CACEEGCC">id-validation</a></code></p>
</li>
<li>
<p><code><a href="#CIHHJBFB">jdbc.allow-native-sql-queries</a></code></p>
</li>
<li>
<p><code><a href="#CIHIAGAF">jdbc.batch-writing</a></code></p>
</li>
<li>
<p><code><a href="#CIHJADHF">jdbc.batch-writing.size</a></code></p>
</li>
<li>
<p><code><a href="#CHDHAFAA">jdbc.cache-statements</a></code></p>
</li>
<li>
<p><code><a href="#CACBICGG">jdbc.cache-statements.size</a></code></p>
</li>
<li>
<p><code><a href="#CFAJHIJA">jdbc.connector</a></code></p>
</li>
<li>
<p><code><a href="#CHDCJIBF">jdbc.exclusive-connection.is-lazy</a></code></p>
</li>
<li>
<p><code><a href="#CACBICGG2">jdbc.exclusive-connection.mode</a></code></p>
</li>
<li>
<p><code><a href="#CIHEACBE">jdbc.native-sql</a></code></p>
</li>
<li>
<p><code><a href="#CIHHJHHD">jdbc.property</a></code></p>
</li>
<li>
<p><code><a href="#CIHBHCID">jdbc.sql-cast</a></code></p>
</li>
<li>
<p><code><a href="#CIHIIAFD">jdbc.uppercase-columns</a></code></p>
</li>
<li>
<p><code><a href="#CHDJGCBD">jpa.uppercase-column-names</a></code></p>
</li>
<li>
<p><code><a href="#CHDFJAAC">jpql.parser</a></code></p>
</li>
<li>
<p><code><a href="#BCFGFEFB3">jpql.validation</a></code></p>
</li>
<li>
<p><code><a href="#CHDJCBIF">logging.connection</a></code></p>
</li>
<li>
<p><code><a href="#BEIFJBIE">logging.exceptions</a></code></p>
</li>
<li>
<p><code><a href="#BEIHGBBC">logging.file</a></code></p>
</li>
<li>
<p><code><a href="#CHDGFDDH">logging.level</a></code></p>
</li>
<li>
<p><code><a href="#BEIHGGHH">logging.session</a></code></p>
</li>
<li>
<p><code><a href="#BEIFFGGB">logging.thread</a></code></p>
</li>
<li>
<p><code><a href="#BEIJCEBJ">logging.timestamp</a></code></p>
</li>
<li>
<p><code><a href="#CHDJDEDE">metadata-source</a></code></p>
</li>
<li>
<p><code><a href="#CHDEFFGG2">metadata-source.properties.file</a></code></p>
</li>
<li>
<p><code><a href="#CHDICFHG">metadata-source.send-refresh-command</a></code></p>
</li>
<li>
<p><code><a href="#CHDBFJEB">metadata-source.xml.url</a></code></p>
</li>
<li>
<p><code><a href="#BGBEDEJC">nosql.connection-factory</a></code></p>
</li>
<li>
<p><code><a href="#BCGEBECD">nosql.connection-spec</a></code></p>
</li>
<li>
<p><code><a href="#BABJAJAI">nosql.property</a></code></p>
</li>
<li>
<p><code><a href="#CDEFJEGI">oracle.proxy-type</a></code></p>
</li>
<li>
<p><code><a href="#orm.throw.exceptions">orm.throw.exceptions</a></code></p>
</li>
<li>
<p><code><a href="#CHDIFJDB">orm.validate.schema</a></code></p>
</li>
<li>
<p><code><a href="#partitioning">partitioning</a></code></p>
</li>
<li>
<p><code><a href="#BJFEFCFC">partitioning.callback</a></code></p>
</li>
<li>
<p><code><a href="#BABDGGHE">persistence-context.close-on-commit</a></code></p>
</li>
<li>
<p><code><a href="#BABCHJJA">persistence-context.commit-without-persist-rules</a></code></p>
</li>
<li>
<p><code><a href="#BABDHEEB">persistence-context.flush-mode</a></code></p>
</li>
<li>
<p><code><a href="#BABGCAGC">persistence-context.persist-on-commit</a></code></p>
</li>
<li>
<p><code><a href="#BABIAJAI">persistence-context.reference-mode</a></code></p>
</li>
<li>
<p><code><a href="#persistenceunits">persistenceunits</a></code></p>
</li>
<li>
<p><code><a href="#persistencexml">persistencexml</a></code></p>
</li>
<li>
<p><code><a href="#CHDEGCBC">persisencexml.default</a></code></p>
</li>
<li>
<p><code><a href="#profiler">profiler</a></code></p>
</li>
<li>
<p><code><a href="#session.customizer">session.customizer</a></code></p>
</li>
<li>
<p><code><a href="#CHDFDJJD">session.include.descriptor.queries</a></code></p>
</li>
<li>
<p><code><a href="#session-event-listener">session-event-listener</a></code></p>
</li>
<li>
<p><code><a href="#CHDFHEAC">session-name</a></code></p>
</li>
<li>
<p><code><a href="#sessions-xml">sessions-xml</a></code></p>
</li>
<li>
<p><code><a href="#target-database">target-database</a></code></p>
</li>
<li>
<p><code><a href="#target-server">target-server</a></code></p>
</li>
<li>
<p><code><a href="#CHDHJBEE">temporal.mutable</a></code></p>
</li>
<li>
<p><code><a href="#CHDHBGIE">tenant-id</a></code></p>
</li>
<li>
<p><code><a href="#CIHEAICB">transaction.join-existing</a></code></p>
</li>
<li>
<p><code><a href="#CHDGFIGB">tuning</a></code></p>
</li>
<li>
<p><code><a href="#validate-existence">validate-existence</a></code></p>
</li>
<li>
<p><code><a href="#validation-only">validation-only</a></code></p>
</li>
<li>
<p><code><a href="#weaving">weaving</a></code></p>
</li>
<li>
<p><code><a href="#CHDCEEFC">weaving.changetracking</a></code></p>
</li>
<li>
<p><code><a href="#BABGGCGC">weaving.eager</a></code></p>
</li>
<li>
<p><code><a href="#CHDDIFGE">weaving.fetchgroups</a></code></p>
</li>
<li>
<p><code><a href="#BABJICDJ">weaving.internal</a></code></p>
</li>
<li>
<p><code><a href="#BABDBIFE">weaving.lazy</a></code></p>
</li>
</ul>
</div>
<!-- class="sect1" -->
<a id="CACHGDEJ" name="CACHGDEJ"></a><a id="TLJPA1060" name="TLJPA1060"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">application-location</font></h2>
<p>Use the <code>eclipselink.application-location</code> property to specify the file system directory in which EclipseLink writes (outputs) DDL files.</p>
<a id="sthref735" name="sthref735"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACBIDFB">Table 5-1</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1061" name="TLJPA1061"></a><a id="sthref736" name="sthref736"></a><a id="CACBIDFB" name="CACBIDFB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-1 Valid Values for application-location</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for application-location" summary="This table describes the valid values for the application-location persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t2"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t2"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t2" headers="r1c1-t2">
<p>value</p>
</td>
<td align="left" headers="r2c1-t2 r1c2-t2">
<p>Directory location. The path must be fully qualified. For Windows, use a backslash. For UNIX use a slash.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref737" name="sthref737"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You may set this option only if the value of <code>eclipselink.<a href="#BABCDHBB">ddl-generation.output-mode</a></code> is <code>sql-script</code> or <code>both</code>.</p>
<a id="sthref738" name="sthref738"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CACGJACG">Example 5-1</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CACGJACG" name="CACGJACG"></a><a id="TLJPA830" name="TLJPA830"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-1 Using application-location in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.application-location" value="c:/YOURDIRECTORY/"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDDIGII">Example 5-2</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDDIGII" name="CHDDIGII"></a><a id="TLJPA54155" name="TLJPA54155"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-2 Using application-location in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.APPLICATION_LOCATION,
"c:/YOURDIRECTORY/");
</pre></div>
<!-- class="example" -->
<a id="sthref739" name="sthref739"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BABCDHBB">"ddl-generation.output-mode"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABGBAEC" name="BABGBAEC"></a><a id="TLJPA1062" name="TLJPA1062"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.channel</font></h2>
<p>Use the <code>eclipselink.cache.coordination.channel</code> property to configure cache coordination for a clustered environment.</p>
<a id="sthref740" name="sthref740"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABDCBBB">Table 5-2</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1063" name="TLJPA1063"></a><a id="sthref741" name="sthref741"></a><a id="BABDCBBB" name="BABDCBBB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-2 Valid Values for cache.coordination.channel</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.channel" summary="This table describes the valid values for the cache.coordination.channel persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t3"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t3"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t3" headers="r1c1-t3">
<p>channel name</p>
</td>
<td align="left" headers="r2c1-t3 r1c2-t3">
<p>The channel used for cache coordination. All persistence units using the same channel will be coordinated.</p>
<p>Default: <code>EclipseLinkCommandChannel</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref742" name="sthref742"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>If multiple EclipseLink deployments reside on the same network, they should be in different channels.</p>
<a id="sthref743" name="sthref743"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABBJEBD">Example 5-3</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABBJEBD" name="BABBJEBD"></a><a id="TLJPA831" name="TLJPA831"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-3 Using application-location in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.channel" value="EmployeeChannel" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDDBGHI">Example 5-4</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDDBGHI" name="CHDDBGHI"></a><a id="TLJPA54156" name="TLJPA54156"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-4 Using cache.coordination.channel in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.CACHE_COORDINATION_CHANNEL,
"myChannel");
</pre></div>
<!-- class="example" -->
<a id="sthref744" name="sthref744"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#CHDBBIHE">"@Cache"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABJGCIF" name="BABJGCIF"></a><a id="TLJPA54086" name="TLJPA54086"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jms.factory</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jms.factory</code> property to configure the JMS topic connection factory name, when using JMS coordination for a clustered environment.</p>
<a id="sthref745" name="sthref745"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACBGAJC">Table 5-3</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA54087" name="TLJPA54087"></a><a id="sthref746" name="sthref746"></a><a id="CACBGAJC" name="CACBGAJC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-3 Valid Values for cache.coordination.jms.factory</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jms.factory" summary="This table describes the valid values for the cache.coordination.jms.factory persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t4"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t4"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t4" headers="r1c1-t4">
<p>name</p>
</td>
<td align="left" headers="r2c1-t4 r1c2-t4">
<p>The JMS topic connection factory name.</p>
<p>Default: <code>jms/EclipseLinkTopicConnectionFactory</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref747" name="sthref747"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for JMS coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>jms</code>).</p>
<a id="sthref748" name="sthref748"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABHGIFC">Example 5-13</a> for information on how to use this property.</p>
<a id="sthref749" name="sthref749"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABJGJGI" name="BABJGJGI"></a><a id="TLJPA1066" name="TLJPA1066"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jms.host</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jms.host</code> property to configure the URL of the JMS server that hosts the topic, when using JMS coordination for a clustered environment.</p>
<a id="sthref750" name="sthref750"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABHHADG">Table 5-4</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1067" name="TLJPA1067"></a><a id="sthref751" name="sthref751"></a><a id="BABHHADG" name="BABHHADG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-4 Valid Values for cache.coordination.jms.host</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jms.host" summary="This table describes the valid values for the cache.coordination.jms.host persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t5"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t5"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t5" headers="r1c1-t5">
<p>url</p>
</td>
<td align="left" headers="r2c1-t5 r1c2-t5">
<p>The fully-qualified URL for the JMS server.</p>
<p>This is not required if the topic is distributed across the cluster (that is, it can be looked up in local JNDI).</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref752" name="sthref752"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for JMS coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>jms</code>). You must use a fully qualified URL.</p>
<a id="sthref753" name="sthref753"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABHGIFC">Example 5-13</a> for information on how to use this property.</p>
<a id="sthref754" name="sthref754"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDHJECA" name="CHDHJECA"></a><a id="TLJPA54088" name="TLJPA54088"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jms.reuse-topic-publisher</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jms.reuse-topic-publisher</code> property to specify if the JSM transport manager should cache a <code>TopicPubliser</code> and reuse it for all cache coordination publishing.</p>
<a id="sthref755" name="sthref755"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACFGJBJ">Table 5-5</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA54089" name="TLJPA54089"></a><a id="sthref756" name="sthref756"></a><a id="CACFGJBJ" name="CACFGJBJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-5 Valid Values for cache.coordination.jms.reuse-topic-publisher</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jms.reuse-topic-publisher" summary="This table describes the valid values for the cache.coordination.jms.reuse-topic-publisher persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t6"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t6"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t6" headers="r1c1-t6">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t6 r1c2-t6">
<p>Caches the topic publisher.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t6" headers="r1c1-t6">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t6 r1c2-t6">
<p>(Default) Does not cache the topic publisher.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref757" name="sthref757"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for JMS coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>jms</code>).</p>
<a id="sthref758" name="sthref758"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABHGIFC">Example 5-13</a> for information on how to use this property.</p>
<a id="sthref759" name="sthref759"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABHEFCJ" name="BABHEFCJ"></a><a id="TLJPA834" name="TLJPA834"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jms.topic</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jms.topic</code> property to set the JMS topic name, when using JMS coordination for a clustered environment.</p>
<a id="sthref760" name="sthref760"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABFEBJD">Table 5-6</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA835" name="TLJPA835"></a><a id="sthref761" name="sthref761"></a><a id="BABFEBJD" name="BABFEBJD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-6 Valid Values for cache.coordination.jms.topic</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jms.topic" summary="This table describes the valid values for the cache.coordination.jms.topic persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t7"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t7"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t7" headers="r1c1-t7">
<p>name</p>
</td>
<td align="left" headers="r2c1-t7 r1c2-t7">
<p>Set the JMS topic name.</p>
<p>Default: <code>jms/EclipseLinkTopic</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref762" name="sthref762"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for JMS coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>jms</code>).</p>
<a id="sthref763" name="sthref763"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABHGIFC">Example 5-13</a> for information on how to use this property.</p>
<a id="sthref764" name="sthref764"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABFBHGI" name="BABFBHGI"></a><a id="TLJPA54090" name="TLJPA54090"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jndi.initial-context-factory</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jndi.initial-context-factory</code> property to set the JNDI <code>InitialContext</code> factory, when using cache coordination for a clustered environment.</p>
<a id="sthref765" name="sthref765"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACBDFGG">Table 5-7</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA54091" name="TLJPA54091"></a><a id="sthref766" name="sthref766"></a><a id="CACBDFGG" name="CACBDFGG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-7 Valid Values for cache.coordination.jndi.initial-context-factory</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jndi.initial-context-factory" summary="This table describes the valid values for the cache.coordination.jndi.initial-context-factory persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t8"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t8"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t8" headers="r1c1-t8">
<p>name</p>
</td>
<td align="left" headers="r2c1-t8 r1c2-t8">
<p>Name of the JNDI <code>InitialContext</code> factory.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref767" name="sthref767"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Normally, you will not need this property when connecting to the local server.</p>
<a id="sthref768" name="sthref768"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBIAHF">Example 5-5</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBIAHF" name="CHDBIAHF"></a><a id="TLJPA54138" name="TLJPA54138"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-5 Using cache.coordination.jndi.initial-context-factory in persistence.xml.</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.jndi.initial-context-factory"
value="weblogic.jndi.WLInitialContextFactory/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGJAGI">Example 5-6</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDGJAGI" name="CHDGJAGI"></a><a id="TLJPA54157" name="TLJPA54157"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-6 Using cache.coordination.jndi.initial-context-factory in a property map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put
(PersistenceUnitProperties.CACEH_COORDINATION_JNDI_INITIAL_CONTEXT_FACTORY,
"weblogic.jndi.WLInitialContextFactory");
</pre></div>
<!-- class="example" -->
<a id="sthref769" name="sthref769"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABJBCCF" name="BABJBCCF"></a><a id="TLJPA838" name="TLJPA838"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jndi.password</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jndi.password</code> property to set the password for the <code><a href="#BABGAEHE">cache.coordination.jndi.user</a></code>, when using cache coordination for a clustered environment.</p>
<a id="sthref770" name="sthref770"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABCDCAB">Table 5-8</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA839" name="TLJPA839"></a><a id="sthref771" name="sthref771"></a><a id="BABCDCAB" name="BABCDCAB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-8 Valid Values for cache.coordination.jndi.password</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jndi.password" summary="This table describes the valid values for the cache.coordination.jndi.password persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t9"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t9"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t9" headers="r1c1-t9">
<p>value</p>
</td>
<td align="left" headers="r2c1-t9 r1c2-t9">
<p>Password for the <a href="#BABGAEHE">cache.coordination.jndi.user</a>.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref772" name="sthref772"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Normally, you will not need this property when connecting to the local server.</p>
<a id="sthref773" name="sthref773"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABEDFDG">Example 5-7</a> shows how to use this propery in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABEDFDG" name="BABEDFDG"></a><a id="TLJPA840" name="TLJPA840"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-7 Using cache.coordination.jndi.password in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.jndi.user" value="USERNAME"/&gt;
&lt;property name="eclipselink.cache.coordination.jndi.password" value="PASSWORD"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDDGDHG">Example 5-8</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDDGDHG" name="CHDDGDHG"></a><a id="TLJPA54158" name="TLJPA54158"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-8 Using cache.coordination.jndi.password in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.CACHE_COORDINATION_JNDI_USER,
"USERNAME");
propertyMap.put(PersistenceUnitProperties.CACHE_COORDINATION_JNDI_PASSWORD,
"PASSWORD");
</pre></div>
<!-- class="example" -->
<a id="sthref774" name="sthref774"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BABGAEHE">"cache.coordination.jndi.user"</a></p>
</li>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABGAEHE" name="BABGAEHE"></a><a id="TLJPA841" name="TLJPA841"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.jndi.user</font></h2>
<p>Use the <code>eclipselink.cache.coordination.jndi.user</code> property to set JNDI naming service user, when using cache coordination for a clustered environment.</p>
<a id="sthref775" name="sthref775"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABJECGE">Table 5-9</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA842" name="TLJPA842"></a><a id="sthref776" name="sthref776"></a><a id="BABJECGE" name="BABJECGE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-9 Valid Values for cache.coordination.jndi.user</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.jndi.user" summary="This table describes the valid values for the cache.coordination.jndi.user persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t10"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t10"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t10" headers="r1c1-t10">
<p>value</p>
</td>
<td align="left" headers="r2c1-t10 r1c2-t10">
<p>The JNDI user.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref777" name="sthref777"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Normally, you will not need this property when connecting to the local server.</p>
<a id="sthref778" name="sthref778"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABHGIFC">Example 5-13</a> for information on how to use this property.</p>
<a id="sthref779" name="sthref779"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BABJBCCF">"cache.coordination.jndi.password"</a></p>
</li>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABIEEBH" name="BABIEEBH"></a><a id="TLJPA843" name="TLJPA843"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.naming-service</font></h2>
<p>Use the <code>eclipselink.cache.coordination.naming-service</code> property to specify the naming service to use, when using cache coordination for a clustered environment.</p>
<a id="sthref780" name="sthref780"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABEFFAF">Table 5-10</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA844" name="TLJPA844"></a><a id="sthref781" name="sthref781"></a><a id="BABEFFAF" name="BABEFFAF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-10 Valid Values for cache.coordination.naming-service</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.naming-service" summary="This table describes the valid values for the cache.coordination.naming-service persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t11"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t11"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t11" headers="r1c1-t11">
<p><code>jndi</code></p>
</td>
<td align="left" headers="r2c1-t11 r1c2-t11">
<p>Uses JNDI.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t11" headers="r1c1-t11">
<p><code>rmi</code></p>
</td>
<td align="left" headers="r3c1-t11 r1c2-t11">
<p>Configures RMI.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref782" name="sthref782"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Cache coordination must be enabled.</p>
<a id="sthref783" name="sthref783"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABGAFBA">Example 5-9</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABGAFBA" name="BABGAFBA"></a><a id="TLJPA845" name="TLJPA845"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-9 Using cache.coordination.naming-service in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination" value="true"/&gt;
&lt;property name="eclipselink.cache.coordination.naming-service" value="jndi"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGAICF">Example 5-10</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDGAICF" name="CHDGAICF"></a><a id="TLJPA54159" name="TLJPA54159"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-10 Using cache.coordination.naming-service in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.CACHE_COORDINATION_NAMING_SERVICE,
"jndi");
</pre></div>
<!-- class="example" -->
<a id="sthref784" name="sthref784"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABDFGGD" name="BABDFGGD"></a><a id="TLJPA846" name="TLJPA846"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.propagate-asynchronously</font></h2>
<p>Use the <code>eclipselink.cache.coordination.propagate-asynchronously</code> property to specify if the coordination broadcast should occur asynchronously with the committing thread.</p>
<p>The property configures cache coordination for a clustered environment. Set if the coordination broadcast should occur asynchronously with the committing thread. This means the coordination will be complete before the thread returns from the commit of the transaction.</p>
<a id="sthref785" name="sthref785"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABBGGGD">Table 5-11</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA847" name="TLJPA847"></a><a id="sthref786" name="sthref786"></a><a id="BABBGGGD" name="BABBGGGD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-11 Valid Values for cache.coordination.propagate-asynchronously</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.propagate-asynchronously" summary="This table describes the valid values for the cache.coordination.propagate-asynchronously persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t12"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t12"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t12" headers="r1c1-t12">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t12 r1c2-t12">
<p>(Default) EclipseLink will broadcast asynchronously. The coordination will be complete before the thread returns from the committing the transaction.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t12" headers="r1c1-t12">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t12 r1c2-t12">
<p>EclipseLink will broadcast synchronously.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref787" name="sthref787"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>JMS cache coordination is always asynchronous, regardless of this setting.</p>
<p>By default, RMI cache coordination is asynchronous. Use synchronous (<code>eclipselink.cache.coordination.propagate-asynchronously</code> = <code>false</code>) to ensure that all servers are updated before the request returns.</p>
<a id="sthref788" name="sthref788"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABCBHJG">Example 5-11</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABCBHJG" name="BABCBHJG"></a><a id="TLJPA848" name="TLJPA848"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-11 Using cache.coordination.propagate-asynchronously in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.propagate-asynchronously"
value="false" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDCDGIC">Example 5-12</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDCDGIC" name="CHDCDGIC"></a><a id="TLJPA54160" name="TLJPA54160"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-12 Using cache.coordination.propagate-asynchronously in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put
(PersistenceUnitProperties.CACHE_COORDINATION_PROPAGATE_ASYNCHRONOUSLY,
"false");
</pre></div>
<!-- class="example" -->
<a id="sthref789" name="sthref789"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="cachecoordinationprotocol" name="cachecoordinationprotocol"></a><a id="TLJPA1068" name="TLJPA1068"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.protocol</font></h2>
<p>Use the <code>eclipselink.cache.coordination.protocol</code> property to specify the cache coordination protocol to use. Depending on the cache configuration for each descriptor, this will broadcast cache updates or inserts to the cluster to update or invalidate each session's cache.</p>
<a id="sthref790" name="sthref790"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABCEGFF">Table 5-12</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA849" name="TLJPA849"></a><a id="sthref791" name="sthref791"></a><a id="BABCEGFF" name="BABCEGFF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-12 Valid Values for cache.coordination.protocol</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.protocol" summary="This table describes the valid values for the cache.coordination.protocol persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t13"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t13"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t13" headers="r1c1-t13">
<p><code>jms</code></p>
</td>
<td align="left" headers="r2c1-t13 r1c2-t13">
<p>Use Java Message Service (JMS) to broadcast changes.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t13" headers="r1c1-t13">
<p><code>jms-publishing</code></p>
</td>
<td align="left" headers="r3c1-t13 r1c2-t13">
<p>Use an EJB MessageDrivenBean to be used to broadcast changes. You must configure the MessageDrivenBean separately.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t13" headers="r1c1-t13">
<p><code>rmi</code></p>
</td>
<td align="left" headers="r4c1-t13 r1c2-t13">
<p>Use Java Remote Method Invocation (RMI) to broadcast changes.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t13" headers="r1c1-t13">
<p><code>rmi-iiop</code></p>
</td>
<td align="left" headers="r5c1-t13 r1c2-t13">
<p>Use RMI over the Internet Inter-Orb Protocol (IIOP) to broadcast changes.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t13" headers="r1c1-t13">
<p>ClassName</p>
</td>
<td align="left" headers="r6c1-t13 r1c2-t13">
<p>The name of a subclass implementation of the <code>TransportManager</code> abstract class</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref792" name="sthref792"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You must specify the <code>cache.coordination.protocol</code> for every persistence unit and session in the cluster.</p>
<a id="sthref793" name="sthref793"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABHGIFC">Example 5-13</a> shows how configure JMS cache coordination in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABHGIFC" name="BABHGIFC"></a><a id="TLJPA850" name="TLJPA850"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-13 Configuring JMS Cache Coordination in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.protocol" value="jms" /&gt;
&lt;property name="eclipselink.cache.coordination.jms.topic"
value="jms/EmployeeTopic" /&gt;
&lt;property name="eclipselink.cache.coordination.jms.factory"
value="jms/EmployeeTopicConnectionFactory" /&gt;
</pre>
<p>If your application <em>is not</em> running in a cluster, you must provide the URL:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.jms.host"
value="t3://myserver:7001/" /&gt;
</pre>
<p>You can also include a username and password, if required, to access the server (for example, if on a separate domain):</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.jndi.user" value="weblogic" /&gt;
&lt;property name="eclipselink.cache.coordination.jndi.password" value="welcome1" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABJDAIB">Example 5-14</a> shows how to configure RMI cache coordination in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABJDAIB" name="BABJDAIB"></a><a id="TLJPA851" name="TLJPA851"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-14 Configuring RMI Cache Coordination in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.protocol" value="rmi" /&gt;
</pre>
<p>If your application <em>is not</em> running in a cluster, you must provide the URL:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.rmi.url"
value="t3://myserver:7001/" /&gt;
</pre>
<p>You can also include a username and password, if required, to access the server (for example, if on a separate domain):</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.jndi.user" value="weblogic" /&gt;
&lt;property name="eclipselink.cache.coordination.jndi.password" value="welcome1" /&gt;
</pre>
<p>By default, RMI cache coordination broadcasts are asynchronous. You can override this, if needed:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.propagate-asynchronously"
value="false" /&gt;
</pre>
<p>If you have multiple applications on the same server or network, you can specify a separate cache coordination channel for each application:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.channel" value="EmployeeChannel" /&gt;
</pre>
<p>RMI cache coordination uses a multicast socket to allow servers to find each other. You can configure the multicast settings, if needed:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.rmi.announcement-delay"
value="1000" /&gt;
&lt;property name="eclipselink.cache.coordination.rmi.multicast-group"
value="239.192.0.0" /&gt;
&lt;property name="eclipselink.cache.coordination.rmi.multicast-group.port"
value="3121" /&gt;
&lt;property name="eclipselink.cache.coordination.packet-time-to-live" value="2" /&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref794" name="sthref794"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BABGBAEC">"cache.coordination.channel"</a></p>
</li>
<li>
<p><a href="#BABJGCIF">"cache.coordination.jms.factory"</a></p>
</li>
<li>
<p><a href="#BABJGJGI">"cache.coordination.jms.host"</a></p>
</li>
<li>
<p><a href="#CHDHJECA">cache.coordination.jms.reuse-topic-publisher</a><a href="#CHDHJECA">"cache.coordination.jms.reuse-topic-publisher"</a></p>
</li>
<li>
<p><a href="#BABHEFCJ">"cache.coordination.jms.topic"</a></p>
</li>
<li>
<p><a href="#BABFBHGI">"cache.coordination.jndi.initial-context-factory"</a></p>
</li>
<li>
<p><a href="#BABJBCCF">"cache.coordination.jndi.password"</a></p>
</li>
<li>
<p><a href="#BABGAEHE">"cache.coordination.jndi.user"</a></p>
</li>
<li>
<p><a href="#BABIEEBH">"cache.coordination.naming-service"</a></p>
</li>
<li>
<p><a href="#BABDFGGD">"cache.coordination.propagate-asynchronously"</a></p>
</li>
<li>
<p><a href="#BABIEJED">"cache.coordination.remove-connection-on-error"</a></p>
</li>
<li>
<p><a href="#BABDGCDE">"cache.coordination.rmi.announcement-delay"</a></p>
</li>
<li>
<p><a href="#BABDGFEI">"cache.coordination.rmi.multicast-group"</a></p>
</li>
<li>
<p><a href="#BABDGFEI">"cache.coordination.rmi.multicast-group"</a></p>
</li>
<li>
<p><a href="#BABFBDBJ">"cache.coordination.rmi.packet-time-to-live"</a></p>
</li>
<li>
<p><a href="#BABCJIFC">"cache.coordination.rmi.url"</a></p>
</li>
<li>
<p><a href="#BABFJGIF">"cache.coordination.thread.pool.size"</a></p>
</li>
<li>
<p>Cache Coordination Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/CacheCoordination">http://wiki.eclipse.org/EclipseLink/Examples/JPA/CacheCoordination</a></code></p>
</li>
<li>
<p>"Clustering and Cache Coordination" <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABIEJED" name="BABIEJED"></a><a id="TLJPA852" name="TLJPA852"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.remove-connection-on-error</font></h2>
<p>Use the <code>eclipselink.cache.coordination.remove-connection-on-error</code> property to specify if the connection should be removed if EclipseLink encounters a communication error when coordinating the cache.</p>
<a id="sthref795" name="sthref795"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CJHBHDJH">Table 5-13</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA853" name="TLJPA853"></a><a id="sthref796" name="sthref796"></a><a id="CJHBHDJH" name="CJHBHDJH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-13 Valid Values for cache.coordination.remove-connection-on-error</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.remove-connection-on-error" summary="This table describes the valid values for the cache.coordination.remove-connection-on-error persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t14"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t14"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t14" headers="r1c1-t14">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t14 r1c2-t14">
<p>Removes the connection if a communication error occurs. EclipseLink will reconnect when the server becomes available.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t14" headers="r1c1-t14">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t14 r1c2-t14">
<p>(Default) Does not remove the connection if a communication error occurs.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref797" name="sthref797"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Normally, this is used for RMI connections in the event that a server goes down.</p>
<a id="sthref798" name="sthref798"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABGBHBE">Example 5-15</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABGBHBE" name="BABGBHBE"></a><a id="TLJPA854" name="TLJPA854"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-15 Using cache.coordination.remove-connection-on-error in peristence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.remove-connection-on-error"
value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDDAIAI">Example 5-16</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDDAIAI" name="CHDDAIAI"></a><a id="TLJPA54161" name="TLJPA54161"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-16 Using cache.coordination.remove-connection-on_error in a property map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put
(PersistenceUnitProperties.CACHE_COORDINATION_REMOVE_CONNECTION_ON_ERROR,"true");
</pre></div>
<!-- class="example" -->
<a id="sthref799" name="sthref799"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABDGCDE" name="BABDGCDE"></a><a id="TLJPA855" name="TLJPA855"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.rmi.announcement-delay</font></h2>
<p>Use the <code>eclipselink.cache.coordination.rmi.announcement-delay</code> property to set the time (in milliseconds) to wait for announcements from other cluster members on startup.</p>
<a id="sthref800" name="sthref800"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABCEDJF">Table 5-14</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA856" name="TLJPA856"></a><a id="sthref801" name="sthref801"></a><a id="BABCEDJF" name="BABCEDJF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-14 Valid Values for cache.coordination.rmi.announcement-delay</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.rmi.announcement-delay" summary="This table describes the valid values for the cache.coordination.rmi.annoucement-delay query hint." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t15"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t15"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t15" headers="r1c1-t15">
<p>Numeric</p>
</td>
<td align="left" headers="r2c1-t15 r1c2-t15">
<p>Time (in milliseconds) to wait for announcements, on startup.</p>
<p>Default: <strong>1000</strong></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref802" name="sthref802"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for RMI coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>rmi</code>).</p>
<a id="sthref803" name="sthref803"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABJDAIB">Example 5-14</a> for information on how to use this property.</p>
<a id="sthref804" name="sthref804"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABDGFEI" name="BABDGFEI"></a><a id="TLJPA857" name="TLJPA857"></a>
<hr />
<div class="refsect1"><!-- infolabel="BABDGFEI" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.rmi.multicast-group</font></h2>
<p>Use the <code>eclipselink.cache.coordination.rmi.multicast-group</code> property to set the multicast socket group address (used to find other members of the cluster), when using cache coordination for a clustered environment.</p>
<a id="sthref805" name="sthref805"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABDIBJH">Table 5-15</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA858" name="TLJPA858"></a><a id="sthref806" name="sthref806"></a><a id="BABDIBJH" name="BABDIBJH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-15 Valid Values for cache.coordination.rmi.multicast-group</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.rmi.multicast-group" summary="This table describes the valid values for the cache.coordination.rmi.multicast-group persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t16"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t16"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t16" headers="r1c1-t16">
<p>Numeric</p>
</td>
<td align="left" headers="r2c1-t16 r1c2-t16">
<p>Set the multicast socket group address</p>
<p>Default: <code>239.192.0.0</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref807" name="sthref807"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for RMI coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>rmi</code>).</p>
<a id="sthref808" name="sthref808"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABJDAIB">Example 5-14</a> for information on how to use this property.</p>
<a id="sthref809" name="sthref809"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="TLJPA54092" name="TLJPA54092"></a>
<hr />
<div class="refsect1"><a id="sthref810" name="sthref810"></a>
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.rmi.multicast-group.port</font></h2>
<p>Use the <code>eclipselink.cache.coordination.rmi.multicast-group.port</code> property to set the multicast socket group port (used to find other members of the cluster), when using cache coordination for a clustered environment.</p>
<a id="sthref811" name="sthref811"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACFAGIE">Table 5-16</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA54093" name="TLJPA54093"></a><a id="sthref812" name="sthref812"></a><a id="CACFAGIE" name="CACFAGIE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-16 Valid Values for cache.coordination.rmi.multicast-group.port</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.rmi.multicast-group.port" summary="This table describes the valid values for the cache.coordination.rmi.multicast-group.port persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t17"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t17"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t17" headers="r1c1-t17">
<p>Numeric</p>
</td>
<td align="left" headers="r2c1-t17 r1c2-t17">
<p>Set the multicast socket group port.</p>
<p>Default: <code>3121</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref813" name="sthref813"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for RMI coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>rmi</code>).</p>
<a id="sthref814" name="sthref814"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABJDAIB">Example 5-14</a> for information on how to use this property.</p>
<a id="sthref815" name="sthref815"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABFBDBJ" name="BABFBDBJ"></a><a id="TLJPA861" name="TLJPA861"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.rmi.packet-time-to-live</font></h2>
<p>Use the <code>eclipselink.cache.coordination.rmi.packet-time-to-live</code> property to set the number of hops the session announcement data packets will take before expiring. The multicast group is used to find other members of the cluster.</p>
<a id="sthref816" name="sthref816"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABHDDBG">Table 5-17</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA862" name="TLJPA862"></a><a id="sthref817" name="sthref817"></a><a id="BABHDDBG" name="BABHDDBG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-17 Valid Values for cache.coordination.rmi.packet-time-to-live</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.rmi.packet-time-to-live" summary="This table describes the valid values for the cache.coordination.rmi.packet-time-to-live persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="17%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t18"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t18"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t18" headers="r1c1-t18">
<p>Numeric</p>
</td>
<td align="left" headers="r2c1-t18 r1c2-t18">
<p>Number of hops the session announcement data packets will take before expiring.</p>
<p>Default: <code>2</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref818" name="sthref818"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>If sessions are hosted on different LANs that are part of WAN, the announcement sent by one session may not reach other sessions. In this case, consult your network administrator for the correct time-to-live value or test your network by increasing the value until each session receives announcement sent by others.</p>
<p>Use this property for RMI coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>rmi</code>).</p>
<a id="sthref819" name="sthref819"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABJDAIB">Example 5-14</a> for information on how to use this property.</p>
<a id="sthref820" name="sthref820"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABCJIFC" name="BABCJIFC"></a><a id="TLJPA863" name="TLJPA863"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.rmi.url</font></h2>
<p>Use the <code>eclipselink.cache.coordination.rmi.url</code> property to set the URL of the host server. This is the URL that other cluster member use to connect to this host.</p>
<a id="sthref821" name="sthref821"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABHIFGF">Table 5-18</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA864" name="TLJPA864"></a><a id="sthref822" name="sthref822"></a><a id="BABHIFGF" name="BABHIFGF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-18 Valid Values for cache.coordination.rmi.url</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.rmi.url" summary="This table describes the valid values for the cache.coordination.rmi.url persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t19"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t19"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t19" headers="r1c1-t19">
<p>url</p>
</td>
<td align="left" headers="r2c1-t19 r1c2-t19">
<p>URL of the host server</p>
<p>Default: <code>local</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref823" name="sthref823"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property for RMI coordination (when <code>eclipselink.<a href="#cachecoordinationprotocol">cache.coordination.protocol</a></code> = <code>rmi</code>).</p>
<p>This may not be required in a clustered environment where JNDI is replicated. You can also set the location as a System property or using a <code>SessionCustomizer</code> to avoid requiring a separate <code>persistence.xml</code> file per server.</p>
<a id="sthref824" name="sthref824"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABJDAIB">Example 5-14</a> for information on how to use this property.</p>
<a id="sthref825" name="sthref825"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABFJGIF" name="BABFJGIF"></a><a id="TLJPA865" name="TLJPA865"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.coordination.thread.pool.size</font></h2>
<p>Use the <code>eclipselink.cache.coordination.thread.pool.size</code> property to configure the size of the thread pool, for cache coordination threads.</p>
<a id="sthref826" name="sthref826"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABIHIHC">Table 5-19</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA866" name="TLJPA866"></a><a id="sthref827" name="sthref827"></a><a id="BABIHIHC" name="BABIHIHC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-19 Valid Values for cache.coordination.thread.pool.size</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.coordination.thread.pool.size" summary="This table describes the valid values for the cache.coordination.thread.pool.size persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t20"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t20"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t20" headers="r1c1-t20">
<p>Numeric</p>
</td>
<td align="left" headers="r2c1-t20 r1c2-t20">
<p>Size of the thread pool. If <code>0</code>, EclipseLink does not use a thread pool; instead threads are spawned when required.</p>
<p>Default: <code>32</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref828" name="sthref828"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>For RMI cache coordination, EclipseLink spawns one thread per node to send change notifications and one thread to listen for new node notifications.</p>
<p>For JMS cache coordination, EclipseLink spawns one thread to <em>receive</em> JMS change notification messages (unless MDB is used) and one thread to <em>process</em> the change notification (unless MDB is used).</p>
<a id="sthref829" name="sthref829"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDEFIEH">Example 5-17</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDEFIEH" name="CHDEFIEH"></a><a id="TLJPA54139" name="TLJPA54139"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-17 Using cache.coordination.thread.pool.size in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.cache.coordination.thread.pool.size"
value="48"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHEAHC">Example 5-18</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHEAHC" name="CHDHEAHC"></a><a id="TLJPA54162" name="TLJPA54162"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-18 Using cache.coordination.thread.pool.size in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.CACHE_COORDINATION_THREAD_POOL_SIZE,
"48");
</pre></div>
<!-- class="example" -->
<a id="sthref830" name="sthref830"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#cachecoordinationprotocol">"cache.coordination.protocol"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CCHEEFGA" name="CCHEEFGA"></a><a id="TLJPA867" name="TLJPA867"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.database-event-listener</font></h2>
<p>Use the <code>eclipselink.cache.database-event-listener</code> property to integrate EclipseLink with a database event notification service, such as Oracle QCN/DCN (Query Change Notification/Database Change Notification).</p>
<a id="sthref831" name="sthref831"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CCHGIFIF">Table 5-20</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA868" name="TLJPA868"></a><a id="sthref832" name="sthref832"></a><a id="CCHGIFIF" name="CCHGIFIF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-20 Valid Values for cache.database-event-listener</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for cache.database-event-listener" summary="This table describes the valid values for the cache.databse-event-listener persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>Class</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>The name of a class that implements <code>DatabaseEventListener</code>, such as the <code>OracleChangeNotificationListener</code> (<code>org.eclipse.persistence.platform.database.oracle.dcn.OracleChangeNotificationListener</code>).</p>
<p>You can also use <strong>DCN</strong> and <strong>QCN</strong> for Oracle.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref833" name="sthref833"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use this property to allow the EclipseLink cache to be invalidated by database change events, triggers, or other services.</p>
<a id="sthref834" name="sthref834"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CCHGJFCG">Example 5-19</a> shows how to use this property with Oracle DCN.</p>
<div class="example"><a id="CCHGJFCG" name="CCHGJFCG"></a><a id="TLJPA869" name="TLJPA869"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-19 Using cache.database-event-listener in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;persistence xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
persistence_2_0.xsd"
version="2.0"&gt;
&lt;persistence-unit name="acme" transaction-type="RESOURCE_LOCAL"&gt;
&lt;provider&gt;org.eclipse.persistence.jpa.PersistenceProvider&lt;/provider&gt;
&lt;exclude-unlisted-classes&gt;false&lt;/exclude-unlisted-classes&gt;
&lt;properties&gt;
&lt;property name="<strong>eclipselink.cache.database-event-listener</strong>" value=
"org.eclipse.persistence.platform.database.oracle.dcn.OracleChangeNotificationList
ener"/&gt;
&lt;/properties&gt;
&lt;/persistence-unit&gt;
&lt;/persistence&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref835" name="sthref835"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#CHDBBIHE">"@Cache"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>"Database Change Notification" in <em>Oracle Fusion Middleware Configuring and Managing JDBC Data Sources for Oracle WebLogic Server</em></p>
</li>
<li>
<p>"Clustering and Cache Coordination" <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination</a></code></p>
</li>
<li>
<p>Cache Coordination Example <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/CacheCoordination">http://wiki.eclipse.org/EclipseLink/Examples/JPA/CacheCoordination</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDEJCJJ" name="CHDEJCJJ"></a><a id="TLJPA54116" name="TLJPA54116"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.shared</font></h2>
<p>Use the <code>eclipselink.cache.shared</code> property prefix to indicate whether an entity's cache is shared (non-isolated).</p>
<a id="sthref836" name="sthref836"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDGGEJH">Table 5-21</a> describes this persistence property prefix's values.</p>
<div class="tblformalwide"><a id="TLJPA54117" name="TLJPA54117"></a><a id="sthref837" name="sthref837"></a><a id="CHDGGEJH" name="CHDGGEJH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-21 Valid Values for cache.shared</font></em></strong></p>
<table class="FormalWide" title="Valid Values for cache.shared" summary="This table describes the valid values for the cache.shared persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="23%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t22"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t22"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t22" headers="r1c1-t22">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t22 r1c2-t22">
<p>(Default) Shares an entity's cache. The value is case insensitive.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t22" headers="r1c1-t22">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t22 r1c2-t22">
<p>Prevents sharing of an entity's cache. The value is case insensitive.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref838" name="sthref838"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Form a property name by appending either a valid entity name or class name to <code>class.shared</code>, indicating that the property values apply only to a particular entity. As an alternative, you can append the <code>default</code> suffix to the <code>cache.shared</code> property prefix to form a property name that sets the default for all entities.</p>
<a id="sthref839" name="sthref839"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="annotations_ref.htm#CACHFEFD">Example 2-12</a> for information on how to use this property.</p>
</div>
<!-- class="refsect1" -->
<a id="CHDIGIEC" name="CHDIGIEC"></a><a id="TLJPA54118" name="TLJPA54118"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.size</font></h2>
<p>Use the <code>eclipselink.cache.size</code> property prefix to specify the cache size for a specific entity type.</p>
<a id="sthref840" name="sthref840"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDFBBJC">Table 5-22</a> describes this persistence property prefix's values.</p>
<div class="tblformalwide"><a id="TLJPA54119" name="TLJPA54119"></a><a id="sthref841" name="sthref841"></a><a id="CHDFBBJC" name="CHDFBBJC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-22 Valid Values for cache.size</font></em></strong></p>
<table class="FormalWide" title="Valid Values for cache.size" summary="This table describes the valid values for the cache.size property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t23"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t23"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t23" headers="r1c1-t23">
<p>integer</p>
</td>
<td align="left" headers="r2c1-t23 r1c2-t23">
<p>The size of the cache. Default: 100 Bytes.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref842" name="sthref842"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Form a property name by appending either a valid entity name or class name to <code>cache.size</code>, indicating that the property values apply only to a particular entity. As an alternative, you can append the <code>default</code> suffix to the <code>cache.size</code> property prefix, indicating that the property value applies to all entities.</p>
<p>For most cache types, the size is only the initial size, not a fixed or maximum size. For <code>CacheType.SoftCache</code> and <code>CacheType.HardCache</code> types, the size is the sub-cache size. The default cache size is 100 Bytes.</p>
<a id="sthref843" name="sthref843"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="annotations_ref.htm#CACHFEFD">Example 2-12</a> for information on how to use this property.</p>
</div>
<!-- class="refsect1" -->
<a id="CHDGDIEI" name="CHDGDIEI"></a><a id="TLJPA54120" name="TLJPA54120"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">cache.type</font></h2>
<p>Use the <code>eclipselink.cache.type</code> property prefix to set the type of cache.</p>
<a id="sthref844" name="sthref844"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDDDIGB">Table 5-23</a> describes this persistence property prefix's values</p>
<div class="tblformalwide"><a id="TLJPA54121" name="TLJPA54121"></a><a id="sthref845" name="sthref845"></a><a id="CHDDDIGB" name="CHDDDIGB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-23 Valid values for cache.type</font></em></strong></p>
<table class="FormalWide" title="Valid values for cache.type" summary="This table describes the valid values for the cache.type persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t24"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t24"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t24" headers="r1c1-t24">
<p><code>Weak</code></p>
</td>
<td align="left" headers="r2c1-t24 r1c2-t24">
<p>Holds all objects in use by the application, and allows any unreferenced objects to be free for garbage collection. This cache type guarantees object identity and allows optimal garbage collection, but provides little caching benefit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t24" headers="r1c1-t24">
<p><code>Soft</code></p>
</td>
<td align="left" headers="r3c1-t24 r1c2-t24">
<p>Holds all objects read by the application, and allows any unreferenced objects to be free for garbage collection only when the JVM decides that memory is low. This cache type guarantees object identity, allows for garbage collection when memory is low, and provides optimal caching benefit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t24" headers="r1c1-t24">
<p><code>SoftWeak</code></p>
</td>
<td align="left" headers="r4c1-t24 r1c2-t24">
<p>(Default)Holds all objects read by the application, and a fixed-size subcache of MRU objects using <code>Soft</code> references.The <code>SoftWeak</code> cache allows any unreferenced objects not in the sub-cache to be free for garbage collection. The objects in the sub-cache are free to garbage collect only when the JVM decides that memory is low. This cache type guarantees object identity, allows configurable garbage collection, and provides configurable caching benefit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t24" headers="r1c1-t24">
<p><code>HardWeak</code></p>
</td>
<td align="left" headers="r5c1-t24 r1c2-t24">
<p>Holds all objects in use by the application, and a fixed-size subcache of MRU objects using normal <code>Hard</code> references. This type allows any unreferenced objects not in the subcache to be free for garbage collection, but not objects in the subcache. This cache type guarantees object identity, allows configurable garbage collection, and provides configurable caching benefit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t24" headers="r1c1-t24">
<p><code>Full</code></p>
</td>
<td align="left" headers="r6c1-t24 r1c2-t24">
<p>Holds all objects read by the application. This cache type does not allow garbage collection. This guarantees object identity, allows no garbage collection, and provides complete caching benefit.</p>
<p>WARNING: Use this cache type only for a fixed number of objects; otherwise, memory leakage will occur eventually.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t24" headers="r1c1-t24">
<p><code>NONE</code></p>
</td>
<td align="left" headers="r7c1-t24 r1c2-t24">
<p>Does not cache any objects, and frees any unreferenced objects for garbage collection. This provides no object identity, allows complete garbage collection, and provides no caching benefit.</p>
<p>WARNING: This cache type should normally not be used. Instead, disable the shared cache through <code>PersistenceUnitProperties.CACHE_SHARED</code>. Lack of object identity can lead to infinite loops for objects that have circular references and no indirection.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref846" name="sthref846"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Form a property name by appending a valid entity name or class name to <code>cache.type</code>, indicating that the property values apply only to a particular entity. As an alternative, you can append the <code>default</code> suffix to the <code>cache.type</code> prefix to form a property name that sets the default for all entities.</p>
<p>Valid values for <code>cache.type</code> properties are declared in the <code>CacheType</code> class. The default is <code>SoftWeak</code>.</p>
<p>If you do not want to cache entities, set the <code>cache.shared</code> property.</p>
<a id="sthref847" name="sthref847"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="annotations_ref.htm#CACHFEFD">Example 2-12</a> for information about how to use this property.</p>
<a id="sthref848" name="sthref848"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDEJCJJ">cache.shared</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="classloader" name="classloader"></a><a id="TLJPA1069" name="TLJPA1069"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">classloader</font></h2>
<p>Use the <code>eclipselink.classloader</code> property to create an <code>EntityMangerFactory</code> in the property map to be passed to <code>Persistence.createEntityManagerFactory</code>.</p>
<a id="sthref849" name="sthref849"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDEBCGE">Table 5-24</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54140" name="TLJPA54140"></a><a id="sthref850" name="sthref850"></a><a id="CHDEBCGE" name="CHDEBCGE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-24 Valid Values for classloader</font></em></strong></p>
<table class="FormalWide" title="Valid Values for classloader" summary="This table describes the valid values for the classloader persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t25"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t25"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t25" headers="r1c1-t25">
<p>value</p>
</td>
<td align="left" headers="r2c1-t25 r1c2-t25">
<p>Classloader to use.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref851" name="sthref851"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This is a dynamic property that must be set at runtime, in the property map. You cannot configure this property in the <code>persistence.xml</code> file.</p>
<a id="sthref852" name="sthref852"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFCFFI">Example 5-20</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDFCFFI" name="CHDFCFFI"></a><a id="TLJPA54141" name="TLJPA54141"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-20 Using classloader in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
properties.put("eclipselink.classloader", this.getClass().getClassLoader());
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="BIICFIDB" name="BIICFIDB"></a><a id="TLJPA872" name="TLJPA872"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">composite-unit</font></h2>
<p>Use the <code>eclipselink.composite-unit</code> property to specify if the persistence unit is a composite persistence unit.</p>
<a id="sthref853" name="sthref853"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BIIGDCGE">Table 5-25</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA873" name="TLJPA873"></a><a id="sthref854" name="sthref854"></a><a id="BIIGDCGE" name="BIIGDCGE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-25 Valid Values for composite-unit</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for composite-unit" summary="This table describes the valid values for the composite-unit persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t26"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t26"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t26" headers="r1c1-t26">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t26 r1c2-t26">
<p>Persistence unit <em>is</em> a composite persistence unit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t26" headers="r1c1-t26">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t26 r1c2-t26">
<p>(Default) Persistence unit <em>is not</em> a composite persistence unit.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref855" name="sthref855"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The property must be specified in <code>persistence.xml</code> of a composite persistence unit. The composite persistence unit must contain all persistence units found in JAR files specified by the <code>persistence.xml</code> file.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>If this property is passed to the <code>createEntityManagerFactory</code> method or if it is set in system properties, it is ignored.)</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<a id="sthref856" name="sthref856"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BIIECICI">Example 5-21</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BIIECICI" name="BIIECICI"></a><a id="TLJPA874" name="TLJPA874"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-21 Using composite-unit in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;persistence xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence persistence_1_0.xsd" version="1.0"&gt;
&lt;persistence-unit name="compositePu" transaction-type="JTA"&gt;
&lt;provider&gt;
org.eclipse.persistence.jpa.PersistenceProvider
&lt;/provider&gt;
&lt;jar-file&gt;member1.jar&lt;/jar-file&gt;
&lt;jar-file&gt;member2.jar&lt;/jar-file&gt;
&lt;properties&gt;
&lt;property name="<strong>eclipselink.composite-unit</strong>" value="true"/&gt;
&lt;property name="eclipselink.target-server" value="WebLogic_10"/&gt;
&lt;/properties&gt;
&lt;/persistence-unit&gt;
&lt;/persistence&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref857" name="sthref857"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDHCIDH">"composite-unit.member"</a></p>
</li>
<li>
<p><a href="#CIHGHJGA">"composite-unit.properties"</a></p>
</li>
<li>
<p>"Using Multiple Databases with a Composite&nbsp;Persistence Unit" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>"Composite Persistence Units" <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Composite_Persistence_Units">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Composite_Persistence_Units</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDHCIDH" name="CHDHCIDH"></a><a id="TLJPA875" name="TLJPA875"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">composite-unit.member</font></h2>
<p>Use the <code>eclipselink.composite-unit.member</code> property to specify if the persistence unit is a <em>member</em> composite persistence unit.</p>
<a id="sthref858" name="sthref858"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDIGFEB">Table 5-26</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA876" name="TLJPA876"></a><a id="sthref859" name="sthref859"></a><a id="CHDIGFEB" name="CHDIGFEB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-26 Valid Values for composite-unit.member</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for composite-unit.member" summary="This table describes the valid values for the composite-unit.member persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t28"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t28"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t28" headers="r1c1-t28">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t28 r1c2-t28">
<p>The persistence unit must be a member of a composite persistence unit and cannot be used as an independent persistence unit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t28" headers="r1c1-t28">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t28 r1c2-t28">
<p>(Default) The persistence unit does not have to be a member of a composite persistence unit.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref860" name="sthref860"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Setting this property to <code>true</code> indicates that the persistence unit has dependencies on other persistence units.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>If this property is passed to the <code>createEntityManagerFactory</code> method or if it is set in system properties, it is ignored.)</p>
<p>If this property is <code>true</code>, you may still create <code>EntityManagerFactory</code>, but it cannot be connected. Any attempt to create an entity manger will cause an exception.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<a id="TLJPA877" name="TLJPA877"></a>
<p><b><font face="arial, helvetica, sans-serif" color="#330099">Query Hint</font></b></p>
<p>When executing a native query on a composite persistence unit, use <code>composite-unit.member</code> to specify the name of the composite member persistence unit on which to execute the query.</p>
<a id="sthref861" name="sthref861"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CACGJACG2">Example 5-22</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CACGJACG2" name="CACGJACG2"></a><a id="TLJPA878" name="TLJPA878"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-22 Using composite-unit.member in persistence.xml</font></em></strong></p>
<p>Composite member persistence unit <strong>memberPu2</strong> is defined in the <strong>member2.jar</strong> file. It has dependency on a class defined in <strong>member1.jar</strong> and cannot be used independently.</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;persistence xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/persistence persistence_1_0.xsd"
version="1.0"&gt;
&lt;persistence-unit name="memberPu2"&gt;
&lt;provider&gt;
org.eclipse.persistence.jpa.PersistenceProvider
&lt;/provider&gt;
&lt;mapping-file&gt;META-INF/advanced-entity-mappings2.xml&lt;/mapping-file&gt;
&lt;jta-data-source&gt;jdbc/MySqlJtaDS&lt;/jta-data-source&gt;
&lt;exclude-unlisted-classes&gt;false&lt;/exclude-unlisted-classes&gt;
&lt;properties&gt;
&lt;property name="<strong>eclipselink.composite-unit.member</strong>" value="true"/&gt;
&lt;property name="eclipselink.target-database"
value="org.eclipse.persistence.platform.database.MySQLPlatform"/&gt;
&lt;/properties&gt;
&lt;/persistence-unit&gt;
&lt;/persistence&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref862" name="sthref862"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#BGBHHCJH">"@CompositeMember"</a></p>
</li>
<li>
<p><a href="#BIICFIDB">"composite-unit"</a></p>
</li>
<li>
<p><a href="queryhints.htm#CHDDFIDC">"composite-unit.member"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHGHJGA" name="CIHGHJGA"></a><a id="TLJPA879" name="TLJPA879"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">composite-unit.properties</font></h2>
<p>Use the <code>eclipselink.composite-unit.properties</code> property to configure the properties for persistence unit members.</p>
<a id="sthref863" name="sthref863"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHHEHCB">Table 5-27</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA880" name="TLJPA880"></a><a id="sthref864" name="sthref864"></a><a id="CIHHEHCB" name="CIHHEHCB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-27 Valid Values for composite-unit.properties</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for composite-unit.properties" summary="This table describes the valid values for the composite-unit.properties persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t30"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t30"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t30" headers="r1c1-t30">
<p>Map of properties</p>
</td>
<td align="left" headers="r2c1-t30 r1c2-t30">
<p>Properties to be passed to the persistence unit. Use the persistence unit's name as the key.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref865" name="sthref865"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Pass this property to <code>createEntityManager</code> method of a composite persistence unit to pass properties to its member persistence units.</p>
<a id="sthref866" name="sthref866"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CIHGBGHC">Example 5-23</a> shows how to use this property in a property map</p>
<div class="example"><a id="CIHGBGHC" name="CIHGBGHC"></a><a id="TLJPA881" name="TLJPA881"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-23 Using composite-unit.properties in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
Map props1 = new HashMap();
props1.put("javax.persistence.jdbc.user", "user1");
props1.put("javax.persistence.jdbc.password", "password1");
props1.put("javax.persistence.jdbc.driver", "oracle.jdbc.OracleDriver");
props1.put("javax.persistence.jdbc.url", "jdbc:oracle:thin:@oracle_db_url:1521:db");
Map props2 = new HashMap();
props2.put("javax.persistence.jdbc.user", "user2");
props2.put("javax.persistence.jdbc.password", "password2");
props2.put("javax.persistence.jdbc.driver", "com.mysql.jdbc.Driver");
props2.put("javax.persistence.jdbc.url", " jdbc:mysql://my_sql_db_url:3306/user2");
Map memberProps = new HashMap();
memberProps.put("memberPu1", props1);
memberProps.put("memberPu2", props2);
Map props = new HashMap();
props.put("eclipselink.logging.level", "FINEST");
props.put("<strong>eclipselink.composite-unit.properties</strong>", memberProps);
EntityManagerFactory emf = Persistence.createEntityManagerFactory("compositePu", props);
</pre></div>
<!-- class="example" -->
<a id="sthref867" name="sthref867"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BIICFIDB">"composite-unit"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.waittime" name="concurrency.manager.waittime"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.waittime</font></h2>
<p>This property in milliseconds can control thread management in <code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code>. It control how much time loop wait before it try acquire lock for current thread again. It value is set above above 0 dead lock detection mechanism and related extended logging will be activated.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.waittime.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.waittime.tab" name="concurrency.manager.waittime.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.waittime</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.waittime" summary="This table describes the valid values for the concurrency.manager.waittime persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>Wait time</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>How much time loop wait before it try acquire lock for current thread again. Default value is 0 (unit is ms). Allowed values are: long</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.waittime.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.waittime.example" name="concurrency.manager.waittime.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.waittime in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.waittime" value="100" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.maxsleeptime" name="concurrency.manager.maxsleeptime"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.maxsleeptime</font></h2>
<p>This system property in milliseconds can control thread management in <code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code>. It control how long we are willing to wait before firing up an exception.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.maxsleeptime.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.maxsleeptime.tab" name="concurrency.manager.maxsleeptime.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.maxsleeptime</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.maxsleeptime" summary="This table describes the valid values for the concurrency.manager.maxsleeptime persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>Wait time</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>It control how long we are willing to wait before firing up an exception. Default value is 40000 (unit is ms). Allowed values are: long</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.maxsleeptime.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.maxsleeptime.example" name="concurrency.manager.maxsleeptime.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.maxsleeptime in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.maxsleeptime" value="100" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.maxfrequencytodumptinymessage" name="concurrency.manager.maxfrequencytodumptinymessage"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.maxfrequencytodumptinymessage</font></h2>
<p>This system property in milliseconds can control thread management in <code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code> and <code>org.eclipse.persistence.internal.helper.ConcurrencyUtil</code>. It control how frequently the tiny dump log message is created.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.maxfrequencytodumptinymessage.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.maxfrequencytodumptinymessage.tab" name="concurrency.manager.maxfrequencytodumptinymessage.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.maxfrequencytodumptinymessage</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.maxfrequencytodumptinymessage" summary="This table describes the valid values for the concurrency.manager.maxfrequencytodumptinymessage persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>Wait time</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>It control how frequently the tiny dump log message is created. Default value is 40000 (unit is ms). Allowed values are: long</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.maxfrequencytodumptinymessage.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.maxfrequencytodumptinymessage.example" name="concurrency.manager.maxfrequencytodumptinymessage.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.maxfrequencytodumptinymessage in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.maxfrequencytodumptinymessage" value="100000" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.maxfrequencytodumpmassivemessage" name="concurrency.manager.maxfrequencytodumpmassivemessage"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.maxfrequencytodumpmassivemessage</font></h2>
<p>This system property in milliseconds can control thread management in <code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code> and <code>org.eclipse.persistence.internal.helper.ConcurrencyUtil</code>. It control how frequently the massive dump log message is created.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.maxfrequencytodumpmassivemessage.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.maxfrequencytodumpmassivemessage.tab" name="concurrency.manager.maxfrequencytodumpmassivemessage.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.maxfrequencytodumpmassivemessage</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.maxfrequencytodumpmassivemessage" summary="This table describes the valid values for the concurrency.manager.maxfrequencytodumpmassivemessage persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>Wait time</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>It control how frequently the massive dump log message is created. Default value is 60000 (unit is ms). Allowed values are: long</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.maxfrequencytodumpmassivemessage.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.maxfrequencytodumpmassivemessage.example" name="concurrency.manager.maxfrequencytodumpmassivemessage.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.maxfrequencytodumpmassivemessage in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.maxfrequencytodumpmassivemessage" value="100000" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.allow.interruptedexception" name="concurrency.manager.allow.interruptedexception"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.allow.interruptedexception</font></h2>
<p>In the places where use this property normally if a thread is stuck it is because it is doing object building. Blowing the threads ups is not that dangerous. It can be very dangerous for production if the dead lock ends up not being resolved because the productive business transactions will become cancelled if the application has a limited number of retries to for example process an MDB. However, the code spots where we use this constant are not as sensible as when the write lock manager is starving to run commit.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.allow.interruptedexception.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.allow.interruptedexception.tab" name="concurrency.manager.allow.interruptedexception.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.allow.interruptedexception</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.allow.interruptedexception" summary="This table describes the valid values for the concurrency.manager.allow.interruptedexception persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>true</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>(Default) If we want the to fire up an exception to try to get the current thread to release all of its acquired locks and allow other threads to progress.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>false</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>If aborting frozen thread is not effective it is preferable to not fire the interrupted exception let the system.</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.allow.interruptedexception.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.allow.interruptedexception.example" name="concurrency.manager.allow.interruptedexception.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.allow.interruptedexception in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.allow.interruptedexception" value="true" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.allow.concurrencyexception" name="concurrency.manager.allow.concurrencyexception"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.allow.concurrencyexception</font></h2>
<p>See valid values table.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.allow.concurrencyexception.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.allow.concurrencyexception.tab" name="concurrency.manager.allow.concurrencyexception.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.allow.concurrencyexception</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.allow.concurrencyexception" summary="This table describes the valid values for the concurrency.manager.allow.concurrencyexception persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>true</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>(Default) If we want the to fire up an exception to try to get the current thread to realease all of its acquired locks and allow other threads to progress.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>false</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>If aborting frozen thread is not effective it is preferable to not fire the concurrency exception let the system freeze and die and force the administration to kill the server. This is preferable to aborting the transactions multiple times without success in resolving the dead lock and having business critical messages that after 3 JMS retries are discarded out. Failing to resolve a dead lock can have terrible impact in system recovery unless we have infinite retries for the business transactions.</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.allow.concurrencyexception.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.allow.concurrencyexception.example" name="concurrency.manager.allow.concurrencyexception.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.allow.concurrencyexception in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.allow.concurrencyexception" value="true" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="concurrency.manager.allow.readlockstacktrace" name="concurrency.manager.allow.readlockstacktrace"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">concurrency.manager.allow.readlockstacktrace</font></h2>
<p>Collect debug/trace information during ReadLock acquisition.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#concurrency.manager.allow.readlockstacktrace.tab">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="concurrency.manager.allow.readlockstacktrace.tab" name="concurrency.manager.allow.readlockstacktrace.tab"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for concurrency.manager.allow.readlockstacktrace</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for concurrency.manager.allow.readlockstacktrace" summary="This table describes the valid values for the concurrency.manager.allow.readlockstacktrace persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t21"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t21"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>true</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>(Default) Collect debug/trace information during ReadLock acquisition.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r2c1-t21" headers="r1c1-t21">
<p>false</p>
</td>
<td align="left" headers="r2c1-t21 r1c2-t21">
<p>Don't collect debug/trace information during ReadLock acquisition</p>
</td>
</tr>
</tbody>
</table>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#concurrency.manager.allow.readlockstacktrace.example">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="concurrency.manager.allow.readlockstacktrace.example" name="concurrency.manager.allow.readlockstacktrace.example"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using concurrency.manager.allow.readlockstacktrace in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.concurrency.manager.allow.readlockstacktrace" value="true" /&gt;
</pre>
</div>
</div>
<!-- class="refsect1" -->
<a id="connectionpool" name="connectionpool"></a><a id="TLJPA1070" name="TLJPA1070"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">connection-pool</font></h2>
<p>Use the <code>eclipselink.connection-pool</code> property to configure the various connection pool properties.</p>
<a id="sthref868" name="sthref868"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABGHEBJ">Table 5-28</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA882" name="TLJPA882"></a><a id="sthref869" name="sthref869"></a><a id="BABGHEBJ" name="BABGHEBJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-28 Valid Values for connection-pool</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for connection-pool" summary="This table describes the valid values for the connection-pool persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="21%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t31"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t31"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t31" headers="r1c1-t31">
<p><code>initial</code></p>
</td>
<td align="left" headers="r2c1-t31 r1c2-t31">
<p>Starting (initial) number of connections.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t31" headers="r1c1-t31">
<p><code>min</code></p>
</td>
<td align="left" headers="r3c1-t31 r1c2-t31">
<p>Minimum number of connections.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t31" headers="r1c1-t31">
<p><code>max</code></p>
</td>
<td align="left" headers="r4c1-t31 r1c2-t31">
<p>Maximum number of connections.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t31" headers="r1c1-t31">
<p><code>wait</code></p>
</td>
<td align="left" headers="r5c1-t31 r1c2-t31">
<p>Amount of time (in milliseconds) to wait for a connection from the pool.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t31" headers="r1c1-t31">
<p><code>url</code></p>
</td>
<td align="left" headers="r6c1-t31 r1c2-t31">
<p>URL of the JDBC for the connection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t31" headers="r1c1-t31">
<p><code>shared</code></p>
</td>
<td align="left" headers="r7c1-t31 r1c2-t31">
<p>For read connection pools, indicates that read connections are shared across threads.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t31" headers="r1c1-t31">
<p><code>jtaDataSource</code></p>
</td>
<td align="left" headers="r8c1-t31 r1c2-t31">
<p>JTA DataSource name to use for the connection, if different than the default.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t31" headers="r1c1-t31">
<p><code>nonJtaDataSource</code></p>
</td>
<td align="left" headers="r9c1-t31 r1c2-t31">
<p>Non-JTA DataSource name to use for the connection, if different than the default.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t31" headers="r1c1-t31">
<p><code>user</code></p>
</td>
<td align="left" headers="r10c1-t31 r1c2-t31">
<p>Username to use for this connection (if different than the default).</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t31" headers="r1c1-t31">
<p><code>password</code></p>
</td>
<td align="left" headers="r11c1-t31 r1c2-t31">
<p>Password of the <code>user</code> for this connection (if different than the default).</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref870" name="sthref870"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Append the name of the connection pool and property to be configured. If connection pool is specified, EclipseLink configures the default (write) pool.</p>
<a id="sthref871" name="sthref871"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABICBAJ">Example 5-24</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABICBAJ" name="BABICBAJ"></a><a id="TLJPA883" name="TLJPA883"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-24 Using connection-pool in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.connection-pool.default.initial" value="1" /&gt;
&lt;property name="eclipselink.connection-pool.node2.min" value="16"/&gt;
&lt;property name="eclipselink.connection-pool.node2.max" value="16"/&gt;
&lt;property name="eclipselink.connection-pool.node2.url"
value="jdbc:oracle:thin:@node2:1521:orcl"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref872" name="sthref872"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Partitioning Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Partitioning">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Partitioning</a></code></p>
</li>
<li>
<p>"Connection Pools" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Connection Pooling" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p><a href="#CHDHAFAA">"jdbc.cache-statements"</a></p>
</li>
<li>
<p><a href="#CHDDIIFD">"connection-pool.read"</a></p>
</li>
<li>
<p><a href="#BABIDAGH">"connection-pool.sequence"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDDIIFD" name="CHDDIIFD"></a><a id="TLJPA884" name="TLJPA884"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">connection-pool.read</font></h2>
<p>Use the <code>eclipselink.connection-pool.read</code> property to configure a read connection pool for non-transaction read queries.</p>
<a id="sthref873" name="sthref873"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDBEFFF">Table 5-29</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA885" name="TLJPA885"></a><a id="sthref874" name="sthref874"></a><a id="CHDBEFFF" name="CHDBEFFF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-29 Valid Values for connection-pool.read</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for connection-pool.read" summary="This table describes the valid values for the connection-pool.read persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="21%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t32"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t32"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t32" headers="r1c1-t32">
<p><code>initial</code></p>
</td>
<td align="left" headers="r2c1-t32 r1c2-t32">
<p>Starting (initial) number of connection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t32" headers="r1c1-t32">
<p><code>min</code></p>
</td>
<td align="left" headers="r3c1-t32 r1c2-t32">
<p>Minimum number of connections.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t32" headers="r1c1-t32">
<p><code>max</code></p>
</td>
<td align="left" headers="r4c1-t32 r1c2-t32">
<p>Maximum number of connections.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t32" headers="r1c1-t32">
<p><code>wait</code></p>
</td>
<td align="left" headers="r5c1-t32 r1c2-t32">
<p>Amount of time it takes to get connections from the pool.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t32" headers="r1c1-t32">
<p><code>url</code></p>
</td>
<td align="left" headers="r6c1-t32 r1c2-t32">
<p>URL of the JDBC connection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t32" headers="r1c1-t32">
<p><code>shared</code></p>
</td>
<td align="left" headers="r7c1-t32 r1c2-t32">
<p>For read connection pools, indicates that read connections are shared across threads.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t32" headers="r1c1-t32">
<p><code>jtaDataSource</code></p>
</td>
<td align="left" headers="r8c1-t32 r1c2-t32">
<p>JTA DataSource name to use for the connection, if different than the default.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t32" headers="r1c1-t32">
<p><code>nonJtaDataSource</code></p>
</td>
<td align="left" headers="r9c1-t32 r1c2-t32">
<p>Non-JTA DataSource name to use for the connection, if different than the default.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t32" headers="r1c1-t32">
<p><code>user</code></p>
</td>
<td align="left" headers="r10c1-t32 r1c2-t32">
<p>Username to use for this connection (if different than the default).</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t32" headers="r1c1-t32">
<p><code>password</code></p>
</td>
<td align="left" headers="r11c1-t32 r1c2-t32">
<p>Password of the <code>user</code> for this connection (if different then the default).</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref875" name="sthref875"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>By default, EclipseLink <em>does not</em> use a separate read connection pool; the default pool is used for read queries.</p>
<a id="sthref876" name="sthref876"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJCIHD">Example 5-25</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJCIHD" name="CHDJCIHD"></a><a id="TLJPA886" name="TLJPA886"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-25 Using connection-pool.read in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.connection-pool.read.min" value="16"/&gt;
&lt;property name="eclipselink.connection-pool.read.max" value="16"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref877" name="sthref877"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Connection Pools" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Connection Pooling" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p><a href="#connectionpool">"connection-pool"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABIDAGH" name="BABIDAGH"></a><a id="TLJPA887" name="TLJPA887"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">connection-pool.sequence</font></h2>
<p>Use the <code>eclipselink.connection-pool.sequence</code> property to have the connection pool allocate generated IDs.</p>
<a id="sthref878" name="sthref878"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABGAFBI">Table 5-30</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA888" name="TLJPA888"></a><a id="sthref879" name="sthref879"></a><a id="BABGAFBI" name="BABGAFBI"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-30 Valid Values for connection-pool.sequence</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for connection-pool.sequence" summary="This table describes the valid values for the connection-pool.sequence persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="21%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t33"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t33"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t33" headers="r1c1-t33">
<p>true</p>
</td>
<td align="left" headers="r2c1-t33 r1c2-t33">
<p>Uses the internal connection pool to pool connections from a datasource.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t33" headers="r1c1-t33">
<p>false</p>
</td>
<td align="left" headers="r3c1-t33 r1c2-t33">
<p>(Default) Does not use the internal connection pool to pool connections from a datasource.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref880" name="sthref880"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This is only required for <code>TABLE</code> sequencing. By default, EclipseLink <em>does not</em> use a separate sequence connection pool; the default pool is used for sequencing.</p>
<a id="sthref881" name="sthref881"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABEFAFH">Example 5-26</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABEFAFH" name="BABEFAFH"></a><a id="TLJPA889" name="TLJPA889"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-26 Using connection-pool.sequence in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.connection-pool.sequence" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref882" name="sthref882"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Connection Pools" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Connection Pooling" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p><a href="#connectionpool">"connection-pool"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="createddljdbcfilename" name="createddljdbcfilename"></a><a id="TLJPA1071" name="TLJPA1071"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">create-ddl-jdbc-file-name</font></h2>
<p>Use the <code>eclipselink.create-ddl-jdbc-file-name</code> property to specify the name of the DDL file generated by EclipseLink that contains the SQL statements to create tables for JPA entities.</p>
<a id="sthref883" name="sthref883"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CBBIDIID">Table 5-31</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA890" name="TLJPA890"></a><a id="sthref884" name="sthref884"></a><a id="CBBIDIID" name="CBBIDIID"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-31 Valid Values for create-ddl-jdbc-file-name</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for create-ddl-jdbc-file-name" summary="This table describes the valid values for the create-ddl-jdbc-file-name persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t34"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t34"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t34" headers="r1c1-t34">
<p>File name</p>
</td>
<td align="left" headers="r2c1-t34 r1c2-t34">
<p>A file name valid for your operating system.</p>
<p>You can prefix the file name with a file path if a concatenation of <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code> + <code>eclipselink.<a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code> is valid for your operating system.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref885" name="sthref885"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>If <code>eclipselink.<a href="#BABHEJJI">ddl-generation</a></code> is set to <code>create-tables</code> or <code>drop-and-create-tables</code>, EclipseLink writes this file to the location specified by <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code>.</p>
<a id="sthref886" name="sthref886"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABFFGJE">Example 5-27</a> for information on how to use this property.</p>
<a id="sthref887" name="sthref887"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CACHGDEJ">"application-location"</a></p>
</li>
<li>
<p><a href="#BABHEJJI">"ddl-generation"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABHEJJI" name="BABHEJJI"></a><a id="TLJPA892" name="TLJPA892"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">ddl-generation</font></h2>
<p>Use the <code>eclipselink.ddl-generation</code> property to specify how EclipseLink generates DDL (Data Definition Language) for the database schema (tables and constraints) on deployment</p>
<a id="sthref888" name="sthref888"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABBEGCE">Table 5-32</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA893" name="TLJPA893"></a><a id="sthref889" name="sthref889"></a><a id="BABBEGCE" name="BABBEGCE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-32 Valid Values for ddl-generation</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for ddl-generation" summary="This table describes the valid values for the ddl-generation persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t35"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t35"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t35" headers="r1c1-t35">
<p><code>create-tables</code></p>
</td>
<td align="left" headers="r2c1-t35 r1c2-t35">
<p>EclipseLink will attempt to execute a <code>CREATE TABLE</code> SQL for each table.</p>
<p>If the table already exists, EclipseLink will follow the default behavior of your specific database and JDBC driver combination (when a <code>CREATE TABLE</code> SQL is issued for an already existing table). In most cases an exception is thrown and the table is not created; the existing table will be used. <code>EclipseLink</code> will then continue with the next statement.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t35" headers="r1c1-t35">
<p><code>create-or-extend-tables</code></p>
</td>
<td align="left" headers="r3c1-t35 r1c2-t35">
<p>EclipseLink will attempt to create tables. If the table exists, EclipseLink will add any missing columns.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t35" headers="r1c1-t35">
<p><code>drop-and-create-tables</code></p>
</td>
<td align="left" headers="r4c1-t35 r1c2-t35">
<p>EclipseLink will attempt to <code>DROP</code> all tables, then <code>CREATE</code> all tables. If any issues are encountered, EclipseLink will follow the default behavior of your specific database and JDBC driver combination, then continue with the next statement.</p>
<p>This is useful in development if the schema frequently changes or during testing when the existing data needs to be cleared.</p>
<p><strong>Note</strong>: Using <code>drop-and-create</code> will remove all of the data in the tables when they are dropped. You should never use option on a production schema that has valuable data in the database. If the schema changed dramatically, there could be old constraints in the database that prevent the dropping of the old tables. This may require the old schema to be dropped through another mechanism.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t35" headers="r1c1-t35">
<p><code>none</code></p>
</td>
<td align="left" headers="r5c1-t35 r1c2-t35">
<p>(Default) No DDL generated; no schema generated.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref890" name="sthref890"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use <code>create-or-extend-tables</code> only when <code>eclipselink.<a href="#BABCDHBB">ddl-generation.output-mode</a></code> = <code>database</code>.</p>
<p>If you are using persistence in a Java SE environment and would like to create the DDL files without creating tables, additionally define a Java system property <code>INTERACT_WITH_DB</code> and set its value to <code>false</code>.</p>
<p><code>DDL_GENERATION</code> must be set in order for this property to take effect.</p>
<a id="sthref891" name="sthref891"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABFFGJE">Example 5-27</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABFFGJE" name="BABFFGJE"></a><a id="TLJPA894" name="TLJPA894"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-27 Using ddl-generation in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.ddl-generation" value="drop-and-create-tables"/&gt;
&lt;property name="eclipselink.create-ddl-jdbc-file-name" value="createDDL_ddlGeneration.jdbc"/&gt;
&lt;property name="eclipselink.drop-ddl-jdbc-file-name" value="dropDDL_ddlGeneration.jdbc"/&gt;
&lt;property name="eclipselink.ddl-generation.output-mode" value="both"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABJADFJ">Example 5-28</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BABJADFJ" name="BABJADFJ"></a><a id="TLJPA895" name="TLJPA895"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-28 Using ddl-generation in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.DDL_GENERATION,
PersistenceUnitProperties.DROP_AND_CREATE);
propertiesMap.put(PersistenceUnitProperties.DDL_GENERATION_MODE,
PersistenceUnitProperties.BOTH);
propertiesMap.put(PersistenceUnitProperties.CREATE_JDBC_DDL_FILE, "create.sql");
</pre></div>
<!-- class="example" -->
<a id="sthref892" name="sthref892"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#createddljdbcfilename">"create-ddl-jdbc-file-name"</a></p>
</li>
<li>
<p><a href="#BABFEBCG">"drop-ddl-jdbc-file-name"</a></p>
</li>
<li>
<p><a href="#BABCDHBB">"ddl-generation.output-mode"</a></p>
</li>
<li>
<p>Example <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/DDL">http://wiki.eclipse.org/EclipseLink/Examples/JPA/DDL</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABCDHBB" name="BABCDHBB"></a><a id="TLJPA1073" name="TLJPA1073"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">ddl-generation.output-mode</font></h2>
<p>Use the <code>eclipselink.ddl-generation.output-mode</code> property to specify where EclipseLink generates and writes the DDL.</p>
<a id="sthref893" name="sthref893"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABGHGDC">Table 5-33</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA896" name="TLJPA896"></a><a id="sthref894" name="sthref894"></a><a id="BABGHGDC" name="BABGHGDC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-33 Valid Values for ddl-generation.output-mode</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for ddl-generation.output-mode" summary="This table describes the valid values for the ddl-generation.output-mode persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t36"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t36"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t36" headers="r1c1-t36">
<p><code>both</code></p>
</td>
<td align="left" headers="r2c1-t36 r1c2-t36">
<p>DDL will be generated and written to both the database and a file.</p>
<ul>
<li>
<p>If <code>eclipselink.<a href="#BABHEJJI">ddl-generation</a></code> is set to <code>create-tables</code>, then <code>eclipselink.<a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code> is written to <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code> and executed on the database.</p>
</li>
<li>
<p>If eclipselink.<a href="#BABHEJJI">ddl-generation</a> is set to <code>drop-and-create-tables</code>, then both <code>eclipselink.<a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code> and <code>eclipselink.<a href="#BABFEBCG">drop-ddl-jdbc-file-name</a></code> are written to <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code>, and both SQL files are executed on the database.</p>
</li>
</ul>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t36" headers="r1c1-t36">
<p><code>database</code></p>
</td>
<td align="left" headers="r3c1-t36 r1c2-t36">
<p>(Default) DDL will be generated and written to the database only.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t36" headers="r1c1-t36">
<p><code>sql-script</code></p>
</td>
<td align="left" headers="r4c1-t36 r1c2-t36">
<p>DDL will be generated and written to a file only.</p>
<ul>
<li>
<p>If <code>eclipselink.<a href="#BABHEJJI">ddl-generation</a></code> is set to <code>create-tables</code>, then <code>eclipselink.<a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code> is written to <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code>. It is <em>not</em> executed on the database.</p>
</li>
<li>
<p>If <code>eclipselink.<a href="#BABHEJJI">ddl-generation</a></code> is set to <code>drop-and-create-tables</code>, then both <code>eclipselink.<a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code> and eclipselink.<a href="#BABFEBCG">drop-ddl-jdbc-file-name</a> are written to <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code>. Neither are executed on the database.</p>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref895" name="sthref895"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can only use <code>ddl-generation.output-mode</code> if you use <code>ddl-generation</code>. Then, you can optimally set other properties.</p>
<a id="sthref896" name="sthref896"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABFFGJE">Example 5-27</a> for information on how to use this property.</p>
<a id="sthref897" name="sthref897"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CACHGDEJ">"application-location"</a></p>
</li>
<li>
<p><a href="#BABHEJJI">"ddl-generation"</a></p>
</li>
<li>
<p><a href="#createddljdbcfilename">"create-ddl-jdbc-file-name"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BEHBIEJG" name="BEHBIEJG"></a><a id="TLJPA1072" name="TLJPA1072"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">ddl.table-creation-suffix</font></h2>
<p>Use the <code>eclipselink.ddl.table-creation-suffix</code> property to append a string to generated <code>CREATE Table</code> statements.</p>
<a id="sthref898" name="sthref898"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BEHIHGDB">Table 5-34</a> describes this property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA891" name="TLJPA891"></a><a id="sthref899" name="sthref899"></a><a id="BEHIHGDB" name="BEHIHGDB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-34 Valid Values for ddl-generation.table-creation-suffix</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for ddl-generation.table-creation-suffix" summary="This table describes the valid values for the ddl-generation.table-creation-suffix persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t37"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t37"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t37" headers="r1c1-t37">
<p>value</p>
</td>
<td align="left" headers="r2c1-t37 r1c2-t37">
<p>The name of the suffix.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref900" name="sthref900"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The <code>ddl.generation</code> property must be set.</p>
<a id="sthref901" name="sthref901"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCAFFF">Example 5-29</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDCAFFF" name="CHDCAFFF"></a><a id="TLJPA54142" name="TLJPA54142"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-29 Using ddl.table-creation-suffix in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.ddl.table-creation-suffix" value="engine=InnoDB"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref902" name="sthref902"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BABHEJJI">"ddl-generation"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="delayonstartup" name="delayonstartup"></a><a id="TLJPA1074" name="TLJPA1074"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">deploy-on-startup</font></h2>
<p>Use the <code>eclipselink.deploy-on-startup</code> property to configure deployment on startup (at the creation of the <code>EntityManagerFactory</code>) instead of occurring the first time an <code>EntityManager</code> is created.</p>
<a id="sthref903" name="sthref903"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABJJADC">Table 5-35</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA897" name="TLJPA897"></a><a id="sthref904" name="sthref904"></a><a id="BABJJADC" name="BABJJADC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-35 Valid Values for delay-on-startup</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for delay-on-startup" summary="This table describes the valid values for the delay-on-startup persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t38"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t38"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t38" headers="r1c1-t38">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t38 r1c2-t38">
<p>Causes a persistence unit to be created when the EntityManager is created, usually during deployment to a Java EE container or servlet container.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t38" headers="r1c1-t38">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t38 r1c2-t38">
<p>(Default) The persistence unit is not initialized until the first EntityManager is created, or until metadata is required from the EntityManagerFactory.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref905" name="sthref905"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Using <code>true</code> may increase startup time of a JavaEE server, but will avoid the first request from hanging as the persistence unit is deployed.</p>
<a id="sthref906" name="sthref906"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABJIBFB">Example 5-30</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="BABJIBFB" name="BABJIBFB"></a><a id="TLJPA898" name="TLJPA898"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-30 Using deploy-on-startup in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.deploy-on-startup" value="true" /&gt;
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="CCHIEAIA" name="CCHIEAIA"></a><a id="TLJPA1075" name="TLJPA1075"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">descriptor.customizer</font></h2>
<p>Use the <code>eclipselink.descriptor.customizer</code> property as a prefix for a property to configure a <code>DescriptorCustomizer</code>. Use this class's customize method, which takes an <code>org.eclipse.persistence.descriptors.ClassDescriptor</code>, to programmatically access advanced EclipseLink descriptor and mapping API for the descriptor associated with the JPA entity.</p>
<a id="sthref907" name="sthref907"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CCHJDFEF">Table 5-36</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1076" name="TLJPA1076"></a><a id="sthref908" name="sthref908"></a><a id="CCHJDFEF" name="CCHJDFEF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-36 Valid Values for descriptor.customizer</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for descriptor.customizer" summary="This table describes the valid values for the descriptor.customizer persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t39"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t39"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t39" headers="r1c1-t39">
<p>name</p>
</td>
<td align="left" headers="r2c1-t39 r1c2-t39">
<p>Full name for a class that implements <code>DescriptorCustomizer</code>.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref909" name="sthref909"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You cannot use multiple descriptor customizers.</p>
<a id="sthref910" name="sthref910"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CCHFCJIB">Example 5-31</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="CCHFCJIB" name="CCHFCJIB"></a><a id="TLJPA899" name="TLJPA899"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-31 Using descriptor.customizer in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.descriptor.customizer.Order"
value="acme.sessions.MyDesriptorCustomizer"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CCHGCBGA">Example 5-32</a> shows how to use this property with a property map.</p>
<div class="example"><a id="CCHGCBGA" name="CCHGCBGA"></a><a id="TLJPA900" name="TLJPA900"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-32 Using descriptor.customizer in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.DESCRIPTOR_CUSTOMIZER+".Order",
"acme.sessions.MyDescriptorCustomizer");
</pre></div>
<!-- class="example" -->
<a id="sthref911" name="sthref911"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><em>Understanding EclipseLink</em></p>
</li>
<li>
<p>Section 8.1, "Entity" in the JPA Specification <code><a href="http://jcp.org/en/jsr/detail?id=220">http://jcp.org/en/jsr/detail?id=220</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABFEBCG" name="BABFEBCG"></a><a id="TLJPA1077" name="TLJPA1077"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">drop-ddl-jdbc-file-name</font></h2>
<p>Use the <code>eclipselink.drop-ddl-jdbc-file-name</code> property to specify the name of the DDL file generated by EclipseLink that contains the SQL statements to drop tables for JPA entities.</p>
<a id="sthref912" name="sthref912"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABDFGJF">Table 5-37</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1078" name="TLJPA1078"></a><a id="sthref913" name="sthref913"></a><a id="BABDFGJF" name="BABDFGJF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-37 Valid Values for drop-ddl-jdbc-file-name</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for drop-ddl-jdbc-file-name" summary="This table describes the valid values for the drop-ddl-jdbc-file-name persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t40"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t40"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t40" headers="r1c1-t40">
<p>File name</p>
</td>
<td align="left" headers="r2c1-t40 r1c2-t40">
<p>A file name valid for your operating system.</p>
<p>You can prefix the file name with a file path if a concatenation of <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code> + <code>eclipselink.<a href="#createddljdbcfilename">create-ddl-jdbc-file-name</a></code> is valid for your operating system.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref914" name="sthref914"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>If <code>eclipselink.<a href="#BABHEJJI">ddl-generation</a></code> is set to <code>create-tables</code>, EclipseLink writes this file to the location specified by <code>eclipselink.<a href="#CACHGDEJ">application-location</a></code>.</p>
<a id="sthref915" name="sthref915"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABFFGJE">Example 5-27</a> for information on how to use this property.</p>
<a id="sthref916" name="sthref916"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BABHEJJI">"ddl-generation"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CCHCJCDJ" name="CCHCJCDJ"></a><a id="TLJPA1079" name="TLJPA1079"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">exception-handler</font></h2>
<p>Use the <code>eclipselink.exception-handler</code> property to specify the EclipseLink exception handler class: an exception handler class that implements the <code>org.eclipse.persistence.exceptions.ExceptionHandler</code> interface. The class must provide a default, no-argument constructor.</p>
<a id="sthref917" name="sthref917"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CCHEDGHC">Table 5-38</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1080" name="TLJPA1080"></a><a id="sthref918" name="sthref918"></a><a id="CCHEDGHC" name="CCHEDGHC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-38 Valid Values for exception-handler</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for exception-handler" summary="This table describes the valid values for the exception-handler persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t41"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t41"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t41" headers="r1c1-t41">
<p><code>ExceptionHandler</code> class</p>
</td>
<td align="left" headers="r2c1-t41 r1c2-t41">
<p>Use the <code>handleException</code> method of the class, which takes a <code>java.lang.RuntimeException</code>, to:</p>
<ul>
<li>
<p>Re-throw the exception</p>
</li>
<li>
<p>Throw a different exception</p>
</li>
<li>
<p>Retry the query or database operation</p>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref919" name="sthref919"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The <code>ExceptionHandler</code> class name must be fully qualified by its package name.</p>
<a id="sthref920" name="sthref920"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CCHEACJI">Example 5-33</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CCHEACJI" name="CCHEACJI"></a><a id="TLJPA1081" name="TLJPA1081"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-33 Using exception-handler in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.exception-handler"
value="my.package.MyExceptionHandler"&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CCHDJGGC">Example 5-34</a> shows how to use this extension in a property map.</p>
<div class="example"><a id="CCHDJGGC" name="CCHDJGGC"></a><a id="TLJPA1082" name="TLJPA1082"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-34 Using exception-handler in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.EXCEPTION_HANDLER_CLASS,
"my.package.MyExceptionHandler");
</pre></div>
<!-- class="example" -->
<a id="sthref921" name="sthref921"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#orm.throw.exceptions">"orm.throw.exceptions"</a></p>
</li>
<li>
<p>"Sessions" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Managing and Diagnosing Problems" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDBIAAC" name="CHDBIAAC"></a><a id="TLJPA1083" name="TLJPA1083"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">exclude-eclipselink-orm</font></h2>
<p>Use the <code>eclipselink.exclude-eclipselink-orm</code> property to exclude an EclipseLink ORM mapping file for a specific persistence unit.</p>
<a id="sthref922" name="sthref922"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDEAFHG">Table 5-39</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1084" name="TLJPA1084"></a><a id="sthref923" name="sthref923"></a><a id="CHDEAFHG" name="CHDEAFHG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-39 Valid Values for exclude-eclipselink-orm</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for exclude-eclipselink-orm" summary="This table describes the valid values for the exclude-eclipselink-orm persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t42"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t42"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t42" headers="r1c1-t42">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t42 r1c2-t42">
<p>Does not use the <code>eclipselink-orm.xml</code> file.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t42" headers="r1c1-t42">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t42 r1c2-t42">
<p>(Default) EclipseLink uses the <code>eclipselink-orm.xml</code> file.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref924" name="sthref924"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>By default the first file found at the resource name: <code>META-INF/eclipselink-orm.xml</code> is processed and overrides configurations specified in annotations and standard mapping files.</p>
<a id="sthref925" name="sthref925"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBHCCA">Example 5-35</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBHCCA" name="CHDBHCCA"></a><a id="TLJPA901" name="TLJPA901"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-35 Using exclude-eclipselink-orm in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.exclude-eclipselink-orm" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref926" name="sthref926"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Building Blocks of a EclipseLink Project" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Using an External Metadata Source" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CDEJGBEI" name="CDEJGBEI"></a><a id="TLJPA1085" name="TLJPA1085"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">flush-clear.cache</font></h2>
<p>Use the <code>eclipselink.flush-clear.cache</code> property to specify the EclipseLink <code>EntityManager</code> cache behavior when a <code>clear</code> method follows the <code>flush</code> method.</p>
<a id="sthref927" name="sthref927"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CDEDEGHC">Table 5-40</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1086" name="TLJPA1086"></a><a id="sthref928" name="sthref928"></a><a id="CDEDEGHC" name="CDEDEGHC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-40 Valid Values for flush-clear.cache</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for flush-clear.cache" summary="This table describes the valid values for the flush-clear.cache persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="23%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t43"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t43"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t43" headers="r1c1-t43">
<p><code>Drop</code></p>
</td>
<td align="left" headers="r2c1-t43 r1c2-t43">
<p>EclipseLink drops the entire <code>EntityManager</code> cache.</p>
<p>Although this is the fastest mode and uses the least memory, the shared cache may potentially contain stale data after performing the commit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t43" headers="r1c1-t43">
<p><code>DropInvalidate</code></p>
</td>
<td align="left" headers="r3c1-t43 r1c2-t43">
<p>(Default) EclipseLink drops the entire <code>EntityManager</code> cache. Classes that have at least one updated or deleted object become invalid in the shared cache after performing the commit.</p>
<p>This mode is slower than <code>Drop</code>, but as efficient (in terms of memory usage) and prevents stale data.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t43" headers="r1c1-t43">
<p><code>Merge</code></p>
</td>
<td align="left" headers="r4c1-t43 r1c2-t43">
<p>EclipseLink drops objects the <code>EntityManager</code> cache that have not been flushed.</p>
<p>Although this mode leaves the shared cache in a perfect state after performing the commit, it is the least memory-efficient. In a very large transaction you may run out of memory.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref929" name="sthref929"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can specify this property when creating an <code>EntityManagerFactory</code> (in the map passed to the <code>createEntityManagerFactory</code> method or in the <code>persistence.xml</code> file), or an <code>EntityManager</code> (in the map passed to the <code>createEntityManager</code> method).</p>
<p>Note that the latter overrides the former.</p>
<a id="sthref930" name="sthref930"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CDEICBJJ">Example 5-36</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CDEICBJJ" name="CDEICBJJ"></a><a id="TLJPA902" name="TLJPA902"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-36 Using flush-clear.cache in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.flush-clear.cache" value="Drop"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CDEJIDHJ">Example 5-37</a> shows how to use this extension in a property map.</p>
<div class="example"><a id="CDEJIDHJ" name="CDEJIDHJ"></a><a id="TLJPA903" name="TLJPA903"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-37 Using flush-clear.cache in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.ecliplse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.FLUSH_CLEAR_CACHE,
FlushClearCache.Drop);
</pre></div>
<!-- class="example" -->
<a id="sthref931" name="sthref931"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#CHDBBIHE">"@Cache"</a></p>
</li>
<li>
<p>"Cache Coordination" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Scaling EclipseLink Applications in Clusters" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>Cache Coordination Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/CacheCoordination">http://wiki.eclipse.org/EclipseLink/Examples/JPA/CacheCoordination</a></code></p>
</li>
<li>
<p>"Clustering and Cache Coordination" <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Caching/Coordination</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CACEEGCC" name="CACEEGCC"></a><a id="TLJPA1087" name="TLJPA1087"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">id-validation</font></h2>
<p>Use the <code>eclipselink.id-validation</code> property to define which primary key components values are considered invalid.</p>
<a id="sthref932" name="sthref932"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACJGDDD">Table 5-41</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1088" name="TLJPA1088"></a><a id="sthref933" name="sthref933"></a><a id="CACJGDDD" name="CACJGDDD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-41 Valid Values for id-validation</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for id-validation" summary="This table describes the valid values for the id-validation persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t44"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t44"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t44" headers="r1c1-t44">
<p><code>Negative</code></p>
</td>
<td align="left" headers="r2c1-t44 r1c2-t44">
<p><code>Null</code>, <code>0</code> and negative values are invalid for IDs extending <code>Number</code> and primitive <code>int</code> and <code>long</code> IDs.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t44" headers="r1c1-t44">
<p><code>None</code></p>
</td>
<td align="left" headers="r3c1-t44 r1c2-t44">
<p>EclipseLink performs no ID validation.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t44" headers="r1c1-t44">
<p><code>Null</code></p>
</td>
<td align="left" headers="r4c1-t44 r1c2-t44">
<p><code>Null</code> is invalid All other values are valid.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t44" headers="r1c1-t44">
<p><code>Zero</code></p>
</td>
<td align="left" headers="r5c1-t44 r1c2-t44">
<p><code>Null</code>, <code>0</code> and negative values are invalid for primitive <code>int</code> and <code>long</code> IDs.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref934" name="sthref934"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Identity and sequencing (with <code>shouldAlwaysOverrideExistingValue</code> configured as <code>true</code>) will override any existing ID value.</p>
<a id="sthref935" name="sthref935"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDIIGAJ">Example 5-38</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDIIGAJ" name="CHDIIGAJ"></a><a id="TLJPA904" name="TLJPA904"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-38 Using id-validation in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.id-validation" value="NULL"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref936" name="sthref936"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Persisting Objects" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p><a href="annotations_ref.htm#BGEBBFJE">"@PrimaryKey"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHHJBFB" name="CIHHJBFB"></a><a id="TLJPA1089" name="TLJPA1089"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.allow-native-sql-queries</font></h2>
<p>Use the <code>eclipselink.jdbc.allow-native-sql-queries</code> property to specify if user-defined (that is, native) SQL is allowed within a persistence unit.</p>
<a id="sthref937" name="sthref937"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHCHAAF">Table 5-42</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1090" name="TLJPA1090"></a><a id="sthref938" name="sthref938"></a><a id="CIHCHAAF" name="CIHCHAAF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-42 Valid Values for jdbc.allow-native-sql-queries</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.allow-native-sql-queries" summary="This table describes the valid values for the jdbc.allow-native-sql-queries persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t45"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t45"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t45" headers="r1c1-t45">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t45 r1c2-t45">
<p>(Default) EclipseLink allows native SQL.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t45" headers="r1c1-t45">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t45 r1c2-t45">
<p>EclipseLink does not allow native SQL.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref939" name="sthref939"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Within a multitenant, use this option to minimize the potential impact of revealing multitenant information. By default, any persistence unit with a multitenant entity causes EclipseLink to set <code>eclipselink.jdbc.allow-native-sql-queries</code> as <code>false</code>.</p>
<a id="sthref940" name="sthref940"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFFJJE">Example 5-39</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDFFJJE" name="CHDFFJJE"></a><a id="TLJPA905" name="TLJPA905"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-39 Using jdbc.allow-native-sql-queries in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.allow-native-sql-queries" value="false" /&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref941" name="sthref941"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Querying" in <em>Understanding EclipseLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHIAGAF" name="CIHIAGAF"></a><a id="TLJPA906" name="TLJPA906"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.batch-writing</font></h2>
<p>Use the <code>eclipselink.jdbc.batch-writing</code> property to configure batch writing to optimize transactions with multiple write functions.</p>
<a id="sthref942" name="sthref942"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHFJDIB">Table 5-43</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA907" name="TLJPA907"></a><a id="sthref943" name="sthref943"></a><a id="CIHFJDIB" name="CIHFJDIB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-43 Valid Values for jdbc.batch-writing</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.batch-writing" summary="This table describes the valid values for the jdbc.batch-writing persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t46"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t46"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t46" headers="r1c1-t46">
<p><code>jdbc</code></p>
</td>
<td align="left" headers="r2c1-t46 r1c2-t46">
<p>Use JDBC batch writing.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t46" headers="r1c1-t46">
<p><code>buffered</code></p>
</td>
<td align="left" headers="r3c1-t46 r1c2-t46">
<p>Do not use JDBC batch writing or the platform's native batch writing.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t46" headers="r1c1-t46">
<p><code>oracle-jdbc</code></p>
</td>
<td align="left" headers="r4c1-t46 r1c2-t46">
<p>Use the Oracle platform's native batch writing. In a property map, use <code>OracleJDBC</code>.</p>
<p><strong>Note</strong>: This requires an Oracle JDBC driver.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t46" headers="r1c1-t46">
<p><code>custom-class</code></p>
</td>
<td align="left" headers="r5c1-t46 r1c2-t46">
<p>A custom class that extends the <code>BatchWritingMechanism</code> class.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t46" headers="r1c1-t46">
<p><code>none</code></p>
</td>
<td align="left" headers="r6c1-t46 r1c2-t46">
<p>(Default) Do not use batch writing (that is, turn it off).</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref944" name="sthref944"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Batch writing allows multiple heterogeneous dynamic SQL statements to be sent to the database as a single execution, or multiple homogeneous parameterized SQL statements to be executed as a single batch execution.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>Not all JDBC drivers or databases support batch writing.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<p>Use <code>eclipselink.<a href="#CIHJADHF">jdbc.batch-writing.size</a></code> to specify the batch size.</p>
<a id="sthref945" name="sthref945"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJDFBE">Example 5-40</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJDFBE" name="CHDJDFBE"></a><a id="TLJPA908" name="TLJPA908"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-40 Using jdbc.batch-writing in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.batch-writing" value="Oracle-JDBC"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHJHJH">Example 5-41</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHJHJH" name="CHDHJHJH"></a><a id="TLJPA909" name="TLJPA909"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-41 Using jdbc.batch-writing in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.BATCH_WRITING,
BatchWriting.OracleJDBC);
</pre></div>
<!-- class="example" -->
<a id="sthref946" name="sthref946"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CIHJADHF">"jdbc.batch-writing.size"</a></p>
</li>
<li>
<p>"Batch Writing" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHJADHF" name="CIHJADHF"></a><a id="TLJPA910" name="TLJPA910"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.batch-writing.size</font></h2>
<p>Use the <code>eclipselink.jdbc.batch-writing.size</code> property to configure the batch size used for batch writing.</p>
<a id="sthref947" name="sthref947"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHCGJDJ">Table 5-44</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA911" name="TLJPA911"></a><a id="sthref948" name="sthref948"></a><a id="CIHCGJDJ" name="CIHCGJDJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-44 Valid Values for jdbc.batch-writing.size</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.batch-writing.size" summary="This table describes the valid values for the jdbc.batch-writing.size persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t48"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t48"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t48" headers="r1c1-t48">
<p>batch size</p>
</td>
<td align="left" headers="r2c1-t48 r1c2-t48">
<p>For <strong>parameterized</strong> batch writing, this value is the number of statements to batch (default: <code>100</code>).</p>
<p>For <strong>dynamic</strong> batch writing, this value is the size of the batched SQL buffer (default: <code>32k</code>).</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref949" name="sthref949"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDGEAHF">Example 5-42</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDGEAHF" name="CHDGEAHF"></a><a id="TLJPA912" name="TLJPA912"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-42 Using jdbc.batch-writing.size in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.batch-writing.size" value="1000"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref950" name="sthref950"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CIHIAGAF">"jdbc.batch-writing"</a></p>
</li>
<li>
<p>"Batch Writing" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDHAFAA" name="CHDHAFAA"></a><a id="TLJPA913" name="TLJPA913"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.cache-statements</font></h2>
<p>Use the <code>eclipselink.jdbc.cache-statements</code> property to specify if JDBC statements should be cached.</p>
<a id="sthref951" name="sthref951"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDJCHGH">Table 5-45</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA914" name="TLJPA914"></a><a id="sthref952" name="sthref952"></a><a id="CHDJCHGH" name="CHDJCHGH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-45 Valid Values for jdbc.cache-statements</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.cache-statements" summary="This table describes the valid values for the jdbc.cache-statement persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t49"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t49"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t49" headers="r1c1-t49">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t49 r1c2-t49">
<p>Enable internal statement caching.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t49" headers="r1c1-t49">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t49 r1c2-t49">
<p>(Default) Disable internal statement caching.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref953" name="sthref953"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You should use this property when using EclipseLink's internal connection pooling. See <a href="#connectionpool">"connection-pool"</a> for more information.</p>
<a id="sthref954" name="sthref954"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFFCAE">Example 5-43</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDFFCAE" name="CHDFFCAE"></a><a id="TLJPA915" name="TLJPA915"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-43 Using jdbc.cache-statements in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.cache-statements" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGGFFJ">Example 5-44</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDGGFFJ" name="CHDGGFFJ"></a><a id="TLJPA916" name="TLJPA916"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-44 Using jdbc.cache-statements in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.CACHE_STATEMENTS, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref955" name="sthref955"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CACBICGG">"jdbc.cache-statements.size"</a></p>
</li>
<li>
<p><a href="#connectionpool">"connection-pool"</a></p>
</li>
<li>
<p>"Batch Writing" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CACBICGG" name="CACBICGG"></a><a id="TLJPA917" name="TLJPA917"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.cache-statements.size</font></h2>
<p>Use the <code>eclipselink.jdbc.cache-statements.size</code> property to specify the number of statements held when using internal statement caching.</p>
<a id="sthref956" name="sthref956"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACHIFGG">Table 5-46</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA918" name="TLJPA918"></a><a id="sthref957" name="sthref957"></a><a id="CACHIFGG" name="CACHIFGG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-46 Valid Values for jdbc.cache-statements.size</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.cache-statements.size" summary="This table describes the valid values for the jdbc.cache-statements.size persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t50"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t50"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t50" headers="r1c1-t50">
<p>size</p>
</td>
<td align="left" headers="r2c1-t50 r1c2-t50">
<p>A string value containing a positive integer or zero (Default: <code>50</code>).</p>
<p>The maximum value may vary, depending on your JDBC driver.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref958" name="sthref958"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCJAAA">Example 5-45</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDCJAAA" name="CHDCJAAA"></a><a id="TLJPA919" name="TLJPA919"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-45 Using jdbc.cache-statements.size in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.cache-statements.size" value="100"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHCJGF">Example 5-46</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHCJGF" name="CHDHCJGF"></a><a id="TLJPA920" name="TLJPA920"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-46 Using jdbc.cache-statements.size in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.CACHE_STATEMENTS_SIZE, "100");
</pre></div>
<!-- class="example" -->
<a id="sthref959" name="sthref959"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDHAFAA">"jdbc.cache-statements"</a></p>
</li>
<li>
<p>"Batch Writing" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CFAJHIJA" name="CFAJHIJA"></a><a id="TLJPA921" name="TLJPA921"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.connector</font></h2>
<p>Use the <code>eclipselink.jdbc.connector</code> property to define a custom connector to connect to the database.</p>
<a id="sthref960" name="sthref960"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CFAEDDCC">Table 5-47</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA922" name="TLJPA922"></a><a id="sthref961" name="sthref961"></a><a id="CFAEDDCC" name="CFAEDDCC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-47 Valid Values for jdbc.connector</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.connector" summary="This table describes the valid values for the jdbc.connector persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t51"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t51"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t51" headers="r1c1-t51">
<p>Fully qualified class name</p>
</td>
<td align="left" headers="r2c1-t51 r1c2-t51">
<p>A class that implements the <code>Connector</code> interface.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref962" name="sthref962"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use this property to connect to a non-standard connection pool, or provide customized details on how to obtain a connection.</p>
<p>This property is not required when using a <code>DataSource</code> or JDBC <code>DriverManager</code>.</p>
<a id="sthref963" name="sthref963"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDEEFA">Example 5-47</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDEEFA" name="CHDDEEFA"></a><a id="TLJPA923" name="TLJPA923"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-47 Using jdbc.connector in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.connector" value="package.MyConnector"/&gt;
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="CHDCJIBF" name="CHDCJIBF"></a><a id="TLJPA925" name="TLJPA925"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.exclusive-connection.is-lazy</font></h2>
<p>Use the <code>eclipselink.jdbc.exclusive-connection.is-lazy</code> property to specify if EclipseLink acquires write connections lazily.</p>
<a id="sthref964" name="sthref964"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDEEGCH">Table 5-48</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA926" name="TLJPA926"></a><a id="sthref965" name="sthref965"></a><a id="CHDEEGCH" name="CHDEEGCH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-48 Valid Values for jdbc.exclusive-connection.is-lazy</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.exclusive-connection.is-lazy" summary="This table describes the valid values for the jdbc.exclusive-connection.is-lazy persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t52"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t52"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t52" headers="r1c1-t52">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t52 r1c2-t52">
<p>(Default) Acquire write connections lazily.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t52" headers="r1c1-t52">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t52 r1c2-t52">
<p>Do not acquire write connections lazily.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref966" name="sthref966"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDIIHC">Example 5-48</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDIIHC" name="CHDDIIHC"></a><a id="TLJPA927" name="TLJPA927"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-48 Using jdbc.exclusive-connection.is-lazy in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.exclusive-connection.is-lazy" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDEDDBE">Example 5-49</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDEDDBE" name="CHDEDDBE"></a><a id="TLJPA928" name="TLJPA928"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-49 Using jdbc.exclusive-connection.is-lazy in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.EXCLUSIVE_CONNECTION_IS_LAZY,
"false");
</pre></div>
<!-- class="example" -->
<a id="sthref967" name="sthref967"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Auditing<code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Auditing">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Auditing</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CACBICGG2" name="CACBICGG2"></a><a id="TLJPA929" name="TLJPA929"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.exclusive-connection.mode</font></h2>
<p>Use the <code>eclipselink.jdbc.exclusive-connection.mode</code> property to specify when EclipseLink performs reads through the write connection.</p>
<a id="sthref968" name="sthref968"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDJCHGH3">Table 5-49</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA930" name="TLJPA930"></a><a id="sthref969" name="sthref969"></a><a id="CHDJCHGH3" name="CHDJCHGH3"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-49 Valid Values for jdbc.exclusive-connection.mode</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.exclusive-connection.mode" summary="This table describes the valid values for the jdbc.exclusive-connection.mode persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t53"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t53"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t53" headers="r1c1-t53">
<p><code>Transactional</code></p>
</td>
<td align="left" headers="r2c1-t53 r1c2-t53">
<p>(Default) Create an isolated client session if some or all entities require isolated cache, otherwise create a client session.</p>
<p><strong>Notes</strong>:</p>
<ul>
<li>
<p>EclipseLink keeps the connection exclusive for the duration of the transaction.</p>
</li>
<li>
<p><em>Inside</em> the transaction, EclipseLink performs all writes and reads through the exclusive connection.</p>
</li>
<li>
<p><em>Outside</em> the EclipseLink transaction, a new connection is acquired from the connection pool for each read and released back immediately after the query is executed.</p>
</li>
</ul>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t53" headers="r1c1-t53">
<p><code>Isolated</code></p>
</td>
<td align="left" headers="r3c1-t53 r1c2-t53">
<p>Create an exclusive isolated client session if reading an isolated entity, otherwise raise an error.</p>
<p><strong>Notes</strong>:</p>
<ul>
<li>
<p>EclipseLink keeps the connection exclusive for the lifetime of the owning <code>EntityManager</code>.</p>
</li>
<li>
<p><em>Inside</em> the transaction, EclipseLink performs all writes and reads through the exclusive connection.</p>
</li>
<li>
<p><em>Outside</em> the EclipseLink transaction, only isolated entities are read through the exclusive connection. For non-isolated entities, EclipseLink acquires a new connection from the connection pool for each read and immediately releases the connection after executing the query.</p>
</li>
</ul>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t53" headers="r1c1-t53">
<p><code>Always</code></p>
</td>
<td align="left" headers="r4c1-t53 r1c2-t53">
<p>Create an exclusive isolated client session if reading an isolated entity, otherwise create an exclusive client session.</p>
<p><strong>Note</strong>: EclipseLink keeps the connection exclusive for the lifetime of the owning <code>EntityManager</code> and performs all writes and reads through the exclusive connection.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref970" name="sthref970"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can set this property while creating either an <code>EntityManagerFactory</code> (either in the map passed to the <code>createEntityManagerFactory</code> method, or in the <code>persistence.xml</code> file), or an <code>EntityManager</code> (in the map passed to the <code>createEntityManager</code> method). Note that the latter overrides the former.</p>
<a id="sthref971" name="sthref971"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBEHHE">Example 5-50</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBEHHE" name="CHDBEHHE"></a><a id="TLJPA931" name="TLJPA931"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-50 Using jdbc.exclusive-connection.mode in persitence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
property name="eclipselink.jdbc.exclusive-connection.mode" value="Always"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDEJGJB">Example 5-51</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDEJGJB" name="CHDEJGJB"></a><a id="TLJPA932" name="TLJPA932"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-51 Using jdbc.exclusive-connection.mode in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.EXCLUSIVE_CONNECTION_MODE, "Always");
</pre></div>
<!-- class="example" -->
<a id="sthref972" name="sthref972"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDCJIBF">"jdbc.exclusive-connection.is-lazy"</a></p>
</li>
<li>
<p>"Isolated Client Sessions" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Connections" in <em>Understanding EclipseLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHEACBE" name="CIHEACBE"></a><a id="TLJPA933" name="TLJPA933"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.native-sql</font></h2>
<p>Use the <code>eclipselink.jdbc.native-sql</code> property to specify if EclipseLink uses generic SLQ or includes platform-specific (that is, "native") SQL statements.</p>
<a id="sthref973" name="sthref973"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHDBHDD">Table 5-50</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA934" name="TLJPA934"></a><a id="sthref974" name="sthref974"></a><a id="CIHDBHDD" name="CIHDBHDD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-50 Valid Values for jdbc.native-sql</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.native-sql" summary="This table describes the valid values for the jdbc.native-sql persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t54"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t54"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t54" headers="r1c1-t54">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t54 r1c2-t54">
<p>(Default) Use platform-specific ("native" ) SQL.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t54" headers="r1c1-t54">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t54 r1c2-t54">
<p>Use generic SQL.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref975" name="sthref975"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>When using platform-specific SQL (<code>eclipselink.jdbc.native-sql</code> = <code>true</code>), EclipseLink uses platform-specific SQL to customize join syntax, date operators, using sequencing, and so on.</p>
<a id="sthref976" name="sthref976"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDABBB">Example 5-52</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDABBB" name="CHDDABBB"></a><a id="TLJPA935" name="TLJPA935"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-52 Using jdbc.native-sql in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.native-sql" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDIJBIE">Example 5-53</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDIJBIE" name="CHDIJBIE"></a><a id="TLJPA936" name="TLJPA936"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-53 Using jdbc.native-sql in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.NATIVE_SQL, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref977" name="sthref977"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Querying" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Query Languages" in <em>Understanding EclipseLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHHJHHD" name="CIHHJHHD"></a><a id="TLJPA937" name="TLJPA937"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.property</font></h2>
<p>Use the <code>eclipselink.jdbc.property</code> prefix to pass JDBC driver-specific connection properties to EclipseLink.</p>
<a id="sthref978" name="sthref978"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Append the JDBC driver-specific property name to this property prefix.</p>
<a id="sthref979" name="sthref979"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDHGEBH">Example 5-54</a> shows how to use this property prefix in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDHGEBH" name="CHDHGEBH"></a><a id="TLJPA938" name="TLJPA938"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-54 Using jdbc.property in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.property.defaultRowPrefetch" value="25"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref980" name="sthref980"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Using EclipseLink with the Oracle Database" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>"Introduction to Data Access" in <em>Understanding EclipseLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CIHBHCID" name="CIHBHCID"></a><a id="TLJPA939" name="TLJPA939"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.sql-cast</font></h2>
<p>Use the <code>eclipselink.jdbc.sql-cast</code> property to specify if EclipseLink uses platform-specific (that is, "native") <code>CAST</code> SQL operations.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>Normally, casting is not required. Using it may cause issues.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<a id="sthref981" name="sthref981"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHFHHGF">Table 5-51</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA940" name="TLJPA940"></a><a id="sthref982" name="sthref982"></a><a id="CIHFHHGF" name="CIHFHHGF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-51 Valid Values for jdbc.sql-cast</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.sql-cast" summary="This table describes the valid values for the jdbc.sql-cast persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t56"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t56"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t56" headers="r1c1-t56">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t56 r1c2-t56">
<p>Use platform-specific <code>CAST</code> operations.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t56" headers="r1c1-t56">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t56 r1c2-t56">
<p>(Default) Do not use platform-specific <code>CAST</code> operations.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref983" name="sthref983"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJHBDG">Example 5-55</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJHBDG" name="CHDJHBDG"></a><a id="TLJPA54144" name="TLJPA54144"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-55 Using jdbc.sql-cast in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jdbc.sql-cast" value="true"/&gt;
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="CIHIIAFD" name="CIHIIAFD"></a><a id="TLJPA941" name="TLJPA941"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jdbc.uppercase-columns</font></h2>
<p>Use the <code>eclipselink.jdbc.uppercase-columns</code> property to force column names from the metadata to be uppercase.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>This parameter has been replaced by <code><a href="#CHDFJAAC">jpql.parser</a></code>, which ensures that both sides use uppercase for comparisons.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<a id="sthref984" name="sthref984"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHGHIGC">Table 5-52</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA942" name="TLJPA942"></a><a id="sthref985" name="sthref985"></a><a id="CIHGHIGC" name="CIHGHIGC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-52 Valid Values for jdbc.uppercase-columns</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jdbc.uppercase-columns" summary="This table describes the valid values for the jdbc.uppercase-columns persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t58"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t58"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t58" headers="r1c1-t58">
<p>true</p>
</td>
<td align="left" headers="r2c1-t58 r1c2-t58">
<p>Forces all column names from the metadata to uppercase.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t58" headers="r1c1-t58">
<p>false</p>
</td>
<td align="left" headers="r3c1-t58 r1c2-t58">
<p>(Default) Does not force column names from the metadata to uppercase.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref986" name="sthref986"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>When using native SQL queries, the JDBC metadata may return column names in lower case on some platforms. If the column names are uppercase in the mappings (default), they will not match. You should use this parameter to force all column names from the metadata to uppercase.</p>
<a id="sthref987" name="sthref987"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBHAGA">Example 5-56</a> shows how to use this parameter in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBHAGA" name="CHDBHAGA"></a><a id="TLJPA54154" name="TLJPA54154"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-56 Using jdbc.uppercase-column-names in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jpa.uppercase-columns" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref988" name="sthref988"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDFJAAC">"jpql.parser"</a></p>
</li>
<li>
<p>"Using EclipseLink with the Oracle Database" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>"Introduction to Data Access" in <em>Understanding EclipseLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDFJAAC" name="CHDFJAAC"></a><a id="TLJPA1093" name="TLJPA1093"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jpql.parser</font></h2>
<p>Use the <code>eclipselink.jpql.parser</code> property to configure the JPQL parser parameters.</p>
<a id="sthref989" name="sthref989"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDDCFEJ">Table 5-53</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1094" name="TLJPA1094"></a><a id="sthref990" name="sthref990"></a><a id="CHDDCFEJ" name="CHDDCFEJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-53 Valid Values for jpql.parser</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jpql.parser" summary="This table describes the valid values for the jpql.parser persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="34%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t59"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t59"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t59" headers="r1c1-t59">
<p><code>org.eclipse.persistence.internal.jpa.jpql.HermesParser</code></p>
</td>
<td align="left" headers="r2c1-t59 r1c2-t59">
<p>(Default) Current parser, starting with EclipseLink 2.4, that provides extended JPQL support.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t59" headers="r1c1-t59">
<p><code>org.eclipse.persistence.queries.ANTLRQueryBuilder</code></p>
</td>
<td align="left" headers="r3c1-t59 r1c2-t59">
<p>Old parser, used for backward compatibility (prior to EclipseLink 2.4).</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref991" name="sthref991"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#BCFGFEFB3">"jpql.validation"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDJGCBD" name="CHDJGCBD"></a><a id="TLJPA1091" name="TLJPA1091"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jpa.uppercase-column-names</font></h2>
<p>Use the <code>eclipselink.jpa.uppercase-column-names</code> property to specify JPA processing to uppercase all column name definitions (simulating case insensitivity).</p>
<a id="sthref992" name="sthref992"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDEEHBA">Table 5-54</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1092" name="TLJPA1092"></a><a id="sthref993" name="sthref993"></a><a id="CHDEEHBA" name="CHDEEHBA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-54 Valid Values for jpa.uppercase-column-names</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jpa.uppercase-column-names" summary="This table describes the valid values for the persistence jpa.uppercase-column-names property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t60"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t60"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t60" headers="r1c1-t60">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t60 r1c2-t60">
<p>JDBC metadata returned from the database is returned in uppercase, ensuring fields are the same case. Sets <code><a href="#CIHIIAFD">jdbc.uppercase-columns</a></code> to <code>true</code>.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t60" headers="r1c1-t60">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t60 r1c2-t60">
<p>(Default) Does not return JDBC metadata in uppercase.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref994" name="sthref994"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property to correct situations in which user-defined fields do not match the case returned by the database for native queries.</p>
<a id="sthref995" name="sthref995"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJJCBB">Example 5-57</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJJCBB" name="CHDJJCBB"></a><a id="TLJPA54145" name="TLJPA54145"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-57 Using jpa.uppercase-column-names in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jpa.uppercase-column-names" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref996" name="sthref996"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CIHIIAFD">"jdbc.uppercase-columns"</a></p>
</li>
<li>
<p>"Using EclipseLink with the Oracle Database" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>"Introduction to Data Access" in <em>Understanding EclipseLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BCFGFEFB3" name="BCFGFEFB3"></a><a id="TLJPA1095" name="TLJPA1095"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">jpql.validation</font></h2>
<p>Use the <code>eclipselink.jpql.parser</code> property to configure the JPQL parser validation level.</p>
<a id="sthref997" name="sthref997"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BCFGAFDA3">Table 5-55</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1096" name="TLJPA1096"></a><a id="sthref998" name="sthref998"></a><a id="BCFGAFDA3" name="BCFGAFDA3"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-55 Valid Values for jpql.validation</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for jpql.validation" summary="This table describes the valid values for the jpql.validation persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="34%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t61"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t61"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t61" headers="r1c1-t61">
<p><code>EclipseLink</code></p>
</td>
<td align="left" headers="r2c1-t61 r1c2-t61">
<p>(Default) Allows EclipseLink JPAL extensions.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t61" headers="r1c1-t61">
<p><code>JPA 1.0</code></p>
</td>
<td align="left" headers="r3c1-t61 r1c2-t61">
<p>Allows valid JPA 1.0 JPQL only.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t61" headers="r1c1-t61">
<p><code>JPA 2.0</code></p>
</td>
<td align="left" headers="r4c1-t61 r1c2-t61">
<p>Allows valid JPA 2.0 JPQL only.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t61" headers="r1c1-t61">
<p><code>JPA 2.1</code></p>
</td>
<td align="left" headers="r5c1-t61 r1c2-t61">
<p>Allows valid JPA 2.1 JPQL only.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t61" headers="r1c1-t61">
<p><code>None</code></p>
</td>
<td align="left" headers="r6c1-t61 r1c2-t61">
<p>No JPQL validation.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref999" name="sthref999"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This parameter applies only when <code>eclipselink.<a href="#CHDFJAAC">jpql.parser</a></code> is <code>HermesParser</code>.</p>
<a id="sthref1000" name="sthref1000"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCHGGF">Example 5-58</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDCHGGF" name="CHDCHGGF"></a><a id="TLJPA54146" name="TLJPA54146"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-58 Using jpql.validation in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.jpql.validation" value="JPA 1.0"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1001" name="sthref1001"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDFJAAC">"jpql.parser"</a></p>
</li>
<li>
<p><a href="jpql.htm#BABCIECD">"Java Persistence Query&nbsp;Language&nbsp;Extensions"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDJCBIF" name="CHDJCBIF"></a><a id="TLJPA1097" name="TLJPA1097"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.connection</font></h2>
<p>Use the <code>eclipselink.logging.connection</code> property to specify if connections are logged.</p>
<a id="sthref1002" name="sthref1002"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDHCIED">Table 5-56</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1098" name="TLJPA1098"></a><a id="sthref1003" name="sthref1003"></a><a id="CHDHCIED" name="CHDHCIED"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-56 Valid Values for logging.connection</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.connection" summary="This table describes the valid values for the logging.connection persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t62"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t62"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t62" headers="r1c1-t62">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t62 r1c2-t62">
<p>(Default) Logs the connection name.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t62" headers="r1c1-t62">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t62 r1c2-t62">
<p>Does not log the connection name.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1004" name="sthref1004"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Using this parameter means that all connections are logged and not masked by the application code.</p>
<a id="sthref1005" name="sthref1005"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDDFJE">Example 5-59</a> shows how to use this parameter in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDDFJE" name="CHDDDFJE"></a><a id="TLJPA54163" name="TLJPA54163"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-59 Using logging.connection in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.connection" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1006" name="sthref1006"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p><a href="#CHDGFDDH">"logging.level"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BEIFJBIE" name="BEIFJBIE"></a><a id="TLJPA943" name="TLJPA943"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.exceptions</font></h2>
<p>Use the <code>eclipselink.logging.exceptions</code> property to specify if exceptions are logged when they are thrown, before returning the exception to the calling application.</p>
<a id="sthref1007" name="sthref1007"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BEIDDGBA">Table 5-57</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA944" name="TLJPA944"></a><a id="sthref1008" name="sthref1008"></a><a id="BEIDDGBA" name="BEIDDGBA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-57 Valid Values for logging.exceptions</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.exceptions" summary="This table describes the valid values for the logging.exceptions persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t63"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t63"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t63" headers="r1c1-t63">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t63 r1c2-t63">
<p>(Default) Logs exceptions when they are thrown.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t63" headers="r1c1-t63">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t63 r1c2-t63">
<p>Does not log exceptions when they are thrown.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1009" name="sthref1009"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Using this property ensures that all exceptions are logged and not masked by the application code.</p>
<a id="sthref1010" name="sthref1010"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABCGBJA">Example 5-60</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="BABCGBJA" name="BABCGBJA"></a><a id="TLJPA945" name="TLJPA945"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-60 Using logging.exceptions in persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.exceptions" value="false" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABFGBDI">Example 5-61</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BABFGBDI" name="BABFGBDI"></a><a id="TLJPA946" name="TLJPA946"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-61 Using logging.exceptions in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_EXCEPTIONS, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1011" name="sthref1011"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p><a href="#CHDGFDDH">"logging.level"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BEIHGBBC" name="BEIHGBBC"></a><a id="TLJPA947" name="TLJPA947"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.file</font></h2>
<p>Use the <code>eclipselink.logging.file</code> property to specify a file location in which to output the log instead of the standard out.</p>
<a id="sthref1012" name="sthref1012"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BEIIAJDG">Table 5-58</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA948" name="TLJPA948"></a><a id="sthref1013" name="sthref1013"></a><a id="BEIIAJDG" name="BEIIAJDG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-58 Valid Values for logging.file</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.file" summary="This table describes the valid values for the logging.file persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t64"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t64"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t64" headers="r1c1-t64">
<p>directory name</p>
</td>
<td align="left" headers="r2c1-t64 r1c2-t64">
<p>A string location to a directory in which you have write access. The location may be relative to your current working directory or an absolute location.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1014" name="sthref1014"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This property applies when used in a Java SE environment.</p>
<a id="sthref1015" name="sthref1015"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CACEFJBC">Example 5-62</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="CACEFJBC" name="CACEFJBC"></a><a id="TLJPA949" name="TLJPA949"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-62 Using logging.file in persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.file" value="C:\myout\" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CACJCGAG">Example 5-63</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CACJCGAG" name="CACJCGAG"></a><a id="TLJPA950" name="TLJPA950"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-63 Using logging.file in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_FILE, "C:\myout\");
</pre></div>
<!-- class="example" -->
<a id="sthref1016" name="sthref1016"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDGFDDH" name="CHDGFDDH"></a><a id="TLJPA951" name="TLJPA951"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.level</font></h2>
<p>Use the <code>eclipselink.logging.level</code> property to specify a specific logging level and control the amount and detail that is emitted.</p>
<a id="sthref1017" name="sthref1017"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BEIHAIBC">Table 5-59</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA952" name="TLJPA952"></a><a id="sthref1018" name="sthref1018"></a><a id="BEIHAIBC" name="BEIHAIBC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-59 Valid Values for logging.level</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.level" summary="This table describes the valid values for the logging.level persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t65"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t65"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t65" headers="r1c1-t65">
<p><code>OFF</code></p>
</td>
<td align="left" headers="r2c1-t65 r1c2-t65">
<p>Disables logging.</p>
<p>You may want to use <code>OFF</code> during production in order to avoid the overhead of logging.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t65" headers="r1c1-t65">
<p><code>SEVERE</code></p>
</td>
<td align="left" headers="r3c1-t65 r1c2-t65">
<p>Logs exceptions indicating that EclipseLink cannot continue, as well as any exceptions generated during login. This includes a stack trace.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t65" headers="r1c1-t65">
<p><code>WARNING</code></p>
</td>
<td align="left" headers="r4c1-t65 r1c2-t65">
<p>Logs exceptions that <em>do not</em> force EclipseLink to stop, including all exceptions not logged with <code>SEVERE</code> level. This does not include a stack trace.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t65" headers="r1c1-t65">
<p><code>INFO</code></p>
</td>
<td align="left" headers="r5c1-t65 r1c2-t65">
<p>(Default) Logs the login/logout per sever session, including the user name. After acquiring the session, detailed information is logged.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t65" headers="r1c1-t65">
<p><code>CONFIG</code></p>
</td>
<td align="left" headers="r6c1-t65 r1c2-t65">
<p>Logs only login, JDBC connection, and database information. You may want to use this log level at deployment time.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t65" headers="r1c1-t65">
<p><code>FINE</code></p>
</td>
<td align="left" headers="r7c1-t65 r1c2-t65">
<p>Logs all SQL. You may want to use this log level during debugging and testing, but not at production time.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t65" headers="r1c1-t65">
<p><code>FINER</code></p>
</td>
<td align="left" headers="r8c1-t65 r1c2-t65">
<p>Similar to <code>WARNING</code>, but includes stack trace. You may want to use this log level during debugging and testing, but not at production time.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t65" headers="r1c1-t65">
<p><code>FINEST</code></p>
</td>
<td align="left" headers="r9c1-t65 r1c2-t65">
<p>Similar to <code>FINER</code>, but includes additional low level information. You may want to use this log level during debugging and testing, but not at production time.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t65" headers="r1c1-t65">
<p><code>ALL</code></p>
</td>
<td align="left" headers="r10c1-t65 r1c2-t65">
<p>Logs at the same level as <code>FINEST</code>.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1019" name="sthref1019"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BEIEEBEJ">Example 5-64</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="BEIEEBEJ" name="BEIEEBEJ"></a><a id="TLJPA953" name="TLJPA953"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-64 Using logging.level in persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.level" value="OFF" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BEIGJJIH">Example 5-65</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BEIGJJIH" name="BEIGJJIH"></a><a id="TLJPA954" name="TLJPA954"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-65 Using logging.level in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import java.util.logging.Level;
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_LEVEL, Level.OFF);
</pre></div>
<!-- class="example" -->
<a id="sthref1020" name="sthref1020"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="TLJPA955" name="TLJPA955"></a>
<hr />
<div class="refsect1"><a id="sthref1021" name="sthref1021"></a>
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.logger</font></h2>
<p>Use the <code>eclipselink.logging.logger</code> property to define the type of logger to use.</p>
<a id="sthref1022" name="sthref1022"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABGABAJ">Table 5-60</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA956" name="TLJPA956"></a><a id="sthref1023" name="sthref1023"></a><a id="BABGABAJ" name="BABGABAJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-60 Valid Values for logging.logger</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.logger" summary="This table describes the valid values for the logging.logger persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t66"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t66"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t66" headers="r1c1-t66">
<p>Custom logger</p>
</td>
<td align="left" headers="r2c1-t66 r1c2-t66">
<p>Fully qualified class name of a custom logger which implements <code>org.eclipse.persistence.logging.SessionLog</code>.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t66" headers="r1c1-t66">
<p><code>JavaLogger</code></p>
</td>
<td align="left" headers="r3c1-t66 r1c2-t66">
<p>Uses <code>java.util.logging</code>.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t66" headers="r1c1-t66">
<p><code>ServerLogger</code></p>
</td>
<td align="left" headers="r4c1-t66 r1c2-t66">
<p>Integrates with the application server's logging.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t66" headers="r1c1-t66">
<p><code>DefaultLogger</code></p>
</td>
<td align="left" headers="r5c1-t66 r1c2-t66">
<p>(Default) Uses EclipseLink's native logger, <code>DefaultSessionLog</code>.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1024" name="sthref1024"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDGEGJH">Example 5-66</a> shows how to use this parameter in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDGEGJH" name="CHDGEGJH"></a><a id="TLJPA957" name="TLJPA957"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-66 Using logging.logger in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.logger" value="JavaLogger"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDEFICF">Example 5-67</a> shows how to use this parameter in a property map.</p>
<div class="example"><a id="CHDEFICF" name="CHDEFICF"></a><a id="TLJPA958" name="TLJPA958"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-67 Using logging.logger in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_LOGGER,
"acme.loggers.MyCustomLogger";
</pre></div>
<!-- class="example" -->
<a id="sthref1025" name="sthref1025"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Logging examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p>Custom logger http://wiki.eclipse.org/EclipseLink/Examples/JPA/CustomLogger</p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="TLJPA959" name="TLJPA959"></a>
<hr />
<div class="refsect1"><a id="sthref1026" name="sthref1026"></a>
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.parameters</font></h2>
<p>Use the <code>eclipselink.logging.parameters</code> property to define if SQL bind parameters are included in exceptions and logs.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>This parameter applies to bind parameters only. Parameters are always displayed when not using binding.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<a id="sthref1027" name="sthref1027"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABEIHHD">Table 5-61</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA960" name="TLJPA960"></a><a id="sthref1028" name="sthref1028"></a><a id="BABEIHHD" name="BABEIHHD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-61 Valid Values for logging.parameters</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.parameters" summary="This table describes the valid values for the logging.parameters persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t68"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t68"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t68" headers="r1c1-t68">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t68 r1c2-t68">
<p>(Default) Display the parameters.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t68" headers="r1c1-t68">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t68 r1c2-t68">
<p>Do not display the parameters.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1029" name="sthref1029"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>By default, when using <code><a href="#CHDGFDDH">logging.level</a></code> of <code>FINE</code> (or greater), SQL bind parameters are displayed. Use this parameter to override the default behavior.</p>
<a id="sthref1030" name="sthref1030"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCHGGF">Example 5-58</a> shows how to use this parameter in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDGCCE" name="CHDDGCCE"></a><a id="TLJPA961" name="TLJPA961"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-68 Using logging.parameters in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;paramter name="eclipselink.logging.parameters" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1031" name="sthref1031"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDGFDDH">"logging.level"</a></p>
</li>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BEIHGGHH" name="BEIHGGHH"></a><a id="TLJPA963" name="TLJPA963"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.session</font></h2>
<p>Use the <code>eclipselink.logging.session</code> property to specify if EclipseLink should include a session identifier in each log message.</p>
<a id="sthref1032" name="sthref1032"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDJCDEJ">Table 5-62</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA964" name="TLJPA964"></a><a id="sthref1033" name="sthref1033"></a><a id="CHDJCDEJ" name="CHDJCDEJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-62 Valid Values for logging.session</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.session" summary="This table describes the valid values for the logging.session persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t69"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t69"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t69" headers="r1c1-t69">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t69 r1c2-t69">
<p>(Default) Log a session identifier.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t69" headers="r1c1-t69">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t69 r1c2-t69">
<p>Do not log a session identifier.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1034" name="sthref1034"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This setting is applicable to messages that require a database connection such as SQL and the transaction information to determine on which underlying session (if any) the message was sent.</p>
<a id="sthref1035" name="sthref1035"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCEJIG">Example 5-69</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="CHDCEJIG" name="CHDCEJIG"></a><a id="TLJPA965" name="TLJPA965"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-69 Using logging.session in persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.session" value="false" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDCEEBI">Example 5-70</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDCEEBI" name="CHDCEEBI"></a><a id="TLJPA966" name="TLJPA966"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-70 Using logging.session in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_SESSION, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1036" name="sthref1036"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p><a href="#CHDGFDDH">"logging.level"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BEIFFGGB" name="BEIFFGGB"></a><a id="TLJPA967" name="TLJPA967"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.thread</font></h2>
<p>Use the <code>eclipselink.logging.thread</code> property to specify if EclipseLink should include a thread identifier in each log message.</p>
<a id="sthref1037" name="sthref1037"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CDFJJJGC">Table 5-63</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA968" name="TLJPA968"></a><a id="sthref1038" name="sthref1038"></a><a id="CDFJJJGC" name="CDFJJJGC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-63 Valid Values for logging.thread</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.thread" summary="This table describes the valid values for the logging.thread persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t70"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t70"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t70" headers="r1c1-t70">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t70 r1c2-t70">
<p>(Default) Log a thread identifier.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t70" headers="r1c1-t70">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t70 r1c2-t70">
<p>Do not log a thread identifier.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1039" name="sthref1039"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You should use this property when running multi-threaded applications. EclipseLink will include a hashcode of the thread.</p>
<a id="sthref1040" name="sthref1040"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CDFIAHBA">Example 5-71</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="CDFIAHBA" name="CDFIAHBA"></a><a id="TLJPA969" name="TLJPA969"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-71 Using logging.thread in persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.thread" value="false" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CDFEHDHJ">Example 5-72</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CDFEHDHJ" name="CDFEHDHJ"></a><a id="TLJPA970" name="TLJPA970"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-72 Using logging.thread in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_THREAD, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1041" name="sthref1041"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDGFDDH">"logging.level"</a></p>
</li>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BEIJCEBJ" name="BEIJCEBJ"></a><a id="TLJPA971" name="TLJPA971"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">logging.timestamp</font></h2>
<p>Use the <code>eclipselink.logging.timestamp</code> property to specify if EclipseLink should include a timestamp in each log message.</p>
<a id="sthref1042" name="sthref1042"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BEIHEEHF">Table 5-64</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA972" name="TLJPA972"></a><a id="sthref1043" name="sthref1043"></a><a id="BEIHEEHF" name="BEIHEEHF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-64 Valid Values for logging.timestamp</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for logging.timestamp" summary="This table describes the valid values for the logging.timestamp persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t71"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t71"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t71" headers="r1c1-t71">
<p>true</p>
</td>
<td align="left" headers="r2c1-t71 r1c2-t71">
<p>(Default) Log a timestamp.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t71" headers="r1c1-t71">
<p>false</p>
</td>
<td align="left" headers="r3c1-t71 r1c2-t71">
<p>Do not log a timestamp.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1044" name="sthref1044"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABGHIAE">Example 5-73</a> shows how to use this property in the <code>peristence.xml</code> file.</p>
<div class="example"><a id="BABGHIAE" name="BABGHIAE"></a><a id="TLJPA973" name="TLJPA973"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-73 Using logging.timestamp in persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.logging.timestamp" value="false" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABGHBDA">Example 5-74</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BABGHBDA" name="BABGHBDA"></a><a id="TLJPA974" name="TLJPA974"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-74 Using logging.timestamp in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.LOGGING_TIMESTAMP, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1045" name="sthref1045"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Configuring WebLogic Server to Expose EclipseLink Logging" in <em>Solutions Guide for EclispeLink</em></p>
</li>
<li>
<p>Logging Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Logging</a></code></p>
</li>
<li>
<p><a href="#CHDGFDDH">"logging.level"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDJDEDE" name="CHDJDEDE"></a><a id="TLJPA1099" name="TLJPA1099"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">metadata-source</font></h2>
<p>Use the <code>eclipselink.metadata-source</code> property to specify the <code>MetadataSource</code> implementation EclipseLink uses to read metadata.</p>
<a id="sthref1046" name="sthref1046"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDBJHIA">Table 5-65</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1100" name="TLJPA1100"></a><a id="sthref1047" name="sthref1047"></a><a id="CHDBJHIA" name="CHDBJHIA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-65 Valid Values for metadata-source</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for metadata-source" summary="This table describes the valid values for the metadata-source persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t72"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t72"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t72" headers="r1c1-t72">
<p><code>XML</code></p>
</td>
<td align="left" headers="r2c1-t72 r1c2-t72">
<p>Use <code>XMLMetadataSource</code>.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t72" headers="r1c1-t72">
<p>Custom metadata source</p>
</td>
<td align="left" headers="r3c1-t72 r1c2-t72">
<p>A custom class name which implements <code>MetadataSource</code>.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1048" name="sthref1048"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property with <code>eclipselink.<a href="#CHDDJHIC">metadata-source.xml.file</a></code> to access an external mapping file at a fixed URL for a persistence unit.</p>
<a id="sthref1049" name="sthref1049"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDIJADD">Example 5-75</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDIJADD" name="CHDIJADD"></a><a id="TLJPA975" name="TLJPA975"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-75 Using metadata-source in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.metadata-source" value="xml"/&gt;
&lt;property name="eclipselink.metadata-source.xml.file" value="c:/myfile.xml"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1050" name="sthref1050"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDICFHG">"metadata-source.send-refresh-command"</a></p>
</li>
<li>
<p><a href="#CHDDJHIC">"metadata-source.xml.file"</a></p>
</li>
<li>
<p><a href="#CHDBFJEB">"metadata-source.xml.url"</a></p>
</li>
<li>
<p>Metadata Source Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/">http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/</a></code></p>
</li>
<li>
<p>"Extensible Entities" <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Extensible_Entities">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Extensible_Entities</a></code></p>
</li>
<li>
<p>"Using an External Metadata Source" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDEFFGG2" name="CHDEFFGG2"></a><a id="TLJPA1101" name="TLJPA1101"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">metadata-source.properties.file</font></h2>
<p>Use the <code>eclipselink.metadata-source.properties.file</code> property to specify the name of the metadata repository properties file to read from, using the classloader to find the resource.</p>
<a id="sthref1051" name="sthref1051"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDDAHCI2">Table 5-66</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1102" name="TLJPA1102"></a><a id="sthref1052" name="sthref1052"></a><a id="CHDDAHCI2" name="CHDDAHCI2"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-66 Valid Values for metadata-repository.properties.file</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for metadata-repository.properties.file" summary="This table describes the valid values for the metadata-repository.properties.file persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t73"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t73"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t73" headers="r1c1-t73">
<p>Filename</p>
</td>
<td align="left" headers="r2c1-t73 r1c2-t73">
<p>Name of the metadata source XML file.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1053" name="sthref1053"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property with <code>eclipselink.<a href="#CHDJDEDE">metadata-source</a></code> when using an XML repository.</p>
<a id="sthref1054" name="sthref1054"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDJECG">Example 5-76</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDJECG" name="CHDDJECG"></a><a id="TLJPA54164" name="TLJPA54164"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-76 Using metadata-source.properties.file in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.metadata-source.properties.file"
value="c:\myproperties.xml"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1055" name="sthref1055"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDJDEDE">"metadata-source"</a></p>
</li>
<li>
<p>Metadata Source Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/">http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/</a></code></p>
</li>
<li>
<p>"Using an External Metadata Source" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDICFHG" name="CHDICFHG"></a><a id="TLJPA976" name="TLJPA976"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">metadata-source.send-refresh-command</font></h2>
<p>Use the <code>eclipselink.metadata-source.send-refresh-command</code> property with cache coordination for a clustered environment to control how EclipseLink sends RCM refresh metadata commands to the cluster.</p>
<a id="sthref1056" name="sthref1056"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDEHIJD">Table 5-67</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA977" name="TLJPA977"></a><a id="sthref1057" name="sthref1057"></a><a id="CHDEHIJD" name="CHDEHIJD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-67 Valid Values for metadata-source.send-refresh-command</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for metadata-source.send-refresh-command" summary="This table describes the valid values for the metadata-source.send-refresh-command persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t74"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t74"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t74" headers="r1c1-t74">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t74 r1c2-t74">
<p>(Default) To propogate refresh commands to the cluster, you must configure RCM and use the <code>eclipselink.<a href="#delayonstartup">deploy-on-startup</a></code> property.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t74" headers="r1c1-t74">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t74 r1c2-t74">
<p>Does not propagate refresh commands to the cluster.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1058" name="sthref1058"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>If cache coordination is configured and the session is deployed on startup, this property controls the sending of RCM refresh metadata commands to the cluster.</p>
<p>These commands will cause the remote instances to refresh their metadata.</p>
<a id="sthref1059" name="sthref1059"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDIACJI">Example 5-77</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDIACJI" name="CHDIACJI"></a><a id="TLJPA54165" name="TLJPA54165"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-77 Using metadata-source.send-refresh-command in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.metadata-source-refresh-command" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGHCBE">Example 5-78</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDGHCBE" name="CHDGHCBE"></a><a id="TLJPA54166" name="TLJPA54166"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-78 Using metadata-source-refresh-command in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.METADATA_SOURCE_RCM_COMMAND, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1060" name="sthref1060"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDJDEDE">"metadata-source"</a></p>
</li>
<li>
<p><a href="#delayonstartup">"deploy-on-startup"</a></p>
</li>
<li>
<p>Metadata Source Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/">http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/</a></code></p>
</li>
<li>
<p>"Using an External Metadata Source" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDDJHIC" name="CHDDJHIC"></a><a id="TLJPA1103" name="TLJPA1103"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">metadata-source.xml.file</font></h2>
<p>Use the <code>eclipselink.metadata-repository.xml.file</code> property to specify the name of the metadata repository XML file to read from, using the classloader to find the resource.</p>
<a id="sthref1061" name="sthref1061"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDIEJAA">Table 5-68</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1104" name="TLJPA1104"></a><a id="sthref1062" name="sthref1062"></a><a id="CHDIEJAA" name="CHDIEJAA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-68 Valid Values for metadata-source.xml.file</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for metadata-source.xml.file" summary="This table describes the valid values for the metadata-source.xml.file persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t75"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t75"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t75" headers="r1c1-t75">
<p>filename</p>
</td>
<td align="left" headers="r2c1-t75 r1c2-t75">
<p>Metadata <code>repository.xml</code> file.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1063" name="sthref1063"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property with the <code>eclipselink.<a href="#CHDJDEDE">metadata-source</a></code> property when using an XML repository.</p>
<a id="sthref1064" name="sthref1064"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJJCDD">Example 5-79</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJJCDD" name="CHDJJCDD"></a><a id="TLJPA54167" name="TLJPA54167"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-79 Using metadata-source.xml.file in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.metadata-source" value="xml"/&gt;
&lt;property name="eclipselink.metadata-source.xml.file" value="c:/myfile.xml"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1065" name="sthref1065"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDJDEDE">"metadata-source"</a></p>
</li>
<li>
<p>Metadata Source Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/">http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/</a></code></p>
</li>
<li>
<p>"Using an External Metadata Source" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDBFJEB" name="CHDBFJEB"></a><a id="TLJPA1105" name="TLJPA1105"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">metadata-source.xml.url</font></h2>
<p>Use the <code>eclipselink.metadata-source.xml.url</code> property to specify the location of an external mapping file.</p>
<a id="sthref1066" name="sthref1066"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDEGJAI">Table 5-69</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1106" name="TLJPA1106"></a><a id="sthref1067" name="sthref1067"></a><a id="CHDEGJAI" name="CHDEGJAI"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-69 Valid Values for metadata-source.xml.url</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for metadata-source.xml.url" summary="This table describes the valid values for the metadata-source.xml.url persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t76"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t76"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t76" headers="r1c1-t76">
<p>url</p>
</td>
<td align="left" headers="r2c1-t76 r1c2-t76">
<p>Specifies the metadata repository of the XML URL.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1068" name="sthref1068"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The <code><a href="#CHDJDEDE">metadata-source</a></code> property must be set to XML.</p>
<a id="sthref1069" name="sthref1069"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDIJADD">Example 5-75</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJAHHH" name="CHDJAHHH"></a><a id="TLJPA54168" name="TLJPA54168"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-80 Using metadata-source.xml.url in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.metadata-source" value="xml"/&gt;
&lt;property name="eclipselink.metadata-source.xml.url" value="http://myfile.xml"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1070" name="sthref1070"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDJDEDE">"metadata-source"</a></p>
</li>
<li>
<p>Metadata Source Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/">http://wiki.eclipse.org/EclipseLink/Examples/JPA/MetadataSource/</a></code></p>
</li>
<li>
<p>"Using an External Metadata Source" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="TLJPA978" name="TLJPA978"></a>
<hr />
<div class="refsect1"><a id="sthref1071" name="sthref1071"></a>
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">multitenant.tenants-share-cache</font></h2>
<p>Use the <code>eclipselink.multitenant.tenants-share-cache</code> property to specify if multitenant entities will share the L2 cache.</p>
<a id="sthref1072" name="sthref1072"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CBAGIIID">Table 5-70</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA979" name="TLJPA979"></a><a id="sthref1073" name="sthref1073"></a><a id="CBAGIIID" name="CBAGIIID"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-70 Valid Values for multitenant.tenants-share-cache</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for multitenant.tenants-share-cache" summary="This table describes the valid values for the multitenant.tenants-share-cache persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t77"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t77"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t77" headers="r1c1-t77">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t77 r1c2-t77">
<p>Multitenant entities will use an protected cache.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t77" headers="r1c1-t77">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t77 r1c2-t77">
<p>(Default) Multitenant entities will use an isolated cache.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1074" name="sthref1074"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<div align="center">
<div class="inftblnotewarn"><br />
<table class="NoteWarn oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p><font face="arial, helvetica, sans-serif"><strong>WARNING:</strong></font></p>
<p><strong>When this setting is <code>false</code>, queries that use the cache may return data from other tenants when using the <code>PROTECTED</code> setting.</strong></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnotewarn" --></div>
<a id="sthref1075" name="sthref1075"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDABAB">Example 5-81</a>shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDABAB" name="CHDDABAB"></a><a id="TLJPA980" name="TLJPA980"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-81 Using multitenant.tenants-share-cache in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.multitenant.tenants-share-cache" value="true" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDFHAJJ">Example 5-82</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDFHAJJ" name="CHDFHAJJ"></a><a id="TLJPA981" name="TLJPA981"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-82 Using multitenant.tenants-share-cache in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.MULTITENANT_TENANTS_SHARE_CACHE,
"true");
</pre></div>
<!-- class="example" -->
<a id="sthref1076" name="sthref1076"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#BABIEJGD">"@Multitenant"</a></p>
</li>
<li>
<p>Multitenant examples: <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Multitenant">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Multitenant</a></code></p>
</li>
<li>
<p>"Using Multitenancy" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="TLJPA982" name="TLJPA982"></a>
<hr />
<div class="refsect1"><a id="sthref1077" name="sthref1077"></a>
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">multitenant.tenants-share-emf</font></h2>
<p>Use the <code>eclipselink.multitenant.shared-emf</code> property to specify if multitenant entities will be used within a shared entity manager factory.</p>
<a id="sthref1078" name="sthref1078"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CACBHJCF">Table 5-71</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA983" name="TLJPA983"></a><a id="sthref1079" name="sthref1079"></a><a id="CACBHJCF" name="CACBHJCF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-71 Valid Values for multitenant.tenants-share-emf</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for multitenant.tenants-share-emf" summary="This table describes the valid values for the multitenant.tenants-share-emt persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t79"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t79"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t79" headers="r1c1-t79">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t79 r1c2-t79">
<p>(Default) Multitenant entities will be used.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t79" headers="r1c1-t79">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t79 r1c2-t79">
<p>Specify a unique session name.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1080" name="sthref1080"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>When setting it to <code>false</code>, you are required to provide a unique session name.</p>
<a id="sthref1081" name="sthref1081"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDEGDAH">Example 5-83</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDEGDAH" name="CHDEGDAH"></a><a id="TLJPA984" name="TLJPA984"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-83 Using multitenant.tenants-share-emf in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink_multitenant_tenants_share_emf" value="true" /&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1082" name="sthref1082"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#BABIEJGD">"@Multitenant"</a></p>
</li>
<li>
<p>Multitenant examples: <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Multitenant">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Multitenant</a></code></p>
</li>
<li>
<p>"Using Multitenancy" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BGBEDEJC" name="BGBEDEJC"></a><a id="TLJPA986" name="TLJPA986"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">nosql.connection-factory</font></h2>
<p>Use the <code>eclipselink.nosql.connection-factory</code> property to specify the JNDI name of a JCA <code>ConnectionFactory</code> or a JCA <code>ConnectionFactory</code> class name that connects to the NoSQL data-source.</p>
<a id="sthref1083" name="sthref1083"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BGBCBBFD">Table 5-72</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA987" name="TLJPA987"></a><a id="sthref1084" name="sthref1084"></a><a id="BGBCBBFD" name="BGBCBBFD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-72 Valid Values for nosql.connection-factory</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for nosql.connection-factory" summary="This table describes the valid values for the nosql.connection-factory persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t80"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t80"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t80" headers="r1c1-t80">
<p>connection factory</p>
</td>
<td align="left" headers="r2c1-t80 r1c2-t80">
<p>JNDI name or class name of the JCA Connection Factory.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1085" name="sthref1085"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This property allows the JCA <code>ConnectionFactory</code> to be used with a NoSql or EIS adapter for a NoSQL datasource (that is, a non-relationship datasource such as a legacy database, NoSQL database, XML database, transactional and messaging systems, or ERP systems).</p>
<a id="sthref1086" name="sthref1086"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJJDGE">Example 5-84</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJJDGE" name="CHDJJDGE"></a><a id="TLJPA988" name="TLJPA988"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-84 Using nosql.connection-factory in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.nosql.connection-factory"
value="MyConnectionFactory" /&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1087" name="sthref1087"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#BJEIEBHC">"@NoSql"</a></p>
</li>
<li>
<p><a href="#BABJAJAI">"nosql.property"</a></p>
</li>
<li>
<p>NoSQL Persistence Units <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/NoSQL/Persistence_Units">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/NoSQL/Persistence_Units</a></code></p>
</li>
<li>
<p>Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/NoSQL">http://wiki.eclipse.org/EclipseLink/Examples/JPA/NoSQL</a></code></p>
</li>
<li>
<p>"Using NoSQL Databases" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Using EclipseLink with Nonrelational Databases" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BCGEBECD" name="BCGEBECD"></a><a id="TLJPA990" name="TLJPA990"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">nosql.connection-spec</font></h2>
<p>Use the <code>eclipselink.nosql.connection-spec</code> property to specify an <code>EISConnectionSpec</code> class name that defines how to connect to the NoSQL datasource.</p>
<a id="sthref1088" name="sthref1088"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CBAEAHAF">Table 5-73</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA991" name="TLJPA991"></a><a id="sthref1089" name="sthref1089"></a><a id="CBAEAHAF" name="CBAEAHAF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-73 Valid Values for nosql.connection-spec</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for nosql.connection-spec" summary="This table describes the valid values for the nosql.connection-spec persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t81"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t81"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t81" headers="r1c1-t81">
<p>classname</p>
</td>
<td align="left" headers="r2c1-t81 r1c2-t81">
<p><code>IESConnectionSpec</code> classname</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1090" name="sthref1090"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This property allows the JCA ConnectionFactory to be used with a NoSql or EIS adapter for a NoSQL datasource (that is, a non-relationship datasource such as a legacy database, NoSQL database, XML database, transactional and messaging systems, or ERP systems).</p>
<a id="sthref1091" name="sthref1091"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p>See <a href="#BABHDHCG">Example 5-85</a> for information on how to use this property.</p>
<a id="sthref1092" name="sthref1092"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#BJEIEBHC">"@NoSql"</a></p>
</li>
<li>
<p><a href="#BABJAJAI">"nosql.property"</a></p>
</li>
<li>
<p>NoSQL Persistence Units <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/NoSQL/Persistence_Units">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/NoSQL/Persistence_Units</a></code></p>
</li>
<li>
<p>Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/NoSQL">http://wiki.eclipse.org/EclipseLink/Examples/JPA/NoSQL</a></code></p>
</li>
<li>
<p>"Using NoSQL Databases" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Using EclipseLink with Nonrelational Databases" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABJAJAI" name="BABJAJAI"></a><a id="TLJPA1107" name="TLJPA1107"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">nosql.property</font></h2>
<p>Use the <code>eclipselink.nosql.property</code> property to set NoSQL-specific connection properties.</p>
<a id="sthref1093" name="sthref1093"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABDCBBE">Table 5-74</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1108" name="TLJPA1108"></a><a id="sthref1094" name="sthref1094"></a><a id="BABDCBBE" name="BABDCBBE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-74 Valid Values for nosql.property</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for nosql.property" summary="This table describes the valid values for the nosql.property persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t82"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t82"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t82" headers="r1c1-t82">
<p>property name</p>
</td>
<td align="left" headers="r2c1-t82 r1c2-t82">
<p>A NoSQL property.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1095" name="sthref1095"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Append the NoSQL-specific property name to this property.</p>
<a id="sthref1096" name="sthref1096"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABHDHCG">Example 5-85</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABHDHCG" name="BABHDHCG"></a><a id="TLJPA992" name="TLJPA992"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-85 Using nosql.property in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;persistence xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/persistence persistence_2_0.xsd"
version="2.0"&gt;
&lt;persistence-unit name="acme" transaction-type="RESOURCE_LOCAL"&gt;
&lt;provider&gt;org.eclipse.persistence.jpa.PersistenceProvider&lt;/provider&gt;
&lt;exclude-unlisted-classes&gt;false&lt;/exclude-unlisted-classes&gt;
&lt;properties&gt;
&lt;property name="eclipselink.target-database"
value="org.eclipse.persistence.nosql.adapters.mongo.MongoPlatform"/&gt;
&lt;property name="eclipselink.nosql.connection-spec"
value="org.eclipse.persistence.nosql.adapters.mongo.MongoConnectionSpec"/&gt;
&lt;property name="<strong>eclipselink.nosql.property</strong>.mongo.port" value="27017,
27017"/&gt;
&lt;property name="<strong>eclipselink.nosql.property</strong>.mongo.host" value="host1,
host2"/&gt;
&lt;property name="<strong>eclipselink.nosql.property</strong>.mongo.db" value="acme"/&gt;
&lt;/properties&gt;
&lt;/persistence-unit&gt;
&lt;/persistence&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1097" name="sthref1097"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#BJEIEBHC">"@NoSql"</a></p>
</li>
<li>
<p>"Using Non-SQL Databases" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>NoSQL Persistence Units <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/NoSQL/Persistence_Units">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Advanced_JPA_Development/NoSQL/Persistence_Units</a></code></p>
</li>
<li>
<p>Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/NoSQL">http://wiki.eclipse.org/EclipseLink/Examples/JPA/NoSQL</a></code></p>
</li>
<li>
<p><a href="#BGBEDEJC">"nosql.connection-factory"</a></p>
</li>
<li>
<p><a href="#BCGEBECD">"nosql.connection-spec"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CDEFJEGI" name="CDEFJEGI"></a><a id="TLJPA1109" name="TLJPA1109"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">oracle.proxy-type</font></h2>
<p>Use the <code>eclipselink.oracle.proxy-type</code> property to specify the proxy type to be passed to the <code>OracleConnection.openProxySession</code> method.</p>
<a id="sthref1098" name="sthref1098"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CDEIGGEJ">Table 5-75</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1110" name="TLJPA1110"></a><a id="sthref1099" name="sthref1099"></a><a id="CDEIGGEJ" name="CDEIGGEJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-75 Valid Values for oracle.proxy-type</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for oracle.proxy-type" summary="This table describes the valid values for the oracle.proxy-type persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t83"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t83"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t83" headers="r1c1-t83">
<p><code>USER_NAME</code></p>
</td>
<td align="left" headers="r2c1-t83 r1c2-t83">
<p>This type uses a user name for authentication when creating a proxy connection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t83" headers="r1c1-t83">
<p><code>DISTINGUISED_NAME</code></p>
</td>
<td align="left" headers="r3c1-t83 r1c2-t83">
<p>This type uses a distinguished name for authentication when creating a proxy connection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t83" headers="r1c1-t83">
<p><code>CERTIFICATE</code></p>
</td>
<td align="left" headers="r4c1-t83 r1c2-t83">
<p>This type uses a digital certificate for authentication when creating a proxy connection.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1100" name="sthref1100"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This property requires Oracle JDBC version 10.1.0.2 or later and <code>eclipselink.<a href="#target-database">target-database</a></code> must be configured to use <code>Oracle9</code> or later.</p>
<p>Typically, you should set this property into <code>EntityManager</code>, through a <code>createEntityManager</code> method or by using proprietary <code>setProperties</code> method on <code>EntityManagerImpl</code>. This causes <code>EntityManager</code> to use proxy connection for writing and reading inside transaction.</p>
<p>If <code>proxy-type</code> and the corresponding <code>proxy</code> property set into <code>EntityManagerFactory</code>, all connections created by the factory will be proxy connections.</p>
<a id="sthref1101" name="sthref1101"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDCIFJ">Example 5-86</a> shows how to use the property with <code>EntityManager</code>.</p>
<div class="example"><a id="CHDDCIFJ" name="CHDDCIFJ"></a><a id="TLJPA993" name="TLJPA993"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-86 Using eclipselink.oracle.proxy-type with EntityManager</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
Map emProperties = new HashMap();
emProperties.put("eclipselink.oracle.proxy-type",
OracleConnection.PROXYTYPE_USER_NAME);
emProperties.put(OracleConnection.PROXY_USER_NAME, "john");
EntityManager em = emf.createEntityManager(emProperties);
</pre>
<p>With injection:</p>
<pre xml:space="preserve" class="oac_no_warn">
entityManager.setProperty(&rdquo;eclipselink.oracle.proxy-type&rdquo;,
OracleConnection.PROXYTYPE_USER_NAME);
entityManager.setProperty(OracleConnection.PROXY_USER_NAME, &rdquo;john&rdquo;);
</pre></div>
<!-- class="example" -->
<a id="sthref1102" name="sthref1102"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#target-database">"target-database"</a></p>
</li>
<li>
<p>Oracle Proxy Authentication Example <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Oracle/Proxy">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Oracle/Proxy</a></code></p>
</li>
<li>
<p>Auditing example <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Auditing">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Auditing</a></code></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="orm.throw.exceptions" name="orm.throw.exceptions"></a><a id="TLJPA1111" name="TLJPA1111"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">orm.throw.exceptions</font></h2>
<p>Use the <code>eclipselink.orm.throw.exceptions</code> property to specify if EclipseLink throws an exception or logs a warning when encountering a problem with any of the files in the <code>&lt;mapping-file&gt;</code> element of the <code>persistence.xml</code> file.</p>
<a id="sthref1103" name="sthref1103"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHCJBFB">Table 5-76</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1112" name="TLJPA1112"></a><a id="sthref1104" name="sthref1104"></a><a id="CIHCJBFB" name="CIHCJBFB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-76 Valid Values for orm.throw.exceptions</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for orm.throw.exceptions" summary="This table describes the valid values for the orm.throw.exceptions persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t84"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t84"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t84" headers="r1c1-t84">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t84 r1c2-t84">
<p>(Default) Throw an exception.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t84" headers="r1c1-t84">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t84 r1c2-t84">
<p>Log a warning only.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1105" name="sthref1105"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CIHCCAJE">Example 5-87</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CIHCCAJE" name="CIHCCAJE"></a><a id="TLJPA1113" name="TLJPA1113"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-87 Using orm.throw.exceptions in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="oracle.orm.throw.exceptions" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CIHEIECA">Example 5-88</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CIHEIECA" name="CIHEIECA"></a><a id="TLJPA1114" name="TLJPA1114"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-88 Using orm.throw.exceptions in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.ECLIPSELINK_ORM_THROW_EXCEPTIONS,
"false");
</pre></div>
<!-- class="example" -->
<a id="sthref1106" name="sthref1106"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CCHCJCDJ">"exception-handler"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDIFJDB" name="CHDIFJDB"></a><a id="TLJPA994" name="TLJPA994"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">orm.validate.schema</font></h2>
<p>Use the <code>orm.validate.schema</code> property to override <code>orm.xml</code> schema validation from its default value of <code>false</code>.</p>
<a id="sthref1107" name="sthref1107"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDIEGGI">Table 5-77</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA995" name="TLJPA995"></a><a id="sthref1108" name="sthref1108"></a><a id="CHDIEGGI" name="CHDIEGGI"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-77 Valid Values for orm.validate.schema</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for orm.validate.schema" summary="This table describes the valid values for the orm.validate.schema persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t85"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t85"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t85" headers="r1c1-t85">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t85 r1c2-t85">
<p>Enables schema velidation on on <code>orm.xml</code> file.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t85" headers="r1c1-t85">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t85 r1c2-t85">
<p>(Default) No schema validation is performed on the <code>orm.xml</code> file.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1109" name="sthref1109"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use <code>orm.validate.schema</code> to enable <code>orm.xml schema</code> validation.</p>
<a id="sthref1110" name="sthref1110"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBCEAB">Example 5-89</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBCEAB" name="CHDBCEAB"></a><a id="TLJPA996" name="TLJPA996"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-89 Using orm.validate.schema in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.orm.validate.schema" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHAJDD">Example 5-90</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHAJDD" name="CHDHAJDD"></a><a id="TLJPA997" name="TLJPA997"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-90 Using orm.validate.schema in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.ORM_VALIDATE_SCHEMA, "true");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="partitioning" name="partitioning"></a><a id="TLJPA1115" name="TLJPA1115"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">partitioning</font></h2>
<p>Use the <code>eclipselink.partitioning</code> property to set the default <code>PartitioningPolicy</code> for a persistence unit. The value must be the name of an existing, defined <code>PartitioningPolicy</code>.</p>
<a id="sthref1111" name="sthref1111"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CEGBHDDC">Table 5-78</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1116" name="TLJPA1116"></a><a id="sthref1112" name="sthref1112"></a><a id="CEGBHDDC" name="CEGBHDDC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-78 Valid Values for partitioning</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for partitioning" summary="This table describes the valid values for the partitioning persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t86"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t86"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t86" headers="r1c1-t86">
<p>name</p>
</td>
<td align="left" headers="r2c1-t86 r1c2-t86">
<p>An existing, defined <code>PartitioningPolicy</code>.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1113" name="sthref1113"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use this property to partition data for a class across multiple difference databases or across a database cluster such as Oracle RAC. Partitioning may provide improved scalability by allowing multiple database machines to service requests.</p>
<p>If multiple partitions are used to process a single transaction, use JTA (Java Transcription API) for proper XA transaction support.</p>
<a id="sthref1114" name="sthref1114"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJFIJA">Example 5-91</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJFIJA" name="CHDJFIJA"></a><a id="TLJPA998" name="TLJPA998"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-91 Using partitioning in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.partitioning" value="Replicate" /&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1115" name="sthref1115"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>Partitioning Examples <code><a href="http://wiki.eclipse.org/EclipseLink/Examples/JPA/Partitioning">http://wiki.eclipse.org/EclipseLink/Examples/JPA/Partitioning</a></code></p>
</li>
<li>
<p><a href="annotations_ref.htm#CEGDCFDA">"@Partitioning"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BJFEFCFC" name="BJFEFCFC"></a><a id="TLJPA999" name="TLJPA999"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">partitioning.callback</font></h2>
<p>Use the <code>eclipselink.partitioning.callback</code> property to integrate an external DataSource's affinity support, such as UCP.</p>
<a id="sthref1116" name="sthref1116"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BJFFDAAH">Table 5-79</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1000" name="TLJPA1000"></a><a id="sthref1117" name="sthref1117"></a><a id="BJFFDAAH" name="BJFFDAAH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-79 Valid Values for eclipselink.partitioning.callback</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for eclipselink.partitioning.callback" summary="This table describes the valid values for the eclipselink.partitioning.callback persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t87"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t87"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t87" headers="r1c1-t87">
<p>value</p>
</td>
<td align="left" headers="r2c1-t87 r1c2-t87">
<p>A class that implements the <code>DataPartitioningCallBack</code> interface.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1118" name="sthref1118"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The value must be set to the full class name.</p>
<a id="sthref1119" name="sthref1119"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFEFBF">Example 5-92</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDFEFBF" name="CHDFEFBF"></a><a id="TLJPA1001" name="TLJPA1001"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-92 Using partitioning.callback in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.partitioning.callback"
value="mypacakge.MyDataPartitioningCallback"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDCEHEE">Example 5-93</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDCEHEE" name="CHDCEHEE"></a><a id="TLJPA1002" name="TLJPA1002"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-93 Using partitioning.callback in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.PARTITIONING_CALLBACK,
"mypackage.MyDataPartitioningCallback");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="BABDGGHE" name="BABDGGHE"></a><a id="TLJPA1117" name="TLJPA1117"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistence-context.close-on-commit</font></h2>
<p>Use the <code>eclipselink.persistence-context.close-on-commit</code> property to specify if the <code>EntityManager</code> will be closed or not used after commit (not extended).</p>
<a id="sthref1120" name="sthref1120"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABGIHIC">Table 5-80</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1118" name="TLJPA1118"></a><a id="sthref1121" name="sthref1121"></a><a id="BABGIHIC" name="BABGIHIC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-80 Valid Values for persistence-context.close-on-commit</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistence-context.close-on-commit" summary="This table describes the valid values for the persistence-context.close-on-commit persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t88"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t88"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t88" headers="r1c1-t88">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t88 r1c2-t88">
<p>Closes the EntityManager after a commit.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t88" headers="r1c1-t88">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t88 r1c2-t88">
<p>(Default) Does not close the EntityManager after a commit.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1122" name="sthref1122"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>For a container-managed <code>EntityManager</code> and most managed applications, you normally set this property to <code>false</code>. This setting avoids additional performance overhead of resuming the persistence context after a <code>commit()</code> transaction.</p>
<p>The property set in <code>persistence.xml</code> or passed to <code>createEntityManagerFactory</code> affects <em>all</em> <code>EntityManagers</code> created by the factory. Alternatively, to apply the property to <em>specific</em> <code>EntityManagers</code>, pass it to <code>createEntityManager</code> method.</p>
<a id="sthref1123" name="sthref1123"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDIBADB">Example 5-94</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDIBADB" name="CHDIBADB"></a><a id="TLJPA54169" name="TLJPA54169"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-94 Using persistence-context.close-on-commit in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.persistence-context.close-on-commit" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGGCCD">Example 5-95</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDGGCCD" name="CHDGGCCD"></a><a id="TLJPA54170" name="TLJPA54170"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-95 Using persistence-context.close-on-commit in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.PERSISTENCE_CONTEXT_CLOSE_ON_COMMIT,
"true");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="BABCHJJA" name="BABCHJJA"></a><a id="TLJPA1003" name="TLJPA1003"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistence-context.commit-without-persist-rules</font></h2>
<p>Use the <code>eclipselink.persistence-context.commit-without-persist-rules</code> property to specify if the EntityManager will search all managed objects and persist any related non-managed new objects that are found, ignoring any absence of <code>CascadeType.PERSIST</code> settings.</p>
<a id="sthref1124" name="sthref1124"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABGJGAD">Table 5-81</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1004" name="TLJPA1004"></a><a id="sthref1125" name="sthref1125"></a><a id="BABGJGAD" name="BABGJGAD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-81 Valid Values for persistence-context.commit-without-persist-rules</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistence-context.commit-without-persist-rules" summary="This table describes the valid values for the persistence-context.commit-without-persist-rules persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t89"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t89"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t89" headers="r1c1-t89">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t89 r1c2-t89">
<p>Cascades Entity life-cycle Persist operations to related entities and uses the <code>CascadeType.PERSIST</code> settings.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t89" headers="r1c1-t89">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t89 r1c2-t89">
<p>(Default) Does not cascase Entitiy life-cycle Persist operations to related entities and does not use the <code>CascadeType.PERSIST</code> settings.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1126" name="sthref1126"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Setting this property to <code>true</code> replicates the traditional EclipseLink native functionality.</p>
<a id="sthref1127" name="sthref1127"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDGJCEE">Example 5-96</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDGJCEE" name="CHDGJCEE"></a><a id="TLJPA54171" name="TLJPA54171"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-96 Using persistence-context.commit-without-persist-rules in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipse.persistence-context.commit-without-persist-rules"
value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHHEIH">Example 5-97</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHHEIH" name="CHDHHEIH"></a><a id="TLJPA54172" name="TLJPA54172"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-97 Using persistence-context.commit-without-persist-rules in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(PersistenceUnitProperties.PERSISTENCE_CONTEXT_COMMIT_WITHOUT_PERSIST_RULES,
"true");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="BABDHEEB" name="BABDHEEB"></a><a id="TLJPA1005" name="TLJPA1005"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistence-context.flush-mode</font></h2>
<p>Use the <code>eclipselink.persistence-context.flush-mode</code> property to configure the <code>EntityManager</code> <code>FlushMode</code> to be set as a persistence property and specify when flushing occurs.</p>
<a id="sthref1128" name="sthref1128"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABHDEJC">Table 5-82</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1006" name="TLJPA1006"></a><a id="sthref1129" name="sthref1129"></a><a id="BABHDEJC" name="BABHDEJC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-82 Valid Values for persistence-context.flush-mode</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistence-context.flush-mode" summary="This table describes the valid values for the persistence-context.flush-mode persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t90"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t90"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t90" headers="r1c1-t90">
<p><code>auto</code></p>
</td>
<td align="left" headers="r2c1-t90 r1c2-t90">
<p>(Default) Flushing occurs at query execution.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t90" headers="r1c1-t90">
<p><code>commit</code></p>
</td>
<td align="left" headers="r3c1-t90 r1c2-t90">
<p>Flushing occurs at transaction commit.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1130" name="sthref1130"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The property set in <code>persistence.xml</code> or passed to <code>createEntityManagerFactory</code> affects <em>all</em> <code>EntityManagers</code> created by the factory. To apply the property to <em>specific</em> <code>EntityManagers</code> pass it to the <code>createEntityManager</code> method.</p>
<a id="sthref1131" name="sthref1131"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABJCABF">Example 5-98</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABJCABF" name="BABJCABF"></a><a id="TLJPA1007" name="TLJPA1007"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-98 Using persistence-context.flush-mode in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.persistence-context.flush-mode" value="commit" /&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDJBHIA">Example 5-99</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDJBHIA" name="CHDJBHIA"></a><a id="TLJPA54173" name="TLJPA54173"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-99 Using persistence-context.flush-mode in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.PERSISTENCE_CONTEXT_FLUSH_MODE,
"false");
</pre></div>
<!-- class="example" -->
<a id="sthref1132" name="sthref1132"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="queryhints.htm#CBHFHGEB">"flush"</a></p>
</li>
<li>
<p>"Enhancing Performance" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABGCAGC" name="BABGCAGC"></a><a id="TLJPA1008" name="TLJPA1008"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistence-context.persist-on-commit</font></h2>
<p>Use the <code>eclipselink.persistence-context.persist-on-commit</code> property to specify if the <code>EntityManager</code> searches all managed objects and persists any related non-managed new objects that are cascade persist. This can be used to avoid the cost of performing this search if persist is always used for new objects.</p>
<a id="sthref1133" name="sthref1133"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABHIBEC">Table 5-83</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1009" name="TLJPA1009"></a><a id="sthref1134" name="sthref1134"></a><a id="BABHIBEC" name="BABHIBEC"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-83 Valid Values for persistence-context.persist-on-commit</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistence-context.persist-on-commit" summary="This table describes the valid values for the persistence-context.persist-on-commit persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t91"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t91"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t91" headers="r1c1-t91">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t91 r1c2-t91">
<p>(Default) Searches and persists related non-managed new objects that are cascade persist.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t91" headers="r1c1-t91">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t91 r1c2-t91">
<p>Does not search and persist related non-managed new objects that are cascade persist.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1135" name="sthref1135"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The property set in <code>persistence.xml</code> or passed to <code>createEntityManagerFactory</code> affects <em>all</em> <code>EntityManagers</code> created by the factory. To apply the property to <em>specific</em> <code>EntityManagers</code> pass it to <code>createEntityManager</code> method.</p>
<a id="sthref1136" name="sthref1136"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BEHGGIEC">Example 5-100</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BEHGGIEC" name="BEHGGIEC"></a><a id="TLJPA1010" name="TLJPA1010"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-100 Using persistence-context.persist-on-commit in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.persistence-context.persist-on-commit" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDBGCCA">Example 5-101</a> show how to use this property in a property map.</p>
<div class="example"><a id="CHDBGCCA" name="CHDBGCCA"></a><a id="TLJPA54174" name="TLJPA54174"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-101 Using persistence-context.persis-on-commit in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.PERSISTENCE_CONTEXT_PERSIST_ON_COMMIT,
"false");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="BABIAJAI" name="BABIAJAI"></a><a id="TLJPA1119" name="TLJPA1119"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistence-context.reference-mode</font></h2>
<p>Use the <code>eclipselink.persistence-context.reference-mode</code> property to specify if hard or soft (that is, weak) references are used within the Persistence Context.</p>
<a id="sthref1137" name="sthref1137"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABFGBIF">Table 5-84</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1120" name="TLJPA1120"></a><a id="sthref1138" name="sthref1138"></a><a id="BABFGBIF" name="BABFGBIF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-84 Valid Values for persistence-context.reference-mode</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistence-context.reference-mode" summary="This table describes the valid values for the persistence-context.reference-mode persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t92"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t92"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t92" headers="r1c1-t92">
<p><code>hard</code></p>
</td>
<td align="left" headers="r2c1-t92 r1c2-t92">
<p>(Default) EclipseLink references all objects through hard references. These objects will not be available for garbage collection until the referencing artifact (such as the persistence context or unit of work) is released/cleared or closed.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t92" headers="r1c1-t92">
<p><code>weak</code></p>
</td>
<td align="left" headers="r3c1-t92 r1c2-t92">
<p>References to objects supporting active attribute change tracking (see <a href="annotations_ref.htm#CEGCCCCJ">"@ChangeTracking"</a>) will be held by weak references. That is, any object no longer referenced directly or indirectly will be available for garbage collection. When a change is made to a change-tracked object, that object is moved to a hard reference and will not be available for garbage collection until flushed.</p>
<p><strong>Note</strong>: Any changes that have not been flushed in these entities will be lost.</p>
<p>New and removed objects, as well as objects that do not support active attribute change tracking, will also be held by hard references and will not be available for garbage collection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t92" headers="r1c1-t92">
<p><code>force_weak</code></p>
</td>
<td align="left" headers="r4c1-t92 r1c2-t92">
<p>All objects, including non-change-tracked objects, are to be held by weak references. When a change is made to a change-tracked object (see <a href="annotations_ref.htm#CEGCCCCJ">"@ChangeTracking"</a>), that object is moved to a hard reference and will not be available for garbage collection until flushed. However, any objects that do not support active attribute change tracking may be garbage collected before their changes are flushed to a database, which can potentially result in a loss of changes.</p>
<p>New and removed objects will be held by hard references and will not be available for garbage collection.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1139" name="sthref1139"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The property set in <code>persistence.xml</code> or passed to <code>createEntityManagerFactory</code> affects all <code>EntityManagers</code> created by the factory. To apply the property to specific <code>EntityManagers</code> pass it to <code>createEntityManager</code> method.</p>
<a id="sthref1140" name="sthref1140"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBACII">Example 5-102</a> shows how to use this property in a <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBACII" name="CHDBACII"></a><a id="TLJPA1011" name="TLJPA1011"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-102 Using persistence-context.reference-mode in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.persistence-context.reference-mode"
value="FORCE_WEAK"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDCIDAH">Example 5-103</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDCIDAH" name="CHDCIDAH"></a><a id="TLJPA1012" name="TLJPA1012"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-103 Using persistence-context.reference-mode in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.PERSISTENCE_CONTEXT_REFERENCE_MODE,
ReferenceMode.FORCE_WEAK);
</pre></div>
<!-- class="example" -->
<a id="sthref1141" name="sthref1141"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="annotations_ref.htm#CEGCCCCJ">"@ChangeTracking"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="persistenceunits" name="persistenceunits"></a><a id="TLJPA1121" name="TLJPA1121"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistenceunits</font></h2>
<p>Use the <code>eclipselink.persistenceunits</code> property to specify the set of persistence unit names that will be processed when generating the canonical model. By default, EclipseLink uses all persistence units available in all persistence XML files.</p>
<a id="sthref1142" name="sthref1142"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABDEJGG">Table 5-85</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1122" name="TLJPA1122"></a><a id="sthref1143" name="sthref1143"></a><a id="BABDEJGG" name="BABDEJGG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-85 Valid Values for persistenceunits</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistenceunits" summary="This table describes the valid values for the persistenceunits persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t93"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t93"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t93" headers="r1c1-t93">
<p>names</p>
</td>
<td align="left" headers="r2c1-t93 r1c2-t93">
<p>A comma separated list of persistence units</p>
<p><strong>Note</strong>: When specifying multiple persistence units, you <em>cannot</em> include a comma (&nbsp;,&nbsp;) in the name of a persistence unit.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1144" name="sthref1144"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDAJDH">Example 5-104</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDDAJDH" name="CHDDAJDH"></a><a id="TLJPA54182" name="TLJPA54182"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-104 Using persistenceunits in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.persistenceunits" value="mypu1, mypu2"/&gt;
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="persistencexml" name="persistencexml"></a><a id="TLJPA1123" name="TLJPA1123"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persistencexml</font></h2>
<p>Use the <code>eclipselink.persistencexml</code> property to specify the full resource name in which to look for the persistence XML files. If omitted, EclipseLink uses the default location: <code>META-INF/persistence.xml</code>.</p>
<div align="center">
<div class="inftblnote"><br />
<table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<tbody>
<tr>
<td align="left">
<p class="note"><img src="../../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p>
<p>Currently, this property is used only for the canonical model generator.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblnote" --></div>
<a id="sthref1145" name="sthref1145"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BEIGADGB">Table 5-86</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1124" name="TLJPA1124"></a><a id="sthref1146" name="sthref1146"></a><a id="BEIGADGB" name="BEIGADGB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-86 Valid Values for persistencexml</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for persistencexml" summary="This table describes the valid values for the persistencexml persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t95"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t95"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t95" headers="r1c1-t95">
<p>resource name</p>
</td>
<td align="left" headers="r2c1-t95 r1c2-t95">
<p>Location of the <code>persistence.xml</code> file.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1147" name="sthref1147"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This property is only used by EclipseLink when it is locating the configuration file. When used within an EJB/Spring container in container-managed mode, the locating and reading of this file is done by the container and will not use this configuration.</p>
<p>If you want to change the default location, use <code><a href="#CHDEGCBC">persisencexml.default</a></code>.</p>
<a id="sthref1148" name="sthref1148"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCHHEB">Example 5-105</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDCHHEB" name="CHDCHHEB"></a><a id="TLJPA54183" name="TLJPA54183"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-105 Using persistencexml in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.persistencexml" value="resources/persistence.xml"/&gt;
</pre></div>
<!-- class="example" -->
<a id="sthref1149" name="sthref1149"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#CHDEGCBC">"persisencexml.default"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDEGCBC" name="CHDEGCBC"></a><a id="TLJPA54184" name="TLJPA54184"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">persisencexml.default</font></h2>
<p>Use the <code>eclipselink.persistencexml.default</code> property to specify the default resource location where the <code>persistence.xml</code> configuration file is located. The default location is <code>META-INF/persistence.xml</code>.</p>
<a id="sthref1150" name="sthref1150"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDDBHGH">Table 5-87</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54185" name="TLJPA54185"></a><a id="sthref1151" name="sthref1151"></a><a id="CHDDBHGH" name="CHDDBHGH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-87 Valid Values for persistencexml.default</font></em></strong></p>
<table class="FormalWide" title="Valid Values for persistencexml.default" summary="This table describes the valid values for the persistencexml.default persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t96"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t96"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t96" headers="r1c1-t96">
<p>resource location</p>
</td>
<td align="left" headers="r2c1-t96 r1c2-t96">
<p>Default resource location of the <code>persistence.xml</code> file.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1152" name="sthref1152"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDDHADB">Example 5-106</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDDHADB" name="CHDDHADB"></a><a id="TLJPA54186" name="TLJPA54186"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-106 Using persistencexml.default in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.ECLIPSELINK_PERSISTENCE_XML_DEFAULT,
"resources/persistence.xml");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="profiler" name="profiler"></a><a id="TLJPA1125" name="TLJPA1125"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">profiler</font></h2>
<p>Use the <code>eclipselink.profiler</code> property to specify which performance profiler to use in order to capture runtime statistics.</p>
<a id="sthref1153" name="sthref1153"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDBECBD">Table 5-88</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1126" name="TLJPA1126"></a><a id="sthref1154" name="sthref1154"></a><a id="CHDBECBD" name="CHDBECBD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-88 Valid Values for profiler</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for profiler" summary="This table describes the valid values for the profiler persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="26%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t97"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t97"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t97" headers="r1c1-t97">
<p><code>NoProfiler</code></p>
</td>
<td align="left" headers="r2c1-t97 r1c2-t97">
<p>(Default) Do not use a performance profiler.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t97" headers="r1c1-t97">
<p><code>PerformationMonitor</code></p>
</td>
<td align="left" headers="r3c1-t97 r1c2-t97">
<p>Use EclipseLink performance monitor <code>org.eclipse.persistence.tools.profiler.PerformanceMonitor</code>.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t97" headers="r1c1-t97">
<p><code>PerformanceProfiler</code></p>
</td>
<td align="left" headers="r4c1-t97 r1c2-t97">
<p>Use EclipseLink performance profiler (<code>org.eclipse.persistence.tools.profiler.PerformanceProfiler</code>).</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t97" headers="r1c1-t97">
<p><code>QueryMonitor</code></p>
</td>
<td align="left" headers="r5c1-t97 r1c2-t97">
<p>Monitor query executions and cache hits (<code>org.eclipse.persistence.tools.profiler.QueryMonitor</code> class).</p>
<p>This option provides a simple low-overhead means for measuring performance of query executions and cache hits. You may want to use this option for performance analysis in a complex system.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t97" headers="r1c1-t97">
<p><code>DMSProfiler</code></p>
</td>
<td align="left" headers="r6c1-t97 r1c2-t97">
<p>Use <code>org.eclipse.persistence.tools.profiler.oracle.DMSPerformanceProfiler</code>. This property is specific to the Oracle Dynamic Monitoring Service (DMS).</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t97" headers="r1c1-t97">
<p>Custom profiler</p>
</td>
<td align="left" headers="r7c1-t97 r1c2-t97">
<p>Specify a custom profiler class name which implements <code>SessionProfiler</code> and provides a no-argument constructor.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1155" name="sthref1155"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDBCCED">Example 5-107</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDBCCED" name="CHDBCCED"></a><a id="TLJPA1013" name="TLJPA1013"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-107 Using profiler in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.profiler" value="PerformanceProfiler"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDJFBDI">Example 5-108</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDJFBDI" name="CHDJFBDI"></a><a id="TLJPA1014" name="TLJPA1014"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-108 Using profiler in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.ProfilerType;
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.PROFILER,
ProfilerType.PerformanceProfiler);
</pre></div>
<!-- class="example" -->
<a id="sthref1156" name="sthref1156"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
</div>
<!-- class="refsect1" -->
<a id="session.customizer" name="session.customizer"></a><a id="TLJPA1127" name="TLJPA1127"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">session.customizer</font></h2>
<p>Use the <code>eclipselink.session.customizer</code> property to specify a session customizer class that implements the <code>org.eclipse.persistence.config.SessionCustomizer</code> interface. The class must provide a default, no argument constructor.</p>
<a id="sthref1157" name="sthref1157"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDGBEFG">Table 5-89</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1128" name="TLJPA1128"></a><a id="sthref1158" name="sthref1158"></a><a id="CHDGBEFG" name="CHDGBEFG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-89 Valid Values for session.customizer</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for session.customizer" summary="This table describes the valid values for the session.customizer persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t98"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t98"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t98" headers="r1c1-t98">
<p>class name</p>
</td>
<td align="left" headers="r2c1-t98 r1c2-t98">
<p>Fully qualified class name of a <code>SessionCustomizer</code> class.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1159" name="sthref1159"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use the customize method of the class (which takes an <code>org.eclipse.persistence.sessions.Session</code>) to programmatically access advanced EclipseLink session API. You can use the session customizer class to define multiple session event listeners.</p>
<a id="sthref1160" name="sthref1160"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFBIEI">Example 5-109</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDFBIEI" name="CHDFBIEI"></a><a id="TLJPA1015" name="TLJPA1015"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-109 Using session.customizer in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.session.customizer"
value="acme.sessions.MySessionCustomizer"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDJEDJG">Example 5-110</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDJEDJG" name="CHDJEDJG"></a><a id="TLJPA1016" name="TLJPA1016"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-110 Using session.customizer in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.SESSION_CUSTOMIZER,
"acme.sessions.MySessionCustomizer");
</pre></div>
<!-- class="example" -->
<a id="sthref1161" name="sthref1161"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#session-event-listener">"session-event-listener"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDFDJJD" name="CHDFDJJD"></a><a id="TLJPA1017" name="TLJPA1017"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">session.include.descriptor.queries</font></h2>
<p>Use the <code>eclipselink.session.include.descriptor.queries</code> property to specify whether all descriptor named queries are copied to the session for use by the entity manager.</p>
<a id="sthref1162" name="sthref1162"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDDEADH">Table 5-90</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1018" name="TLJPA1018"></a><a id="sthref1163" name="sthref1163"></a><a id="CHDDEADH" name="CHDDEADH"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-90 Valid Values for session.include.descriptor.queries</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for session.include.descriptor.queries" summary="This table describes the valid values for the session.include.descriptor.queries persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t99"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t99"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t99" headers="r1c1-t99">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t99 r1c2-t99">
<p>Copying is enabled.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t99" headers="r1c1-t99">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t99 r1c2-t99">
<p>(Default) Copying is disabled.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1164" name="sthref1164"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABGAFHH">Example 5-111</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABGAFHH" name="BABGAFHH"></a><a id="TLJPA1019" name="TLJPA1019"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-111 Using session.include.descriptor.queries in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.session.include.descriptor.queries" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABBBGEH">Example 5-112</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BABBBGEH" name="BABBBGEH"></a><a id="TLJPA1020" name="TLJPA1020"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-112 Using session.include.descriptor.queries in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.INCLUDE_DESCRIPTOR_QUERIES, "true");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="session-event-listener" name="session-event-listener"></a><a id="TLJPA1129" name="TLJPA1129"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">session-event-listener</font></h2>
<p>Use the <code>eclipselink.session-event-listener</code> property to specify a descriptor event listener to be added during bootstrapping.</p>
<a id="sthref1165" name="sthref1165"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDGFICG">Table 5-91</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1130" name="TLJPA1130"></a><a id="sthref1166" name="sthref1166"></a><a id="CHDGFICG" name="CHDGFICG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-91 Valid Values for session-event-listener</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for session-event-listener" summary="This table describes the valid values for the session-event-listener persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t100"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t100"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t100" headers="r1c1-t100">
<p>Class name</p>
</td>
<td align="left" headers="r2c1-t100 r1c2-t100">
<p>A qualified class name for a class that implements the <code>org.eclipse.persistence.sessions.SessionEventListener</code> interface.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1167" name="sthref1167"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>To define multiple event listener, you can use a <a href="#session.customizer">session.customizer</a> class.</p>
<a id="sthref1168" name="sthref1168"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJFEIG">Example 5-113</a> shows how to use this property in a <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJFEIG" name="CHDJFEIG"></a><a id="TLJPA1021" name="TLJPA1021"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-113 Using session-event-listener in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.session-event-listener"
value="mypackage.MyClass.class"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDJFEIG">Example 5-113</a> shows how to use this property in a property map.</p>
<div class="example"><a id="TLJPA1022" name="TLJPA1022"></a><a id="sthref1169" name="sthref1169"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-114 Using session-event-listener in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.SESSION_EVENT_LISTENER_CLASS,
"mypackage.MyClass.class");
</pre></div>
<!-- class="example" -->
<a id="sthref1170" name="sthref1170"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#session.customizer">"session.customizer"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDFHEAC" name="CHDFHEAC"></a><a id="TLJPA1023" name="TLJPA1023"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">session-name</font></h2>
<p>Use the <code>eclipselink.session-name</code> property to configure a unique name to use when storing the singleton server session within the <code>SessionManager</code>.</p>
<a id="sthref1171" name="sthref1171"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDECCEJ">Table 5-92</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1024" name="TLJPA1024"></a><a id="sthref1172" name="sthref1172"></a><a id="CHDECCEJ" name="CHDECCEJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-92 Valid Values for session.name</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for session.name" summary="This table describes the valid values for the session.name persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="18%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t101"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t101"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t101" headers="r1c1-t101">
<p>Name</p>
</td>
<td align="left" headers="r2c1-t101 r1c2-t101">
<p>Unique session name to use instead of the default, EclipseLink-generated session name.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1173" name="sthref1173"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>By default, EclipseLink generates a unique session name. You can provide a custom, unique, session name with this property.</p>
<p>When using a <code>sessions-xml</code> file, you must include this session name as the name of the session in the <code>sessions-xml</code> file.</p>
<a id="sthref1174" name="sthref1174"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CACICICG">Example 5-115</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CACICICG" name="CACICICG"></a><a id="TLJPA1025" name="TLJPA1025"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-115 Using session-name in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.session-name" value="MySession"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CACIFIGD">Example 5-116</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CACIFIGD" name="CACIFIGD"></a><a id="TLJPA1026" name="TLJPA1026"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-116 Using session-name in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.SESSION_NAME, "MySession");
</pre></div>
<!-- class="example" -->
<a id="sthref1175" name="sthref1175"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#sessions-xml">"sessions-xml"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="sessions-xml" name="sessions-xml"></a><a id="TLJPA1131" name="TLJPA1131"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">sessions-xml</font></h2>
<p>Use the <code>eclipselink.sessions-xml</code> property to use a specified native <code>sessions.xml</code> configuration file (which references a <code>project.xml</code> file) to load configuration and mapping information instead of JPA annotations or EclipseLink XML (as shown in <a href="#CIHFHAFB">Figure 5-1</a>).</p>
<a id="sthref1176" name="sthref1176"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHCGECF">Table 5-93</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1132" name="TLJPA1132"></a><a id="sthref1177" name="sthref1177"></a><a id="CIHCGECF" name="CIHCGECF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-93 Valid Values for sessions-xml</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for sessions-xml" summary="This table describes the valid values for the sessions-xml persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t102"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t102"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t102" headers="r1c1-t102">
<p>configuration file</p>
</td>
<td align="left" headers="r2c1-t102 r1c2-t102">
<p>The resource name of the sessions XML file. If you do not specify the value for this property, it will not be used.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1178" name="sthref1178"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use the <code>eclipselink.sessions-xml</code> property as an alternative to using annotations and deployment XML. With this property, EclipseLink builds an in-memory EclipseLink session and project based on this metadata (as shown in <a href="#CIHFHAFB">Figure 5-1</a>). You can acquire a persistence manager and use it, having defined all entities and so on using only EclipseLink <code>sessions.xml</code>.</p>
<div class="figure"><a id="CIHFHAFB" name="CIHFHAFB"></a><a id="TLJPA1027" name="TLJPA1027"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Figure 5-1 Using the eclipselink.sessions-xml Persistence Property</font></em></strong></p>
<img src="img/override_tl.gif" alt="Description of Figure 5-1 follows" title="Description of Figure 5-1 follows" longdesc="img_text/override_tl.htm" /><br />
<a id="sthref1179" name="sthref1179" href="img_text/override_tl.htm">Description of "Figure 5-1 Using the eclipselink.sessions-xml Persistence Property"</a><br />
<br /></div>
<!-- class="figure" -->
<a id="sthref1180" name="sthref1180"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CIHGDFAI">Example 5-117</a> shows how to use this property in a <code>persistence.xml</code> file.</p>
<div class="example"><a id="CIHGDFAI" name="CIHGDFAI"></a><a id="TLJPA1028" name="TLJPA1028"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-117 Using sessions-xml in the persistence.xml file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.sessions-xml" value="mysession.xml"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDBBJAJ">Example 5-118</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDBBJAJ" name="CHDBBJAJ"></a><a id="TLJPA1029" name="TLJPA1029"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-118 Using sessions-xml in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.SESSIONS_XML, "mysession.xml");
</pre></div>
<!-- class="example" -->
<a id="sthref1181" name="sthref1181"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="schema.htm#BGBBEIEA">"Overriding and Merging"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="target-database" name="target-database"></a><a id="TLJPA1133" name="TLJPA1133"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">target-database</font></h2>
<p>Use the <code>eclipselink.target-database</code> property to specify the database to use, controlling custom operations and SQL generation for the specified database.</p>
<a id="sthref1182" name="sthref1182"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDIJHJG">Table 5-94</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1134" name="TLJPA1134"></a><a id="sthref1183" name="sthref1183"></a><a id="CHDIJHJG" name="CHDIJHJG"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-94 Valid Values for target-database</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for target-database" summary="This table describes the valid values for the target-database persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="34%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t103"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t103"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t103" headers="r1c1-t103">
<p>Defined in the <code>TargetDatabase</code> class or a fully qualified class name that extends <code>DatabasePlatform</code></p>
</td>
<td align="left" headers="r2c1-t103 r1c2-t103">
<p>Specify your database:</p>
<ul>
<li>
<p><strong>Attunity</strong></p>
</li>
<li>
<p><strong>Auto</strong> (Default): EclipseLink attempts to access the database and the JDBC metadata to determine the target database.</p>
</li>
<li>
<p><strong>Cloudscape</strong></p>
</li>
<li>
<p><strong>Database</strong>: Use a generic database, if your target database is not listed and your JDBC driver does not support the metadata required for <strong>Auto</strong>.</p>
</li>
<li>
<p><strong>DB2</strong></p>
</li>
<li>
<p><strong>DB2Mainframe</strong></p>
</li>
<li>
<p><strong>DBase</strong></p>
</li>
<li>
<p><strong>Derby</strong></p>
</li>
<li>
<p><strong>HSQL</strong></p>
</li>
<li>
<p><strong>Informix</strong></p>
</li>
<li>
<p><strong>JavaDB</strong></p>
</li>
<li>
<p><strong>MaxDB</strong></p>
</li>
<li>
<p><strong>MySQL</strong></p>
</li>
<li>
<p><strong>MySQL4</strong></p>
</li>
<li>
<p><strong>Oracle</strong></p>
</li>
<li>
<p><strong>Oracle10</strong></p>
</li>
<li>
<p><strong>Oracle11</strong></p>
</li>
<li>
<p><strong>Oracle8</strong></p>
</li>
<li>
<p><strong>Oracle9</strong></p>
</li>
<li>
<p><strong>PointBase</strong></p>
</li>
<li>
<p><strong>PostgreSQL</strong></p>
</li>
<li>
<p><strong>SQLAnywhere</strong></p>
</li>
<li>
<p><strong>SQLServer</strong></p>
</li>
<li>
<p><strong>Sybase</strong></p>
</li>
<li>
<p><strong>Symfoware</strong></p>
</li>
<li>
<p><strong>TimesTen</strong></p>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1184" name="sthref1184"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>If <code>eclipselink.<a href="#validation-only">validation-only</a></code> = <code>true</code>, you cannot use an <code>Auto</code> class name or short name.</p>
<a id="sthref1185" name="sthref1185"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDGGJAG">Example 5-119</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDGGJAG" name="CHDGGJAG"></a><a id="TLJPA1030" name="TLJPA1030"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-119 Using target-database in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.target-database" value="Oracle"/&gt;
</pre>
<p>or</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.target-database"
value="org.eclipse.persistence.platform.database.HSQLPlatform"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDEBFEJ">Example 5-120</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDEBFEJ" name="CHDEBFEJ"></a><a id="TLJPA1031" name="TLJPA1031"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-120 Using target-database in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.TargetDatabase;
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.TARGET_DATABASE, TargetDatabase.Oracle);
</pre></div>
<!-- class="example" -->
<a id="sthref1186" name="sthref1186"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#validation-only">"validation-only"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="target-server" name="target-server"></a><a id="TLJPA1135" name="TLJPA1135"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">target-server</font></h2>
<p>Use the <code>eclipselink.target-server</code> property to configure the <code>ServerPlatform</code> that will be used to enable integration with a host container. If this property is not specified, the runtime will attempt to detect which ServerPlatform should be used. If detection fails, <strong>Default</strong> will be used.</p>
<a id="sthref1187" name="sthref1187"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CCHGCDCJ">Table 5-95</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1136" name="TLJPA1136"></a><a id="sthref1188" name="sthref1188"></a><a id="CCHGCDCJ" name="CCHGCDCJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-95 Valid Values for target-server</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for target-server" summary="This table describes the valid values for the target-server persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="34%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t104"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t104"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t104" headers="r1c1-t104">
<p>Defined in the <code>TargetServer</code> class</p>
</td>
<td align="left" headers="r2c1-t104 r1c2-t104">
<p>Specify your application server:</p>
<ul>
<li>
<p><strong>JBoss</strong>: JBoss Application Server</p>
</li>
<li>
<p><strong>OC4J</strong>: OC4J persistence provider</p>
</li>
<li>
<p><strong>SAPNetWeaver_7_1</strong>: SAP NetWeaver Application Server 7.1 (and&nbsp;higher)</p>
</li>
</ul>
<ul>
<li>
<p><strong>SunAS9</strong>: Sun Application Server 9</p>
</li>
<li>
<p><strong>WebLogic</strong>: Oracle WebLogic Server</p>
</li>
<li>
<p><strong>WebLogic_10</strong>: Oracle WebLogic Server 10</p>
</li>
<li>
<p><strong>WebLogic_9</strong>: Oracle WebLogic Server 9</p>
</li>
<li>
<p><strong>WebSphere</strong>: IBM WebSphere</p>
</li>
<li>
<p><strong>WebSphere_6_1</strong>: IBM WebSphere 6.1</p>
</li>
<li>
<p><strong>WebSphere_7</strong>: IBM WebSphere 7</p>
</li>
<li>
<p><strong>WebSphere_Liberty</strong>: IBM WebSphere Liberty</p>
</li>
<li>
<p><strong>Default</strong> (<code>TargetServer.None</code>)</p>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1189" name="sthref1189"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>In addition to the supplied values, you can specify a custom server platform by supply the full class name for the platform.</p>
<p>Specifying a name of the class implementing <code>ExternalTransactionController</code> sets <code>CustomServerPlatform</code> with this controller.</p>
<a id="sthref1190" name="sthref1190"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CCHCEIDA">Example 5-121</a> shows how to use this property in a <code>persistence.xml</code> file.</p>
<div class="example"><a id="CCHCEIDA" name="CCHCEIDA"></a><a id="TLJPA1032" name="TLJPA1032"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-121 Using target-server in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.target-server" value="OC4J_10_1_3"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CCHHAJEH">Example 5-122</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CCHHAJEH" name="CCHHAJEH"></a><a id="TLJPA1033" name="TLJPA1033"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-122 Using target-server in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.TargetServer;
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put(PersistenceUnitProperties.TARGET_SERVER,
TargetServer.OC4J_10_1_3);
</pre></div>
<!-- class="example" -->
<a id="sthref1191" name="sthref1191"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
</div>
<!-- class="refsect1" -->
<a id="CHDHJBEE" name="CHDHJBEE"></a><a id="TLJPA54147" name="TLJPA54147"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">temporal.mutable</font></h2>
<p>Use the <code>eclipselink.temporal.mutable</code> property to configure the default for detecting changes to the temporal field (Date, Calendar).</p>
<a id="sthref1192" name="sthref1192"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDIHHDJ">Table 5-96</a> shows this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54148" name="TLJPA54148"></a><a id="sthref1193" name="sthref1193"></a><a id="CHDIHHDJ" name="CHDIHHDJ"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-96 Valid Values for temporal.mutable</font></em></strong></p>
<table class="FormalWide" title="Valid Values for temporal.mutable" summary="This table describes the valid values for the temporal.mutable persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t105"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t105"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t105" headers="r1c1-t105">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t105 r1c2-t105">
<p>Changes to the object are detected. Disables weaving of attribute change tracking.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t105" headers="r1c1-t105">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t105 r1c2-t105">
<p>(Default) Changes to the object itself are not detected.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1194" name="sthref1194"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>By default, it is assumed that temporal fields are replaced, and the temporal object is not changed directly.</p>
<a id="sthref1195" name="sthref1195"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCHDCH">Example 5-123</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDCHDCH" name="CHDCHDCH"></a><a id="TLJPA54149" name="TLJPA54149"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-123 Using temporal.mutable in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.temporal.mutable" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGHCDJ">Example 5-124</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDGHCDJ" name="CHDGHCDJ"></a><a id="TLJPA54175" name="TLJPA54175"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-124 Using temporal.mutable in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.TEMPORAL_MUTABLE,
"true");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="CHDHBGIE" name="CHDHBGIE"></a><a id="TLJPA54150" name="TLJPA54150"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">tenant-id</font></h2>
<p>Use the <code>eclipselink.tenant-id</code> property to specify the default context property used to populate multitenant entities.</p>
<a id="sthref1196" name="sthref1196"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDGHBII">Table 5-97</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54151" name="TLJPA54151"></a><a id="sthref1197" name="sthref1197"></a><a id="CHDGHBII" name="CHDGHBII"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-97 Valid Values for tenant-id</font></em></strong></p>
<table class="FormalWide" title="Valid Values for tenant-id" summary="This table describes the valid values for the tenant-id persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t106"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t106"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t106" headers="r1c1-t106">
<p><code>value</code></p>
</td>
<td align="left" headers="r2c1-t106 r1c2-t106">
<p>Name of the default context property.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1198" name="sthref1198"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>This is a default multitenant property that can be used on its own or with other properties defined by you. You are not obligated to use this property. You are free to specify your own.</p>
<a id="sthref1199" name="sthref1199"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFGBED">Example 5-125</a> shows how to use this property in the <code>persistence.xml</code>file.</p>
<div class="example"><a id="CHDFGBED" name="CHDFGBED"></a><a id="TLJPA54152" name="TLJPA54152"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-125 Using tenant-id in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.tenant-id" value="Oracle"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHDGGI">Example 5-126</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHDGGI" name="CHDHDGGI"></a><a id="TLJPA54153" name="TLJPA54153"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-126 Using tenant-id in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.MULTI_TENANT_PROPERTY_DEFAULT,
"Oracle");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="CIHEAICB" name="CIHEAICB"></a><a id="TLJPA1137" name="TLJPA1137"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">transaction.join-existing</font></h2>
<p>Use the <code>eclipselink.transaction.join-existing</code> property to force the persistence context to read through the JTA-managed ("write") connect</p>
<p>ion in case there is an active transaction.</p>
<a id="sthref1200" name="sthref1200"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CIHBCCII">Table 5-98</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1138" name="TLJPA1138"></a><a id="sthref1201" name="sthref1201"></a><a id="CIHBCCII" name="CIHBCCII"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-98 Valid Values for transaction.join-existing</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for transaction.join-existing" summary="This table describes the valid values for the transaction.join-existing persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="21%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t107"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t107"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t107" headers="r1c1-t107">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t107 r1c2-t107">
<p>Forces the persistence context to read through the JTA-managed connection.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t107" headers="r1c1-t107">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t107 r1c2-t107">
<p>(Default) Does not force the persistence context to read through the JTA-managed connection.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1202" name="sthref1202"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>The property set in persistence.xml or passed to <code>createEntityManagerFactory</code> affects all <code>EntityManagers</code> created by the factory. If the property set to <code>true</code>, objects read during transaction <em>will not</em> be placed into the shared cache unless they have been updated. Alternatively, to apply the property only to some <code>EntityManagers</code>, pass it to <code>createEntityManager</code> method.</p>
<a id="sthref1203" name="sthref1203"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDEEHAC">Example 5-127</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDEEHAC" name="CHDEEHAC"></a><a id="TLJPA54176" name="TLJPA54176"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-127 Using transaction.join-existing in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.transaction.join-existing" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHDGAJ">Example 5-128</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHDGAJ" name="CHDHDGAJ"></a><a id="TLJPA54177" name="TLJPA54177"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-128 Using transaction.join-existing in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.TRANSACTION_JOIN_EXISTING,
"true");
</pre></div>
<!-- class="example" -->
<a id="sthref1204" name="sthref1204"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Automated Tuning" in <em>Solutions Guide for EclispeLink</em></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDGFIGB" name="CHDGFIGB"></a><a id="TLJPA54187" name="TLJPA54187"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">tuning</font></h2>
<p>The <code>eclipselink.tuning</code> property selects the type of tuner to use to configure the persistence unit.</p>
<a id="sthref1205" name="sthref1205"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDECFEA">Table 5-99</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54188" name="TLJPA54188"></a><a id="sthref1206" name="sthref1206"></a><a id="CHDECFEA" name="CHDECFEA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-99 Valid Values for tuning</font></em></strong></p>
<table class="FormalWide" title="Valid Values for tuning" summary="This table describes the valid values for the tuning property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t108"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t108"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t108" headers="r1c1-t108">
<p><code>standard</code></p>
</td>
<td align="left" headers="r2c1-t108 r1c2-t108">
<p>(Default) Uses the standard tuner and does not change any of the default configuration settings.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t108" headers="r1c1-t108">
<p><code>safe</code></p>
</td>
<td align="left" headers="r3c1-t108 r1c2-t108">
<p>Configures the persistence unit for debugging. This disables caching and several performance optimizations. The purpose is to provide a simplified development and debugging configuration.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t108" headers="r1c1-t108">
<p>custom tuner</p>
</td>
<td align="left" headers="r4c1-t108 r1c2-t108">
<p>Specifies the full class name of an implementation of the <code>org.eclipse.persistence.tools.tuning.SessionTuner</code> interface.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1207" name="sthref1207"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>Use automated tuning to set multiple configuration properties as part of a single flag to perform dynamic tuning during different steps of application deployment.</p>
<a id="sthref1208" name="sthref1208"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDFBDDA">Example 5-129</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDFBDDA" name="CHDFBDDA"></a><a id="TLJPA54189" name="TLJPA54189"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-129 Using tuning in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.tuning" value="safe"/&gt;
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="validate-existence" name="validate-existence"></a><a id="TLJPA1139" name="TLJPA1139"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">validate-existence</font></h2>
<p>Use the <code>eclipselink.validate-existence</code> property to specify if EclipseLink should verify an object's existence on <code>persist()</code>.</p>
<a id="sthref1209" name="sthref1209"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BBACJIID">Table 5-100</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1140" name="TLJPA1140"></a><a id="sthref1210" name="sthref1210"></a><a id="BBACJIID" name="BBACJIID"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-100 Valid Values for validate-existence</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for validate-existence" summary="This table describes the valid values for the validate-existence persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t109"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t109"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t109" headers="r1c1-t109">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t109 r1c2-t109">
<p>EclipseLink verifies the object's existence.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t109" headers="r1c1-t109">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t109 r1c2-t109">
<p>(Default) EclipseLink assumes the object is new, if it is not in the persistence context.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1211" name="sthref1211"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>EclipseLink will throw an error if a validated object is not in the persistence context.</p>
<a id="sthref1212" name="sthref1212"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDHEBBG">Example 5-130</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDHEBBG" name="CHDHEBBG"></a><a id="TLJPA54178" name="TLJPA54178"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-130 Using validate-existence in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.validate-existence" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDBEGBB">Example 5-131</a> shows how to use this property in a proptery map.</p>
<div class="example"><a id="CHDBEGBB" name="CHDBEGBB"></a><a id="TLJPA54179" name="TLJPA54179"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-131 Using validate-existence in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.VALIDATE-EXISTENCE,
"true");
</pre></div>
<!-- class="example" --></div>
<!-- class="refsect1" -->
<a id="validation-only" name="validation-only"></a><a id="TLJPA1141" name="TLJPA1141"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">validation-only</font></h2>
<p>Use the <code>eclipselink.validation-only</code> property to validate deployments by initializing descriptors but not connecting to the data source.</p>
<a id="sthref1213" name="sthref1213"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDGIEBD">Table 5-101</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1142" name="TLJPA1142"></a><a id="sthref1214" name="sthref1214"></a><a id="CHDGIEBD" name="CHDGIEBD"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-101 Valid Values for validation-only</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for validation-only" summary="This table describes the valid values for the validation-only persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t110"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t110"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t110" headers="r1c1-t110">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t110 r1c2-t110">
<p>EclipseLink will initialize the descriptors but not log in.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t110" headers="r1c1-t110">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t110 r1c2-t110">
<p>(Default) EclipseLink will initialize the descriptors and log in.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1215" name="sthref1215"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>When setting <code>eclipselink.validation-only</code> to <code>true</code>, you must also configure <code>eclipselink.<a href="#target-database">target-database</a></code> with a non-Auto class name or a short name.</p>
<a id="sthref1216" name="sthref1216"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDJIFBC">Example 5-132</a> show how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDJIFBC" name="CHDJIFBC"></a><a id="TLJPA1034" name="TLJPA1034"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-132 Using validation-only in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.validation-only" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDIHEBJ">Example 5-133</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDIHEBJ" name="CHDIHEBJ"></a><a id="TLJPA54180" name="TLJPA54180"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-133 Using validation-only in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertyMap.put(PersistenceUnitProperties.VALIDATION_ONLY,
"true");
</pre></div>
<!-- class="example" -->
<a id="sthref1217" name="sthref1217"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#target-database">"target-database"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="weaving" name="weaving"></a><a id="TLJPA1143" name="TLJPA1143"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">weaving</font></h2>
<p>Use the <code>eclipselink.weaving</code> property to specify if EclipseLink weaves the entity classes. EclipseLink JPA uses weaving to enhance JPA entities for such things as lazy loading, change tracking, fetch groups, and internal optimizations.</p>
<a id="sthref1218" name="sthref1218"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDDFGDI">Table 5-102</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54122" name="TLJPA54122"></a><a id="sthref1219" name="sthref1219"></a><a id="CHDDFGDI" name="CHDDFGDI"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-102 Valid values for weaving</font></em></strong></p>
<table class="FormalWide" title="Valid values for weaving" summary="This table describes the valid values for the weaving persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t111"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t111"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t111" headers="r1c1-t111">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t111 r1c2-t111">
<p>Weave the entity classes dynamically.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t111" headers="r1c1-t111">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t111 r1c2-t111">
<p>Do not weave the entity classes.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t111" headers="r1c1-t111">
<p><code>static</code></p>
</td>
<td align="left" headers="r4c1-t111 r1c2-t111">
<p>Weave the entity classes statically.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1220" name="sthref1220"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDEIGFH">Example 5-134</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDEIGFH" name="CHDEIGFH"></a><a id="TLJPA54123" name="TLJPA54123"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-134 Using weaving in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipse.weaving" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDIGBIG">Example 5-135</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDIGBIG" name="CHDIGBIG"></a><a id="TLJPA54124" name="TLJPA54124"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-135 Using weaving in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(PersistenceUnitProperties.WEAVING, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1221" name="sthref1221"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p>"Using Weaving" in <em>Understanding EclipseLink</em></p>
</li>
<li>
<p>"Enhancing Performance" in <em><a href="http://eclipse.org/eclipselink/documentation/">Solutions Guide for EclipseLink</a></em></p>
</li>
<li>
<p><a href="#CHDCEEFC">"weaving.changetracking"</a></p>
</li>
<li>
<p><a href="#BABGGCGC">"weaving.eager"</a></p>
</li>
<li>
<p><a href="#CHDDIFGE">"weaving.fetchgroups"</a></p>
</li>
<li>
<p><a href="#BABJICDJ">"weaving.internal"</a></p>
</li>
<li>
<p><a href="annotations_ref.htm#CEGCCCCJ">"@ChangeTracking"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDCEEFC" name="CHDCEEFC"></a><a id="TLJPA54125" name="TLJPA54125"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">weaving.changetracking</font></h2>
<p>Use the <code>eclipselink.weaving.changetracking</code> persistence property to:</p>
<ul>
<li>
<p>Enable <code>AttributeLevelChangeTracking</code> through weaving.</p>
</li>
<li>
<p>Permit only classes with all mappings to change.</p>
</li>
<li>
<p>Permit tracking to enable change tracking. Mutable basic attributes prevent change tracking.</p>
</li>
</ul>
<p>This property is enabled only when weaving is enabled.</p>
<a id="sthref1222" name="sthref1222"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDGAACE">Table 5-103</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54126" name="TLJPA54126"></a><a id="sthref1223" name="sthref1223"></a><a id="CHDGAACE" name="CHDGAACE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-103 Valid Values for weaving.changetracking</font></em></strong></p>
<table class="FormalWide" title="Valid Values for weaving.changetracking" summary="This table describes the valid values for the weaving.changetracking persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t112"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t112"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t112" headers="r1c1-t112">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t112 r1c2-t112">
<p>(Default) Enables this property.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t112" headers="r1c1-t112">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t112 r1c2-t112">
<p>Disables this property.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1224" name="sthref1224"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDCCAFF">Example 5-136</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDCCAFF" name="CHDCCAFF"></a><a id="TLJPA54127" name="TLJPA54127"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-136 Using weaving.changetracking in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipse.weaving.changetracking" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHDAEG">Example 5-137</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDHDAEG" name="CHDHDAEG"></a><a id="TLJPA54128" name="TLJPA54128"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-137 Using weaving.changetracking in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipselink.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(Persistence.Unit.Properties.WEAVING_CHANGETRACKING,
value="false");
</pre></div>
<!-- class="example" -->
<a id="sthref1225" name="sthref1225"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#weaving">"weaving"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABGGCGC" name="BABGGCGC"></a><a id="TLJPA1035" name="TLJPA1035"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">weaving.eager</font></h2>
<p>Use the <code>eclipselink.weaving.eager</code> property to specify if EclipseLink uses indirection on eager relationships.</p>
<a id="sthref1226" name="sthref1226"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABFACAI">Table 5-104</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1036" name="TLJPA1036"></a><a id="sthref1227" name="sthref1227"></a><a id="BABFACAI" name="BABFACAI"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-104 Valid Values for weaving.eager</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for weaving.eager" summary="This table describes the valid values for the weaving.eager persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t113"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t113"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t113" headers="r1c1-t113">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t113 r1c2-t113">
<p>Enables indirection on eager relationships through weaving.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t113" headers="r1c1-t113">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t113 r1c2-t113">
<p>(Default) Disables indirection on eager relationships through weaving.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1228" name="sthref1228"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>One-to-one and many-to-one mappings, even when configured with <code>FetchType.EAGER</code>, will effectively become "lazy."</p>
<p>You can use this extension only if <code><a href="#weaving">weaving</a></code> is configured to <code>true</code> or <code>static</code>. See <a href="#weaving">"weaving"</a> for more information.</p>
<a id="sthref1229" name="sthref1229"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABFGADF">Example 5-138</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABFGADF" name="BABFGADF"></a><a id="TLJPA1037" name="TLJPA1037"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-138 Using weaving in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.weaving.eager" value="true"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABEECEE">Example 5-139</a> shows how to use this extension in a property map</p>
<div class="example"><a id="BABEECEE" name="BABEECEE"></a><a id="TLJPA1038" name="TLJPA1038"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-139 Using weaving in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(PersistenceUnitProperties.WEAVING_EAGER, "true");
</pre></div>
<!-- class="example" -->
<a id="sthref1230" name="sthref1230"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#weaving">"weaving"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="CHDDIFGE" name="CHDDIFGE"></a><a id="TLJPA54129" name="TLJPA54129"></a>
<hr />
<div class="refsect1"><!-- infolevel="all" infotype="General" -->
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">weaving.fetchgroups</font></h2>
<p>Use the <code>eclipselink.weaving.fetchgroups</code> property to enable <code>FetchGroups</code> through weaving. When this is enabled, lazy direct mapping is supported, as well as descriptor and query-level <code>FetchGroups</code>.</p>
<p><code>FetchGroups</code> allow partial objects to be read and written. Access to un-fetched attributes refreshes (fully-fetches) the object.</p>
<p>This property is only considered when weaving is enabled.</p>
<a id="sthref1231" name="sthref1231"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#CHDFIGGA">Table 5-105</a> describes this persistence property's values.</p>
<div class="tblformalwide"><a id="TLJPA54130" name="TLJPA54130"></a><a id="sthref1232" name="sthref1232"></a><a id="CHDFIGGA" name="CHDFIGGA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-105 Valid Values for weaving.fetchgroups</font></em></strong></p>
<table class="FormalWide" title="Valid Values for weaving.fetchgroups" summary="This table describes the valid values for the weaving.fetchgroups persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="25%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t114"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t114"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t114" headers="r1c1-t114">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t114 r1c2-t114">
<p>(Default) Enables <code>FetchGroups</code> through weaving.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t114" headers="r1c1-t114">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t114 r1c2-t114">
<p>Disables <code>FetchGroups</code> through weaving.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblformalwide" -->
<a id="sthref1233" name="sthref1233"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#CHDGJJBB">Example 5-140</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="CHDGJJBB" name="CHDGJJBB"></a><a id="TLJPA54131" name="TLJPA54131"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-140 Using weaving.fetchgroups in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.weaving.fetchgroups value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#CHDCJBAJ">Example 5-141</a> shows how to use this property in a property map.</p>
<div class="example"><a id="CHDCJBAJ" name="CHDCJBAJ"></a><a id="TLJPA54132" name="TLJPA54132"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-141 Using weaving.fetchgroups in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(PersistenceUnitProperties.WEAVING_FETCHGROUPS, "false")
</pre></div>
<!-- class="example" -->
<a id="sthref1234" name="sthref1234"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#weaving">"weaving"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABJICDJ" name="BABJICDJ"></a><a id="TLJPA1039" name="TLJPA1039"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">weaving.internal</font></h2>
<p>Use the <code>eclipselink.weaving.internal</code> property to specify if EclipseLink uses internal optimizations through weaving.</p>
<a id="sthref1235" name="sthref1235"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABCGIJB">Table 5-106</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1040" name="TLJPA1040"></a><a id="sthref1236" name="sthref1236"></a><a id="BABCGIJB" name="BABCGIJB"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-106 Valid Values for weaving.internal</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for weaving.internal" summary="This table describes the valid values for the weaving.internal persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t115"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t115"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t115" headers="r1c1-t115">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t115 r1c2-t115">
<p>(Default) Enables internal optimizations through weaving.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t115" headers="r1c1-t115">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t115 r1c2-t115">
<p>Disables internal optimizations through weaving.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1237" name="sthref1237"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use this extension only if <code><a href="#weaving">weaving</a></code> is configured to <code>true</code> or <code>static</code>. See <a href="#weaving">"weaving"</a> for more information.</p>
<a id="sthref1238" name="sthref1238"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABBBCEI">Example 5-142</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABBBCEI" name="BABBBCEI"></a><a id="TLJPA1041" name="TLJPA1041"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-142 Using weaving in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.weaving.internal" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABFHGDC">Example 5-143</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BABFHGDC" name="BABFHGDC"></a><a id="TLJPA1042" name="TLJPA1042"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-143 Using weaving in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(PersistenceUnitProperties.WEAVING_INTERNAL, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1239" name="sthref1239"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#weaving">"weaving"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" -->
<a id="BABDBIFE" name="BABDBIFE"></a><a id="TLJPA1043" name="TLJPA1043"></a>
<hr />
<div class="refsect1">
<h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">weaving.lazy</font></h2>
<p>Use the <code>eclipselink.weaving.lazy</code> property to specify if EclipseLink uses lazy one-to-one and many-to-one mappings.</p>
<a id="sthref1240" name="sthref1240"></a>
<p><strong><br /><span class="refsubsect">Values</span></strong></p>
<p><a href="#BABHEIHE">Table 5-107</a> describes this persistence property's values.</p>
<div class="tblhruleformalwide"><a id="TLJPA1044" name="TLJPA1044"></a><a id="sthref1241" name="sthref1241"></a><a id="BABHEIHE" name="BABHEIHE"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 5-107 Valid Values for weaving.lazy</font></em></strong></p>
<table class="HRuleFormalWide" title="Valid Values for weaving.lazy" summary="This table describes the valid values for the weaving.lazy persistence property." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="29%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t116"><font face="Arial, Helvetica, sans-serif"><strong>Value</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t116"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t116" headers="r1c1-t116">
<p><code>true</code></p>
</td>
<td align="left" headers="r2c1-t116 r1c2-t116">
<p>(Default) Enables lazy one-to-one and many-to-one mappings through weaving.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t116" headers="r1c1-t116">
<p><code>false</code></p>
</td>
<td align="left" headers="r3c1-t116 r1c2-t116">
<p>Disables lazy one-to-one and many-to-one mappings through weaving.</p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformalwide" -->
<a id="sthref1242" name="sthref1242"></a>
<p><strong><br /><span class="refsubsect">Usage</span></strong></p>
<p>You can use this extension only if <code><a href="#weaving">weaving</a></code> is configured to <code>true</code> or <code>static</code>. See <a href="#weaving">"weaving"</a> for more information.</p>
<a id="sthref1243" name="sthref1243"></a>
<p><strong><br /><span class="refsubsect">Examples</span></strong></p>
<p><a href="#BABCJAID">Example 5-144</a> shows how to use this property in the <code>persistence.xml</code> file.</p>
<div class="example"><a id="BABCJAID" name="BABCJAID"></a><a id="TLJPA1045" name="TLJPA1045"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-144 Using weaving.lazy in persistence.xml</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;property name="eclipselink.weaving.lazy" value="false"/&gt;
</pre></div>
<!-- class="example" -->
<p><a href="#BABHJIGA">Example 5-145</a> shows how to use this property in a property map.</p>
<div class="example"><a id="BABHJIGA" name="BABHJIGA"></a><a id="TLJPA1046" name="TLJPA1046"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 5-145 Using weaving.lazy in a Property Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
import org.eclipse.persistence.config.PersistenceUnitProperties;
propertiesMap.put
(PersistenceUnitProperties.WEAVING_LAZY, "false");
</pre></div>
<!-- class="example" -->
<a id="sthref1244" name="sthref1244"></a>
<p><strong><br /><span class="refsubsect">See Also</span></strong></p>
<p>For more information, see:</p>
<ul>
<li>
<p><a href="#weaving">"weaving"</a></p>
</li>
</ul>
</div>
<!-- class="refsect1" --></div>
<!-- class="ind" -->
<!-- Start Footer -->
<div class="footer">
<hr />
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="33%" />
<col width="*" />
<col width="33%" />
<tr>
<td valign="bottom">
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<col width="*" />
<col width="48%" />
<col width="48%" />
<tr>
<td>&nbsp;</td>
<td align="center"><a href="queryhints.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="schema.htm"><img src="../../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
</tr>
</table>
</td>
<td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br />
</td>
<td valign="bottom" align="right">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../../eclipselink_jpa_extensions.pdf" title="PDF" target="_blank"><img src="../../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td><td align="center"><a href="#disqus_thread" title="Comments""><img src="../../../dcommon/images/comments.png" style="padding-right:5px;border:0" alt="Comments"><br /><span class="mini">Comments</span></a>
</tr>
</table>
</td>
</tr>
</table>
</div>
<!-- class="footer" -->
<div id="copyright">Copyright &copy; 2014 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body>
</html>