HHH-8265 Documented the reasoning for importing o.h.proxy and

brmeyer · brmeyer · commit 80dc1e6fd1d1 · 2013-06-05T18:49:06.000-04:00
javassist.util.proxy in the quickstarts.  Added a load proxy test.

Conflicts:
	documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/entity/DataPoint.java
diff --git a/documentation/src/main/docbook/devguide/en-US/chapters/osgi/OSGi.xml b/documentation/src/main/docbook/devguide/en-US/chapters/osgi/OSGi.xml
@@ -84,7 +84,8 @@
 		            <listitem>
 		                <para>
 		                    <literal>org.hibernate.proxy</literal> and <literal>javassist.util.proxy</literal>, due to
-		                    Hibernate's ability to return proxies for lazy initialization
+		                    Hibernate's ability to return proxies for lazy initialization (Javassist enhancement
+		                    occurs on the entity's ClassLoader during runtime).
 		                </para>
 		            </listitem>
 		        </itemizedlist>
@@ -151,7 +152,8 @@
 		            <listitem>
 		                <para>
 		                    <literal>org.hibernate.proxy</literal> and <literal>javassist.util.proxy</literal>, due to
-		                    Hibernate's ability to return proxies for lazy initialization
+		                    Hibernate's ability to return proxies for lazy initialization (Javassist enhancement
+		                    occurs on the entity's ClassLoader during runtime)
 		                </para>
 		            </listitem>
 		            <listitem>
@@ -219,7 +221,8 @@
 		            <listitem>
 		                <para>
 		                    <literal>org.hibernate.proxy</literal> and <literal>javassist.util.proxy</literal>, due to
-		                    Hibernate's ability to return proxies for lazy initialization
+		                    Hibernate's ability to return proxies for lazy initialization (Javassist enhancement
+		                    occurs on the entity's ClassLoader during runtime)
 		                </para>
 		            </listitem>
 		            <listitem>
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/managed-jpa/.gitignore b/documentation/src/main/docbook/quickstart/tutorials/osgi/managed-jpa/.gitignore
@@ -0,0 +1 @@
+/target
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/managed-jpa/pom.xml b/documentation/src/main/docbook/quickstart/tutorials/osgi/managed-jpa/pom.xml
@@ -49,6 +49,8 @@
                             org.apache.felix.gogo.commands,
                             org.apache.karaf.shell.console,
                             org.apache.karaf.shell.commands,
+                            javax.persistence;version="[1.0.0,2.1.0]",
+                            <!-- Needed for proxying's Javassist enhancement during runtime -->
                             org.hibernate.proxy,
                             javassist.util.proxy,
                             * 
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-jpa/.gitignore b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-jpa/.gitignore
@@ -0,0 +1 @@
+/target
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-jpa/pom.xml b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-jpa/pom.xml
@@ -61,6 +61,8 @@
                             org.apache.karaf.shell.console,
                             org.apache.karaf.shell.commands,
                             org.h2,
+                            javax.persistence;version="[1.0.0,2.1.0]",
+                            <!-- Needed for proxying's Javassist enhancement during runtime -->
                             org.hibernate.proxy,
                             javassist.util.proxy,
                             * 
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/.gitignore b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/.gitignore
@@ -0,0 +1 @@
+/target
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/pom.xml b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/pom.xml
@@ -64,6 +64,8 @@
                             org.hibernate,
                             org.hibernate.cfg,
                             org.hibernate.service,
