You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2011/08/29 23:23:32 UTC

svn commit: r1163011 - in /cayenne/main/trunk: docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/client/ClientModule.java

Author: aadamchik
Date: Mon Aug 29 21:23:31 2011
New Revision: 1163011

URL: http://svn.apache.org/viewvc?rev=1163011&view=rev
Log:
docbook

* client properties - in progress

Modified:
    cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-b.xml
    cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/client/ClientModule.java

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=1163011&r1=1163010&r2=1163011&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 Mon Aug 29 21:23:31 2011
@@ -2,4 +2,71 @@
 <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>
+	<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>
+			<tbody>
+				<tr>
+					<td><code>cayenne.config.rop.service.url</code> - defines the URL of the ROP
+						server</td>
+					<td/>
+					<td/>
+				</tr>
+				<tr>
+					<td><code>cayenne.config.rop.service.username</code> - defines the user name to
+						login to the ROP server.</td>
+					<td/>
+				</tr>
+				<tr>
+					<td><code>cayenne.config.rop.service.password</code> - defines the password to
+						login to the ROP server.</td>
+					<td/>
+					<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/>
+				</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>
+				</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>
+				</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>
+				</tr>
+			</tbody>
+		</table>
+	</para>
 </appendix>

Modified: cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/client/ClientModule.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/client/ClientModule.java?rev=1163011&r1=1163010&r2=1163011&view=diff
==============================================================================
--- cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/client/ClientModule.java (original)
+++ cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/client/ClientModule.java Mon Aug 29 21:23:31 2011
@@ -45,6 +45,8 @@ public class ClientModule implements Mod
     public static final String ROP_SERVICE_SHARED_SESSION = "cayenne.config.rop.service.shared_session";
 
     public static final String CHANNEL_EVENTS = "cayenne.config.rop.client.channel.events";
+    
+    // TODO: this property name is exactly the same as CHANNEL_EVENTS... Seems messed up
     public static final String CHANNEL_REMOTE_EVENTS_OPTIONAL = "cayenne.config.rop.client.channel.events";
 
     public static final String CONTEXT_CHANGE_EVENTS = "cayenne.config.rop.client.context.change_events";