| <html><head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title xmlns:d="http://docbook.org/ns/docbook">Appendix A. Configuration Properties</title><link rel="stylesheet" type="text/css" href="css/cayenne-doc.css"><meta xmlns:d="http://docbook.org/ns/docbook" name="keywords" content="Cayenne 3.1 documentation"><meta xmlns:d="http://docbook.org/ns/docbook" name="description" content="User documentation for Apache Cayenne version 3.1"><link rel="home" href="index.html" title="Cayenne Guide"><link rel="up" href="index.html" title="Cayenne Guide"><link rel="prev" href="current-limitations.html" title="Chapter 18. Current Limitations"><link rel="next" href="service-collections.html" title="Appendix B. Service Collections"><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.3.1 (3.1)</th><th align="center">Appendix A. Configuration Properties</th><th></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="current-limitations.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="service-collections.html">Next</a></td></tr></table><hr></div><div class="appendix" title="Appendix A. Configuration Properties"><div class="titlepage"><div><div><h2 class="title"><a name="configuration-properties"></a>Appendix A. Configuration Properties</h2></div></div></div><p>Note that the property names below are defined as constants in | |
| <code class="code">org.apache.cayenne.configuration.Constants</code> interface. </p><p> | |
| </p><table frame="void" id="d0e2645"><caption>Table A.1. Configuration Properties Recognized by ServerRuntime and/or ClientRuntime</caption><col width="67%"><col width="15%"><col width="18%"><thead><tr> | |
| <th>Property</th> | |
| <th>Possible Values</th> | |
| <th>Default Value</th> | |
| </tr></thead><tbody><tr> | |
| <td><code class="code">cayenne.jdbc.driver[.domain_name.node_name]</code> - defines a JDBC driver class to | |
| use when creating a DataSource. If domain name and optionally - node name | |
| are specified, the setting overrides DataSource info just for this | |
| domain/node. Otherwise the override is applied to all domains/nodes in the | |
| system.</td> | |
| <td></td> | |
| <td>none, project DataNode configuration is used</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.jdbc.url[.domain_name.node_name] </code>- defines a DB URL to use when | |
| creating a DataSource. If domain name and optionally - node name are | |
| specified, the setting overrides DataSource info just for this domain/node. | |
| Otherwise the override is applied to all domains/nodes in the system.</td> | |
| <td></td> | |
| <td>none, project DataNode configuration is used</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.jdbc.username[.domain_name.node_name] </code>- defines a DB user name to use | |
| when creating a DataSource. If domain name and optionally - node name are | |
| specified, the setting overrides DataSource info just for this domain/node. | |
| Otherwise the override is applied to all domains/nodes in the system.</td> | |
| <td></td> | |
| <td>none, project DataNode configuration is used</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.jdbc.password[.domain_name.node_name]</code> - defines a DB password to use | |
| when creating a DataSource. If domain name and optionally - node name are | |
| specified, the setting overrides DataSource info just for this domain/node. | |
| Otherwise the override is applied to all domains/nodes in the system</td> | |
| <td></td> | |
| <td>none, project DataNode configuration is used</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.jdbc.min_connections[.domain_name.node_name]</code> - defines the DB | |
| connection pool minimal size. If domain name and optionally - node name are | |
| specified, the setting overrides DataSource info just for this domain/node. | |
| Otherwise the override is applied to all domains/nodes in the system</td> | |
| <td></td> | |
| <td>none, project DataNode configuration is used</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.jdbc.max_connections[.domain_name.node_name]</code> - defines the DB | |
| connection pool maximum size. If domain name and optionally - node name are | |
| specified, the setting overrides DataSource info just for this domain/node. | |
| Otherwise the override is applied to all domains/nodes in the system</td> | |
| <td></td> | |
| <td>none, project DataNode configuration is used</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.querycache.size</code> - An integer defining the maximum number of entries in | |
| the query cache. Note that not all QueryCache providers may respect this | |
| property. MapQueryCache uses it, but the rest would use alternative | |
| configuration methods.</td> | |
| <td>any positive int value</td> | |
| <td>2000</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.server.contexts_sync_strategy</code> - defines whether peer ObjectContexts | |
| should receive snapshot events after commits from other contexts. If true | |
| (default), the contexts would automatically synchronize their state with | |
| peers.</td> | |
| <td>true, false</td> | |
| <td>true</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.server.object_retain_strategy</code> - defines fetched objects retain | |
| strategy for ObjectContexts. When weak or soft strategy is used, objects | |
| retained by ObjectContext that have no local changes can potetially get | |
| garbage collected when JVM feels like doing it.</td> | |
| <td>weak, soft, hard</td> | |
| <td>weak</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.server.max_id_qualifier_size</code> - defines a maximum number of ID | |
| qualifiers in the WHERE clause of queries that are generated for paginated | |
| queries and for DISJOINT_BY_ID prefetch processing. This is needed to avoid | |
| hitting WHERE clause size limitations and memory usage efficiency.</td> | |
| <td>any positive int</td> | |
| <td>10000</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.service_url</code> - defines the URL of the ROP server</td> | |
| <td></td> | |
| <td></td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.service_username</code> - defines the user name for an ROP client to | |
| login to an ROP server.</td> | |
| <td></td> | |
| <td></td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.service_password</code> - defines the password for an ROP client to login | |
| to an ROP server.</td> | |
| <td></td> | |
| <td></td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.shared_session_name</code>- defines the name of the shared session that | |
| an ROP client wants to join on an ROP server. If omitted, a dedicated | |
| session is created.</td> | |
| <td></td> | |
| <td></td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.service.timeout</code> - a value in milliseconds for the | |
| ROP client-server connection read operation timeout</td> | |
| <td>any positive long value</td> | |
| <td></td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.channel_events</code> - defines whether client-side DataChannel should | |
| dispatch events to child ObjectContexts. If set to true, ObjectContexts will | |
| receive commit events and merge changes committed by peer contexts that | |
| passed through the common client DataChannel.</td> | |
| <td>true, false</td> | |
| <td>false</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.context_change_events</code>- defines whether object property changes in | |
| the client context result in firing events. Client UI components can listen | |
| to these events and update the UI. Disabled by default.</td> | |
| <td>true, false</td> | |
| <td>false</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.rop.context_lifecycle_events</code> - defines whether object commit and | |
| rollback operations in the client context result in firing events. Client UI | |
| components can listen to these events and update the UI. Disabled by | |
| default.</td> | |
| <td>true,false</td> | |
| <td>false</td> | |
| </tr><tr> | |
| <td><code class="code">cayenne.server.rop_event_bridge_factory</code> - defines the name of | |
| the org.apache.cayenne.event.EventBridgeFactory that is passed from the ROP | |
| server to the client. I.e. server DI would provide a name of the factory, | |
| passing this name to the client via the wire. The client would instantiate | |
| it to receive events from the server. Note that this property is stored in | |
| "cayenne.server.rop_event_bridge_properties" map, not in the main | |
| "cayenne.properties".</td> | |
| <td></td> | |
| <td></td> | |
| </tr></tbody></table><p> | |
| </p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="current-limitations.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="service-collections.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 18. Current Limitations </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix B. Service Collections</td></tr></table></div></body></html> |