+                            javax.persistence;version="[1.0.0,2.1.0]",
+                            <!-- Needed for proxying's Javassist enhancement during runtime -->
                             org.hibernate.proxy,
                             javassist.util.proxy,
                             * 
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/DataPointService.java b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/DataPointService.java
@@ -35,6 +35,8 @@ public interface DataPointService {
 
 	public DataPoint get(long id);
 
+	public DataPoint load(long id);
+
 	public List<DataPoint> getAll();
 
 	public void deleteAll();
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/DataPointServiceImpl.java b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/DataPointServiceImpl.java
@@ -22,6 +22,7 @@
 
 import java.util.List;
 
+import org.hibernate.Hibernate;
 import org.hibernate.Session;
 import org.hibernate.criterion.Restrictions;
 import org.hibernate.osgitest.entity.DataPoint;
@@ -57,6 +58,18 @@ public DataPoint get(long id) {
 		return dp;
 	}
 
+	// Test lazy loading (mainly to make sure the proxy classes work in OSGi)
+	public DataPoint load(long id) {
+		Session s = HibernateUtil.getSession();
+		s.getTransaction().begin();
+		DataPoint dp = (DataPoint) s.load( DataPoint.class, new Long(id) );
+		// initialize
+		dp.getName();
+		s.getTransaction().commit();
+		s.close();
+		return dp;
+	}
+
 	public List<DataPoint> getAll() {
 		Session s = HibernateUtil.getSession();
 		s.getTransaction().begin();
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/command/GetCommand.java b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/command/GetCommand.java
@@ -0,0 +1,43 @@
+/*
+ * 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.hibernate.osgitest.command;
+
+import org.apache.felix.gogo.commands.Action;
+import org.apache.felix.gogo.commands.Argument;
+import org.apache.felix.gogo.commands.Command;
+import org.apache.felix.service.command.CommandSession;
+import org.hibernate.osgitest.DataPointService;
+import org.hibernate.osgitest.entity.DataPoint;
+
+@Command(scope = "dp", name = "get")
+public class GetCommand implements Action {
+	@Argument(index = 0, name = "Id", required = true, description = "Id", multiValued = false)
+	String id;
+
+	private DataPointService dpService;
+
+	public void setDpService(DataPointService dpService) {
+		this.dpService = dpService;
+	}
+
+	public Object execute(CommandSession session) throws Exception {
+		DataPoint dp = dpService.get( Long.valueOf( id ) );
+		System.out.println( dp.getId() + ", " + dp.getName() );
+		return null;
+	}
+
+}
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/command/LoadCommand.java b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/command/LoadCommand.java
@@ -0,0 +1,43 @@
+/*
+ * 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.hibernate.osgitest.command;
+
+import org.apache.felix.gogo.commands.Action;
+import org.apache.felix.gogo.commands.Argument;
+import org.apache.felix.gogo.commands.Command;
+import org.apache.felix.service.command.CommandSession;
+import org.hibernate.osgitest.DataPointService;
+import org.hibernate.osgitest.entity.DataPoint;
+
+@Command(scope = "dp", name = "load")
+public class LoadCommand implements Action {
+	@Argument(index = 0, name = "Id", required = true, description = "Id", multiValued = false)
+	String id;
+
+	private DataPointService dpService;
+
+	public void setDpService(DataPointService dpService) {
+		this.dpService = dpService;
+	}
+
+	public Object execute(CommandSession session) throws Exception {
+		DataPoint dp = dpService.load( Long.valueOf( id ) );
+		System.out.println( dp.getId() + ", " + dp.getName() );
+		return null;
+	}
+
+}
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/entity/DataPoint.java b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/java/org/hibernate/osgitest/entity/DataPoint.java
@@ -20,6 +20,8 @@
  */
 package org.hibernate.osgitest.entity;
 
+import java.io.Serializable;
+
 import javax.persistence.Entity;
 import javax.persistence.GeneratedValue;
 import javax.persistence.Id;
@@ -28,7 +30,7 @@
  * @author Brett Meyer
  */
 @Entity
-public class DataPoint {
+public class DataPoint implements Serializable {
 	@Id
 	@GeneratedValue
 	private long id;
diff --git a/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/resources/OSGI-INF/blueprint/blueprint.xml b/documentation/src/main/docbook/quickstart/tutorials/osgi/unmanaged-native/src/main/resources/OSGI-INF/blueprint/blueprint.xml
@@ -43,6 +43,16 @@
                 <property name="dpService" ref="dpService"/>
             </action>
         </command>
+        <command name="dp:get">
+            <action class="org.hibernate.osgitest.command.GetCommand">
+                <property name="dpService" ref="dpService"/>
+            </action>
+        </command>
+        <command name="dp:load">
+            <action class="org.hibernate.osgitest.command.LoadCommand">
+                <property name="dpService" ref="dpService"/>
+            </action>
+        </command>
         <command name="dp:getAll">
             <action class="org.hibernate.osgitest.command.GetAllCommand">
                 <property name="dpService" ref="dpService"/>

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@`
`49`	`49`	`org.apache.felix.gogo.commands,`
`50`	`50`	`org.apache.karaf.shell.console,`
`51`	`51`	`org.apache.karaf.shell.commands,`
	`52`	`+ javax.persistence;version="[1.0.0,2.1.0]",`
	`53`	`+ <!-- Needed for proxying's Javassist enhancement during runtime -->`
`52`	`54`	`org.hibernate.proxy,`
`53`	`55`	`javassist.util.proxy,`
`54`	`56`	`*`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,8 @@`
`61`	`61`	`org.apache.karaf.shell.console,`
`62`	`62`	`org.apache.karaf.shell.commands,`
`63`	`63`	`org.h2,`
	`64`	`+ javax.persistence;version="[1.0.0,2.1.0]",`
	`65`	`+ <!-- Needed for proxying's Javassist enhancement during runtime -->`
`64`	`66`	`org.hibernate.proxy,`
`65`	`67`	`javassist.util.proxy,`
`66`	`68`	`*`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@`
`64`	`64`	`org.hibernate,`
`65`	`65`	`org.hibernate.cfg,`
`66`	`66`	`org.hibernate.service,`
	`67`	`+ javax.persistence;version="[1.0.0,2.1.0]",`
	`68`	`+ <!-- Needed for proxying's Javassist enhancement during runtime -->`
`67`	`69`	`org.hibernate.proxy,`
`68`	`70`	`javassist.util.proxy,`
`69`	`71`	`*`