Author: aadamchik
Date: Fri Mar 2 10:53:19 2012
New Revision: 1296131
URL: http://svn.apache.org/viewvc?rev=1296131&view=rev
Log:
CAY-1665 Consistent and concise property names aggregated in one place
aligning docs
Modified:
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/Constants.java
Modified:
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml?rev=1296131&r1=1296130&r2=1296131&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml
(original)
+++ cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml Fri
Mar 2 10:53:19 2012
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook";
xmlns:xlink="http://www.w3.org/1999/xlink";
version="5.0" xml:id="server-configuration-properties">
- <title>Server Configuration Properties</title>
+ <title>Configuration Properties</title>
<para>
<table frame="void" width="739">
- <caption>Configuration Properties Recognized by
ServerRuntime</caption>
+ <caption>Configuration Properties Recognized by
ServerRuntime and/or ClientRuntime</caption>
<col width="77%"/>
<col width="10%"/>
<col width="13%"/>
@@ -17,6 +17,63 @@
</thead>
<tbody>
<tr>
+
<td><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>none, project DataNode
configuration is used</td>
+ </tr>
+ <tr>
+
<td><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>none, project DataNode
configuration is used</td>
+ </tr>
+ <tr>
+
<td><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>none, project DataNode
configuration is used</td>
+ </tr>
+ <tr>
+
<td><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>none, project DataNode
configuration is used</td>
+ </tr>
+ <tr>
+
<td><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>none, project DataNode
configuration is used</td>
+ </tr>
+ <tr>
+
<td><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>none, project DataNode
configuration is used</td>
+ </tr>
+ <tr>
+
<td><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>org.apache.cayenne.sync_contexts</code> - defines whether peer
ObjectContexts should receive
snapshot events after commits from other
contexts. If true (default),
the contexts would automatically synchronize
@@ -34,97 +91,53 @@
<td>weak</td>
</tr>
<tr>
-
<td><code>cayenne.jdbc.driver[.domain_name.node_name]</code> - defines the JDBC
- driver 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><code>cayenne.config.rop.service.url</code> - defines the URL of the ROP
+ server</td>
<td/>
- <td>none, project DataNode
configuration is used</td>
- </tr>
- <tr>
-
<td><code>cayenne.jdbc.url[.domain_name.node_name] </code>- defines the 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>none, project DataNode
configuration is used</td>
</tr>
<tr>
-
<td><code>cayenne.adapter[.domain_name.node_name]</code> - defines the class
- name of the DbAdapter to use
with the DataNodes. If domain name and
- optionally - node name are
specified, the setting overrides adapter info
- just for this domain/node.
Otherwise the override is applied to all
- domains/nodes in the
system.</td>
+
<td><code>cayenne.config.rop.service.username</code> - defines the user name to
+ login to the ROP server.</td>
<td/>
- <td>none, project DataNode
configuration is used</td>
</tr>
<tr>
-
<td><code>cayenne.jdbc.username[.domain_name.node_name] </code>- defines the 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><code>cayenne.config.rop.service.password</code> - defines the password to
+ login to the ROP server.</td>
<td/>
- <td>none, project DataNode
configuration is used</td>
- </tr>
- <tr>
-
<td><code>cayenne.jdbc.password[.domain_name.node_name]</code> - defines the 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>none, project DataNode
configuration is used</td>
</tr>
<tr>
-
<td><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><code>cayenne.config.rop.service.shared_session</code>- defines the name of
+ the shared session to join on
the ROP server. If omitted a dedicated session
+ is created.</td>
<td/>
- <td>none, project DataNode
configuration is used</td>
- </tr>
- <tr>
-
<td><code>cayenne.jdbc.max.conections[.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>none, project DataNode
configuration is used</td>
- </tr>
- <tr>
-
<td><code>cayenne.MapQueryCacheFactory.cacheSize</code> - defines the max size
- of the LRU query cache map.
Ignored if the default MapQueryCacheFactory is
- overridden and a different
cache provider is used.</td>
- <td>an int defining max number of
entries in the cache</td>
- <td>2000</td>
</tr>
- </tbody>
- </table>
- </para>
- <para>
- <table frame="void">
- <caption>Service Collections Recognized by
ServerRuntime</caption>
- <col width="56%"/>
- <col width="16%"/>
- <col width="28%"/>
- <tbody>
<tr>
-
<td><code>org.apache.cayenne.configuration.DefaultRuntimeProperties.properties</code>
-
- Map<String,String> of
properties used by built-in Cayenne services. The
- keys in this map are the
property names from the previous table</td>
+
<td><code>cayenne.config.rop.client.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>org.apache.cayenne.configuration.server.DefaultDbAdapterFactory.detectors</code>
-
- List<DbAdapterDetector> of
detector objects that can discover the type of
- current database and install
the correct DbAdapter in runtime.</td>
+
<td><code>cayenne.config.rop.client.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/>
+
<td><code>cayenne.config.rop.client.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>
</tbody>
</table>
Modified:
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml?rev=1296131&r1=1296130&r2=1296131&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml
(original)
+++ cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml Fri
Mar 2 10:53:19 2012
@@ -1,72 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook";
xmlns:xlink="http://www.w3.org/1999/xlink";
version="5.0" xml:id="client-configuration-properties">
- <title>Client Configuration Properties</title>
+ <title>Service Collections</title>
+ <para>Note that the collection keys below are
+ defined as constants in
<code>org.apache.cayenne.configuration.Constants</code>
+ interface.</para>
<para>
- <table frame="void" width="737">
- <caption>Configuration Properties Recognized by
ClientRuntime</caption>
- <col width="51%"/>
- <col width="7%"/>
- <col width="8%"/>
- <col width="38%"/>
- <thead>
- <tr>
- <th>Property</th>
- <th>Possible Values</th>
- <th>Default Value</th>
- </tr>
- </thead>
+ <table frame="void">
+ <caption>Service Collection Keys Present in
ServerRuntime and/or ClientRuntime</caption>
+ <col width="100%"/>
<tbody>
<tr>
-
<td><code>cayenne.config.rop.service.url</code> - defines the URL of the ROP
- server</td>
- <td/>
- <td/>
+ <td><code>cayenne.properties</code> -
Map<String,String> of properties used by built-in
+ Cayenne services. The keys in
this map are the property names from the table
+ in Appendix A.</td>
</tr>
<tr>
-
<td><code>cayenne.config.rop.service.username</code> - defines the user name to
- login to the ROP server.</td>
- <td/>
+
<td><code>cayenne.server.adapter_detectors</code> - List<DbAdapterDetector>
that contains
+ objects that can discover the
type of current database and install the
+ correct DbAdapter in
runtime.</td>
</tr>
<tr>
-
<td><code>cayenne.config.rop.service.password</code> - defines the password to
- login to the ROP server.</td>
- <td/>
- <td/>
+
<td><code>cayenne.server.domain_filters</code> - List<DataChannelFilter>
storing DataDomain
+ filters.</td>
</tr>
<tr>
-
<td><code>cayenne.config.rop.service.shared_session</code>- defines the name of
- the shared session to join on
the ROP server. If omitted a dedicated session
- is created.</td>
- <td/>
- <td/>
+
<td><code>cayenne.server.project_locations</code> - List<String> storing
+ locations of the one of more
project configuration files.</td>
</tr>
<tr>
-
<td><code>cayenne.config.rop.client.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>
+
<td><code>cayenne.server.default_types</code> - List<ExtendedType> storing
+ 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
+
"cayenne.server.user_types").</td>
</tr>
<tr>
-
<td><code>cayenne.config.rop.client.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>
+
<td><code>cayenne.server.user_types</code> - List<ExtendedType> storing 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>cayenne.config.rop.client.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>
+
<td><code>cayenne.server.type_factories</code> - List<ExtendedTypeFactory>
+ storing 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>
</tbody>
</table>
</para>
+
</appendix>
Modified:
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml?rev=1296131&r1=1296130&r2=1296131&view=diff
==============================================================================
---
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml
(original)
+++
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml
Fri Mar 2 10:53:19 2012
@@ -217,8 +217,7 @@ ServerRuntime runtime =
binder.bindList(DefaultDbAdapterFactory.DETECTORS_LIST)
.add(MyDbAdapterDetector.class);</programlisting>
<para>Maps are customized using a similar
"<code>bindMap</code>" method.</para>
- <para>The names of built-in collections are listed in
"ServerRuntime Service
- Collections" table in "Appendix A".</para>
+ <para>The names of built-in collections are listed in
"Appendix B".</para>
</section>
<section xml:id="alternative-service-implementations">
<title>Alternative Service Implementations</title>
Modified:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/Constants.java
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/Constants.java?rev=1296131&r1=1296130&r2=1296131&view=diff
==============================================================================
---
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/Constants.java
(original)
+++
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/Constants.java
Fri Mar 2 10:53:19 2012
@@ -29,8 +29,8 @@ public interface Constants {
// DI "collections"
/**
- * A DI container key for the properties map used to configure either ROP
or server
- * tiers.
+ * A DI container key for the Map<String, String> storing properties used
by built-in
+ * Cayenne service.
*/
public static final String PROPERTIES_MAP = "cayenne.properties";
@@ -41,13 +41,13 @@ public interface Constants {
public static final String SERVER_ADAPTER_DETECTORS_LIST =
"cayenne.server.adapter_detectors";
/**
- * A DI container key for the list storing DataDomain filters.
+ * A DI container key for the List<DataChannelFilter> storing DataDomain
filters.
*/
public static final String SERVER_DOMAIN_FILTERS_LIST =
"cayenne.server.domain_filters";
/**
- * A DI container key for the list storing locations of the one of more
project
- * configuration files.
+ * A DI container key for the List<String> storing locations of the one of
more
+ * project configuration files.
*/
public static final String SERVER_PROJECT_LOCATIONS_LIST =
"cayenne.server.project_locations";
