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 2006/11/26 00:33:31 UTC

svn commit: r479231 - in /incubator/cayenne/main/trunk/core/cayenne-jdk1.5: ./ src/main/java/org/apache/cayenne/enhancer/ src/test/java/org/apache/cayenne/enhancer/

Author: aadamchik
Date: Sat Nov 25 15:33:30 2006
New Revision: 479231

URL: http://svn.apache.org/viewvc?view=rev&rev=479231
Log:
CAY-694: Support for serialization of enhanced serializable POJO's that do not declare 'serialVersionUID'
(found an ASM-based solution for injection serialVersionUID compatible with Java produced one. ASM rules!)

Added:
    incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/MockSerializablePojo2.java
Modified:
    incubator/cayenne/main/trunk/core/cayenne-jdk1.5/pom.xml
    incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/main/java/org/apache/cayenne/enhancer/CayenneEnhancerVisitorFactory.java
    incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/PojoSerializationTest.java

Modified: incubator/cayenne/main/trunk/core/cayenne-jdk1.5/pom.xml
URL: http://svn.apache.org/viewvc/incubator/cayenne/main/trunk/core/cayenne-jdk1.5/pom.xml?view=diff&rev=479231&r1=479230&r2=479231
==============================================================================
--- incubator/cayenne/main/trunk/core/cayenne-jdk1.5/pom.xml (original)
+++ incubator/cayenne/main/trunk/core/cayenne-jdk1.5/pom.xml Sat Nov 25 15:33:30 2006
@@ -38,6 +38,11 @@
 			<groupId>asm</groupId>
 			<artifactId>asm</artifactId>
 		</dependency>
+		
+		<dependency>
+			<groupId>asm</groupId>
+			<artifactId>asm-commons</artifactId>
+		</dependency>
 
 		<dependency>
 			<groupId>junit</groupId>

Modified: incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/main/java/org/apache/cayenne/enhancer/CayenneEnhancerVisitorFactory.java
URL: http://svn.apache.org/viewvc/incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/main/java/org/apache/cayenne/enhancer/CayenneEnhancerVisitorFactory.java?view=diff&rev=479231&r1=479230&r2=479231
==============================================================================
--- incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/main/java/org/apache/cayenne/enhancer/CayenneEnhancerVisitorFactory.java (original)
+++ incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/main/java/org/apache/cayenne/enhancer/CayenneEnhancerVisitorFactory.java Sat Nov 25 15:33:30 2006
@@ -21,16 +21,13 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import org.apache.cayenne.Persistent;
 import org.apache.cayenne.map.EntityResolver;
 import org.apache.cayenne.map.ObjEntity;
 import org.objectweb.asm.ClassVisitor;
+import org.objectweb.asm.commons.SerialVersionUIDAdder;
 
 /**
- * A ClassFileTransformer that performs enhancement based on the metadata from Cayenne
- * DataMap. POJOs are enhanced into persistent objects that can be used with Cayenne. More
- * specifically, CayenneEnhancer ensures that the object implements {@link Persistent}
- * interface and invokes callbacks from the accessor methods.
+ * A factory of enhacing visitors.
  * 
  * @since 3.0
  * @author Andrus Adamchik
@@ -62,8 +59,13 @@
         }
 
         // create enhancer chain
+
         PersistentInterfaceVisitor e1 = new PersistentInterfaceVisitor(out);
         PersistentAccessorVisitor e2 = new PersistentAccessorVisitor(e1, entity);
-        return e2;
+
+        // this ensures that enhanced and original class have compatible serialized format
+        // even if no serialVersionUID is defined by the user
+        SerialVersionUIDAdder e3 = new SerialVersionUIDAdder(e2);
+        return e3;
     }
 }

Added: incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/MockSerializablePojo2.java
URL: http://svn.apache.org/viewvc/incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/MockSerializablePojo2.java?view=auto&rev=479231
==============================================================================
--- incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/MockSerializablePojo2.java (added)
+++ incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/MockSerializablePojo2.java Sat Nov 25 15:33:30 2006
@@ -0,0 +1,39 @@
+/*****************************************************************
+ *   Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ ****************************************************************/
+package org.apache.cayenne.enhancer;
+
+import java.io.Serializable;
+
+/**
+ * A serializable pojo without "serialVersionId" defined.
+ * 
+ * @author Andrus Adamchik
+ */
+public class MockSerializablePojo2 implements Serializable {
+
+    protected String attribute1;
+
+    public String getAttribute1() {
+        return attribute1;
+    }
+
+    public void setAttribute1(String attribute1) {
+        this.attribute1 = attribute1;
+    }
+}

