Author: aadamchik
Date: Wed Mar 7 13:07:42 2012
New Revision: 1297961
URL: http://svn.apache.org/viewvc?rev=1297961&view=rev
Log:
CAY-1665 Consistent and concise property names aggregated in one place
moving ROP event bridge properties to Constants
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/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/Constants.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/server/ROPServerModule.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/hessian/service/HessianService.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/service/BaseRemoteService.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/hessian/service/HessianServiceTest.java
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/service/BaseRemoteServiceTest.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=1297961&r1=1297960&r2=1297961&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 Wed
Mar 7 13:07:42 2012
@@ -143,6 +143,17 @@
<td>true,false</td>
<td>false</td>
</tr>
+ <tr>
+
<td><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/>
+ </tr>
</tbody>
</table>
</para>
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=1297961&r1=1297960&r2=1297961&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 Wed
Mar 7 13:07:42 2012
@@ -13,7 +13,8 @@
<tr>
<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>
+ in Appendix A. Separate copies
of this map exist on the server and ROP
+ client.</td>
</tr>
<tr>
<td><code>cayenne.server.adapter_detectors</code> - List<DbAdapterDetector>
that contains
@@ -48,6 +49,15 @@
classes. E.g. Cayenne supplies
a factory to map all Enums regardless of
their type.</td>
</tr>
+ <tr>
+
<td><code>cayenne.server.rop_event_bridge_properties</code> - Map<String,
+ String> storing 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
"cayenne.server.rop_event_bridge_factory" that
+ defines the type of the
factory.</td>
+ </tr>
</tbody>
</table>
</para>
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=1297961&r1=1297960&r2=1297961&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
Wed Mar 7 13:07:42 2012
@@ -69,6 +69,12 @@ public interface Constants {
*/
public static final String SERVER_TYPE_FACTORIES_LIST =
"cayenne.server.type_factories";
+ /**
+ * A server-side DI container key for the Map<String, String> storing
event bridge
+ * properties passed to the ROP client on bootstrap.
+ */
+ public static final String SERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP =
"cayenne.server.rop_event_bridge_properties";
+
// Runtime properties
public static final String JDBC_DRIVER_PROPERTY = "cayenne.jdbc.driver";
@@ -118,4 +124,12 @@ public interface Constants {
public static final String ROP_CONTEXT_LIFECYCLE_EVENTS_PROPERTY =
"cayenne.rop.context_lifecycle_events";
+ /**
+ * The name of the {@link org.apache.cayenne.event.EventBridgeFactory}
that is passed
+ * from the ROP server to the client. Client would instantiate the factory
to receive
+ * events from the server. Note that this property is stored in
+ * {@link #SERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP}, not {@link
#PROPERTIES_MAP}.
+ */
+ public static final String SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY =
"cayenne.server.rop_event_bridge_factory";
+
}
Modified:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/server/ROPServerModule.java
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/server/ROPServerModule.java?rev=1297961&r1=1297960&r2=1297961&view=diff
==============================================================================
---
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/server/ROPServerModule.java
(original)
+++
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/configuration/rop/server/ROPServerModule.java
Wed Mar 7 13:07:42 2012
@@ -20,6 +20,7 @@ package org.apache.cayenne.configuration
import java.util.Map;
+import org.apache.cayenne.configuration.Constants;
import org.apache.cayenne.di.Binder;
import org.apache.cayenne.di.MapBuilder;
import org.apache.cayenne.di.Module;
@@ -43,7 +44,7 @@ public class ROPServerModule implements
public void configure(Binder binder) {
MapBuilder<String> mapBuilder = binder
- .bindMap(HessianService.EVENT_BRIDGE_PROPERTIES_MAP);
+ .bindMap(Constants.SERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP);
mapBuilder.putAll(eventBridgeProperties);
binder.bind(RemoteService.class).to(HessianService.class);
Modified:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/hessian/service/HessianService.java
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/hessian/service/HessianService.java?rev=1297961&r1=1297960&r2=1297961&view=diff
==============================================================================
---
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/hessian/service/HessianService.java
(original)
+++
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/hessian/service/HessianService.java
Wed Mar 7 13:07:42 2012
@@ -24,6 +24,7 @@ import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
+import org.apache.cayenne.configuration.Constants;
import org.apache.cayenne.configuration.ObjectContextFactory;
import org.apache.cayenne.di.Inject;
import org.apache.cayenne.remote.service.HttpRemoteService;
@@ -37,8 +38,6 @@ import com.caucho.services.server.Servic
*/
public class HessianService extends HttpRemoteService {
- public static final String EVENT_BRIDGE_PROPERTIES_MAP =
"org.apache.cayenne.remote.hessian.service.HessianService.properties";
-
public static final String[] SERVER_SERIALIZER_FACTORIES = new String[] {
ServerSerializerFactory.class.getName()
};
@@ -47,7 +46,7 @@ public class HessianService extends Http
* @since 3.1
*/
public HessianService(@Inject ObjectContextFactory contextFactory,
- @Inject(EVENT_BRIDGE_PROPERTIES_MAP) Map<String, String>
eventBridgeProperties) {
+ @Inject(Constants.SERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP)
Map<String, String> eventBridgeProperties) {
super(contextFactory, eventBridgeProperties);
}
Modified:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/service/BaseRemoteService.java
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/service/BaseRemoteService.java?rev=1297961&r1=1297960&r2=1297961&view=diff
==============================================================================
---
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/service/BaseRemoteService.java
(original)
+++
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/remote/service/BaseRemoteService.java
Wed Mar 7 13:07:42 2012
@@ -27,6 +27,7 @@ import org.apache.cayenne.CayenneRuntime
import org.apache.cayenne.DataChannel;
import org.apache.cayenne.access.ClientServerChannel;
import org.apache.cayenne.access.DataContext;
+import org.apache.cayenne.configuration.Constants;
import org.apache.cayenne.configuration.ObjectContextFactory;
import org.apache.cayenne.remote.ClientMessage;
import org.apache.cayenne.remote.RemoteService;
@@ -43,8 +44,6 @@ import org.apache.commons.logging.LogFac
*/
public abstract class BaseRemoteService implements RemoteService {
- public static final String EVENT_BRIDGE_FACTORY_PROPERTY =
"cayenne.RemoteService.EventBridge.factory";
-
// keep logger non-static so that it could be garbage collected with this
instance.
protected final Log logger;
@@ -137,8 +136,11 @@ public abstract class BaseRemoteService
catch (Throwable th) {
StringBuilder wrapperMessage = new StringBuilder();
- wrapperMessage.append("Exception processing message ").append(
- message.getClass().getName()).append(" of type
").append(message);
+ wrapperMessage
+ .append("Exception processing message ")
+ .append(message.getClass().getName())
+ .append(" of type ")
+ .append(message);
String wrapperMessageString = wrapperMessage.toString();
logger.info(wrapperMessageString, th);
@@ -185,13 +187,14 @@ public abstract class BaseRemoteService
*/
protected void initEventBridgeParameters(Map<String, String> properties) {
String eventBridgeFactoryName = properties
- .get(BaseRemoteService.EVENT_BRIDGE_FACTORY_PROPERTY);
+ .get(Constants.SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY);
if (eventBridgeFactoryName != null) {
Map<String, String> eventBridgeParameters = new HashMap<String,
String>(
properties);
-
eventBridgeParameters.remove(BaseRemoteService.EVENT_BRIDGE_FACTORY_PROPERTY);
+ eventBridgeParameters
+
.remove(Constants.SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY);
this.eventBridgeFactoryName = eventBridgeFactoryName;
this.eventBridgeParameters = eventBridgeParameters;
Modified:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/hessian/service/HessianServiceTest.java
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/hessian/service/HessianServiceTest.java?rev=1297961&r1=1297960&r2=1297961&view=diff
==============================================================================
---
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/hessian/service/HessianServiceTest.java
(original)
+++
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/hessian/service/HessianServiceTest.java
Wed Mar 7 13:07:42 2012
@@ -28,6 +28,7 @@ import junit.framework.TestCase;
import org.apache.cayenne.DataChannel;
import org.apache.cayenne.ObjectContext;
+import org.apache.cayenne.configuration.Constants;
import org.apache.cayenne.configuration.ObjectContextFactory;
import org.apache.cayenne.event.MockEventBridgeFactory;
@@ -41,7 +42,7 @@ public class HessianServiceTest extends
Map<String, String> map = new HashMap<String, String>();
map.put(
- HessianService.EVENT_BRIDGE_FACTORY_PROPERTY,
+ Constants.SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY,
MockEventBridgeFactory.class.getName());
ObjectContextFactory factory = new ObjectContextFactory() {
Modified:
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/service/BaseRemoteServiceTest.java
URL:
http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/service/BaseRemoteServiceTest.java?rev=1297961&r1=1297960&r2=1297961&view=diff
==============================================================================
---
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/service/BaseRemoteServiceTest.java
(original)
+++
cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/test/java/org/apache/cayenne/remote/service/BaseRemoteServiceTest.java
Wed Mar 7 13:07:42 2012
@@ -26,12 +26,12 @@ import junit.framework.TestCase;
import org.apache.cayenne.CayenneRuntimeException;
import org.apache.cayenne.DataChannel;
import org.apache.cayenne.ObjectContext;
+import org.apache.cayenne.configuration.Constants;
import org.apache.cayenne.configuration.ObjectContextFactory;
import org.apache.cayenne.event.MockEventBridgeFactory;
import org.apache.cayenne.query.Query;
import org.apache.cayenne.remote.QueryMessage;
import org.apache.cayenne.remote.RemoteSession;
-import org.apache.cayenne.remote.hessian.service.HessianService;
import org.apache.cayenne.util.Util;
public class BaseRemoteServiceTest extends TestCase {
@@ -40,7 +40,7 @@ public class BaseRemoteServiceTest exten
Map<String, String> map = new HashMap<String, String>();
map.put(
- HessianService.EVENT_BRIDGE_FACTORY_PROPERTY,
+ Constants.SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY,
MockEventBridgeFactory.class.getName());
ObjectContextFactory factory = new ObjectContextFactory() {
