blob: 9c31cb530ecbda29b74b47d346b540edd2b3989b [file] [log] [blame]
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title xmlns:d="http://docbook.org/ns/docbook">Appendix&nbsp;B.&nbsp;Service Collections</title><link rel="stylesheet" type="text/css" href="css/cayenne-doc.css"><meta xmlns:d="http://docbook.org/ns/docbook" name="keywords" content="Cayenne 4.0 documentation"><meta xmlns:d="http://docbook.org/ns/docbook" name="description" content="User documentation for Apache Cayenne version 4.0"><link rel="home" href="index.html" title="Cayenne Guide"><link rel="up" href="index.html" title="Cayenne Guide"><link rel="prev" href="configuration-properties.html" title="Appendix&nbsp;A.&nbsp;Configuration Properties"><link rel="next" href="expressions-bnf.html" title="Appendix&nbsp;C.&nbsp;Expressions BNF"><script xmlns:d="http://docbook.org/ns/docbook" type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-7036673-1']);
_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></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div xmlns:d="http://docbook.org/ns/docbook" class="navheader"><table width="100%" summary="Navigation header"><tr><th class="versioninfo">v.4.0 (4.0.M5)</th><th align="center">Appendix&nbsp;B.&nbsp;Service Collections</th><th></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="configuration-properties.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="expressions-bnf.html">Next</a></td></tr></table><hr></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a name="service-collections"></a>Appendix&nbsp;B.&nbsp;Service Collections</h1></div></div></div><p>Note that the collection keys below are
defined as constants in <code class="code">org.apache.cayenne.configuration.Constants</code>
interface.</p><p>
</p><div class="table"><a name="d0e3975"></a><p class="title"><b>Table&nbsp;B.1.&nbsp;Service Collection Keys Present in ServerRuntime and/or ClientRuntime</b></p><div class="table-contents"><table frame="void"><col width="42%"><col width="25%"><col width="33%"><thead><tr>
<th>Collection Property</th>
<th>Type</th>
<th>Description</th>
</tr></thead><tbody><tr>
<td><code class="code">cayenne.properties</code></td>
<td><code class="code">Map&lt;String,String&gt;</code></td>
<td>Properties used by built-in
Cayenne services. The keys in this map are the property names from the table
in Appendix A. Separate copies of this map exist on the server and ROP
client.</td>
</tr><tr>
<td><code class="code">cayenne.server.adapter_detectors</code></td>
<td><code class="code">List&lt;DbAdapterDetector&gt;</code></td>
<td>Contains
objects that can discover the type of current database and install the
correct DbAdapter in runtime.</td>
</tr><tr>
<td><code class="code">cayenne.server.domain_filters</code></td>
<td><code class="code">List&lt;DataChannelFilter&gt;</code></td>
<td>Stores DataDomain filters.</td>
</tr><tr>
<td><code class="code">cayenne.server.project_locations</code></td>
<td><code class="code">List&lt;String&gt;</code></td>
<td>Stores locations of the one of more project configuration files.</td>
</tr><tr>
<td><code class="code">cayenne.server.default_types</code></td>
<td><code class="code">List&lt;ExtendedType&gt;</code></td>
<td>Stores default adapter-agnostic ExtendedTypes. Default ExtendedTypes can be
overridden / extended by DB-specific DbAdapters as well as by user-provided
types configured in another colltecion (see
<code class="code">"cayenne.server.user_types"</code>).</td>
</tr><tr>
<td><code class="code">cayenne.server.user_types</code></td>
<td><code class="code">List&lt;ExtendedType&gt;</code></td>
<td>Stores a
user-provided ExtendedTypes. This collection will be merged into a full list
of ExtendedTypes and would override any ExtendedTypes defined in a default
list, or by a DbAdapter.</td>
</tr><tr>
<td><code class="code">cayenne.server.type_factories</code></td>
<td><code class="code">List&lt;ExtendedTypeFactory&gt;</code></td>
<td>Stores default and user-provided ExtendedTypeFactories. ExtendedTypeFactory
allows to define ExtendedTypes dynamically for the whole group of Java
classes. E.g. Cayenne supplies a factory to map all Enums regardless of
their type.</td>
</tr><tr>
<td><code class="code">cayenne.server.rop_event_bridge_properties</code></td>
<td><code class="code">Map&lt;String, String&gt;</code></td>
<td>Stores event bridge properties passed to the ROP client on
bootstrap. This means that the map is configured by server DI, and passed to
the client via the wire. The properties in this map are specific to
EventBridgeFactory implementation (e.g JMS or XMPP connection prameters).
One common property is <code class="code">"cayenne.server.rop_event_bridge_factory"</code> that
defines the type of the factory.</td>
</tr></tbody></table></div></div><p><br class="table-break">
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="configuration-properties.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="expressions-bnf.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix&nbsp;A.&nbsp;Configuration Properties&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Appendix&nbsp;C.&nbsp;Expressions BNF</td></tr></table></div></body></html>