Modified: incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/PojoSerializationTest.java
URL: http://svn.apache.org/viewvc/incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/PojoSerializationTest.java?view=diff&rev=479231&r1=479230&r2=479231
==============================================================================
--- incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/PojoSerializationTest.java (original)
+++ incubator/cayenne/main/trunk/core/cayenne-jdk1.5/src/test/java/org/apache/cayenne/enhancer/PojoSerializationTest.java Sat Nov 25 15:33:30 2006
@@ -47,6 +47,7 @@
     protected void setUp() throws Exception {
         Collection<String> managedClasses = new ArrayList<String>();
         managedClasses.add(MockSerializablePojo1.class.getName());
+        managedClasses.add(MockSerializablePojo2.class.getName());
 
         Map<String, Collection<String>> enhancedPropertyMap = new HashMap<String, Collection<String>>();
 
@@ -58,8 +59,15 @@
         ObjEntity e = new ObjEntity("E1");
         e.addAttribute(a1);
         e.setClassName(MockSerializablePojo1.class.getName());
+
+        ObjAttribute a2 = new ObjAttribute("attribute1");
+        ObjEntity e2 = new ObjEntity("E2");
+        e2.addAttribute(a2);
+        e2.setClassName(MockSerializablePojo2.class.getName());
+
         DataMap map = new DataMap("x");
         map.addObjEntity(e);
+        map.addObjEntity(e2);
 
         EnhancerVisitorFactory factory = new CayenneEnhancerVisitorFactory(
                 new EntityResolver(Collections.singleton(map)));
@@ -70,6 +78,51 @@
 
         Class enhanced = Class.forName(
                 MockSerializablePojo1.class.getName(),
+                true,
+                loader);
+        assertTrue(Persistent.class.isAssignableFrom(enhanced));
+        try {
+            enhanced.getDeclaredField("$cay_persistenceState");
+        }
+        catch (NoSuchFieldException e) {
+            fail("Enhancer fields are not present");
+        }
+
+        Class unenhanced = Class.forName(CayenneEnhancerVisitorFactoryTest.C1);
+        assertFalse(Persistent.class.isAssignableFrom(unenhanced));
+        try {
+            unenhanced.getDeclaredField("$cay_persistenceState");
+            fail("Enhancer fields are present");
+        }
+        catch (NoSuchFieldException e) {
+            // expected
+        }
+
+        Object eo = enhanced.newInstance();
+        PropertyUtils.setProperty(eo, "attribute1", "XXX");
+        PropertyUtils.setProperty(eo, "persistenceState", new Integer(
+                PersistenceState.MODIFIED));
+        assertTrue(eo instanceof Persistent);
+
+        ByteArrayOutputStream out = new ByteArrayOutputStream();
+        ObjectOutputStream oout = new ObjectOutputStream(out);
+        oout.writeObject(eo);
+        oout.close();
+
+        ByteArrayInputStream in = new ByteArrayInputStream(out.toByteArray());
+        ObjectInputStream oin = new ObjectInputStream(in);
+
+        Object ueo = oin.readObject();
+        assertNotNull(ueo);
+        assertFalse(ueo instanceof Persistent);
+        assertEquals("XXX", PropertyUtils.getProperty(ueo, "attribute1"));
+
+    }
+
+    public void testEnhancedToRegularNoSerialVersionId() throws Exception {
+
+        Class enhanced = Class.forName(
+                MockSerializablePojo2.class.getName(),
                 true,
                 loader);
         assertTrue(Persistent.class.isAssignableFrom(enhanced));