From a1e7dc60ee348e63620b14cbb6a334e179ebc011 Mon Sep 17 00:00:00 2001
From: Keith Donald <kdonald@vmware.com>
Date: Thu, 24 Apr 2008 20:16:32 +0000
Subject: [PATCH] session && entityManager -> persistenceContext

---
 .../HibernateFlowExecutionListener.java       | 19 ++++++++++---------
 .../persistence/JpaFlowExecutionListener.java | 17 +++++++++--------
 .../HibernateFlowExecutionListenerTests.java  |  2 +-
 ...lowManagedPersistenceIntegrationTests.java |  2 +-
 ...lowManagedPersistenceIntegrationTests.java |  2 +-
 5 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/spring-webflow/src/main/java/org/springframework/webflow/persistence/HibernateFlowExecutionListener.java b/spring-webflow/src/main/java/org/springframework/webflow/persistence/HibernateFlowExecutionListener.java
index b848bfcf..a4a93251 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/persistence/HibernateFlowExecutionListener.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/persistence/HibernateFlowExecutionListener.java
@@ -40,7 +40,8 @@ import org.springframework.webflow.execution.RequestContext;
  * <p>
  * The general pattern is as follows:
  * <ul>
- * <li>When a flow execution starts, create a new Hibernate Session and bind it to flow scope.
+ * <li>When a flow execution starts, create a new Hibernate Session and bind it to flow scope under the name
+ * {@link #PERSISTENCE_CONTEXT_ATTRIBUTE}.
  * <li>Before processing a flow execution request, expose the conversationally-bound session as the "current session"
  * for the current thread.
  * <li>When an existing flow pauses, unbind the session from the current thread.
@@ -68,16 +69,16 @@ import org.springframework.webflow.execution.RequestContext;
  * canceled before it ends. Generally, the only time a read-write transaction should be started is upon successful
  * completion of the conversation, triggered by reaching a 'commit' end state.
  * 
- * @author Ben Hale
  * @author Keith Donald
  * @author Juergen Hoeller
- * @since 1.1
+ * @author Ben Hale
  */
 public class HibernateFlowExecutionListener extends FlowExecutionListenerAdapter {
 
-	private static final String PERSISTENCE_CONTEXT_ATTRIBUTE = "persistenceContext";
-
-	private static final String HIBERNATE_SESSION_ATTRIBUTE = "session";
+	/**
+	 * The name of the attribute the flow {@link Session persistence context} is indexed under.
+	 */
+	public static final String PERSISTENCE_CONTEXT_ATTRIBUTE = "persistenceContext";
 
 	private SessionFactory sessionFactory;
 
@@ -112,7 +113,7 @@ public class HibernateFlowExecutionListener extends FlowExecutionListenerAdapter
 		}
 		if (isPersistenceContext(session.getDefinition())) {
 			Session hibernateSession = createSession(context);
-			session.getScope().put(HIBERNATE_SESSION_ATTRIBUTE, hibernateSession);
+			session.getScope().put(PERSISTENCE_CONTEXT_ATTRIBUTE, hibernateSession);
 			bind(hibernateSession);
 		}
 	}
@@ -133,7 +134,7 @@ public class HibernateFlowExecutionListener extends FlowExecutionListenerAdapter
 
 	public void sessionEnded(RequestContext context, FlowSession session, String outcome, AttributeMap output) {
 		if (isPersistenceContext(session.getDefinition())) {
-			final Session hibernateSession = (Session) session.getScope().remove(HIBERNATE_SESSION_ATTRIBUTE);
+			final Session hibernateSession = (Session) session.getScope().remove(PERSISTENCE_CONTEXT_ATTRIBUTE);
 			Boolean commitStatus = session.getState().getAttributes().getBoolean("commit");
 			if (Boolean.TRUE.equals(commitStatus)) {
 				transactionTemplate.execute(new TransactionCallbackWithoutResult() {
@@ -177,7 +178,7 @@ public class HibernateFlowExecutionListener extends FlowExecutionListenerAdapter
 	}
 
 	private Session getHibernateSession(FlowSession session) {
-		return (Session) session.getScope().get(HIBERNATE_SESSION_ATTRIBUTE);
+		return (Session) session.getScope().get(PERSISTENCE_CONTEXT_ATTRIBUTE);
 	}
 
 	private void bind(Session session) {
diff --git a/spring-webflow/src/main/java/org/springframework/webflow/persistence/JpaFlowExecutionListener.java b/spring-webflow/src/main/java/org/springframework/webflow/persistence/JpaFlowExecutionListener.java
index 69c34804..719f5c1f 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/persistence/JpaFlowExecutionListener.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/persistence/JpaFlowExecutionListener.java
@@ -39,7 +39,8 @@ import org.springframework.webflow.execution.RequestContext;
  * <p>
  * This implementation uses standard JPA APIs. The general pattern is as follows:
  * <ul>
- * <li>When a flow execution starts, create a new JPA persistence context and bind it to flow scope.
+ * <li>When a flow execution starts, create a new JPA persistence context and bind it to flow scope under the name
+ * {@link #PERSISTENCE_CONTEXT_ATTRIBUTE}.
  * <li>Before processing a flow execution request, expose the flow-scoped persistence context as the "current"
  * persistence context for the current thread.
  * <li>When an existing flow pauses, unbind the persistence context from the current thread.
@@ -71,13 +72,13 @@ import org.springframework.webflow.execution.RequestContext;
  * 
  * @author Keith Donald
  * @author Juergen Hoeller
- * @since 1.1
  */
 public class JpaFlowExecutionListener extends FlowExecutionListenerAdapter {
 
-	private static final String PERSISTENCE_CONTEXT_ATTRIBUTE = "persistenceContext";
-
-	private static final String ENTITY_MANAGER_ATTRIBUTE = "entityManager";
+	/**
+	 * The name of the attribute the flow {@link EntityManager persistence context} is indexed under.
+	 */
+	public static final String PERSISTENCE_CONTEXT_ATTRIBUTE = "persistenceContext";
 
 	private EntityManagerFactory entityManagerFactory;
 
@@ -102,7 +103,7 @@ public class JpaFlowExecutionListener extends FlowExecutionListenerAdapter {
 		}
 		if (isPersistenceContext(session.getDefinition())) {
 			EntityManager em = entityManagerFactory.createEntityManager();
-			session.getScope().put(ENTITY_MANAGER_ATTRIBUTE, em);
+			session.getScope().put(PERSISTENCE_CONTEXT_ATTRIBUTE, em);
 			bind(em);
 		}
 	}
@@ -121,7 +122,7 @@ public class JpaFlowExecutionListener extends FlowExecutionListenerAdapter {
 
 	public void sessionEnded(RequestContext context, FlowSession session, String outcome, AttributeMap output) {
 		if (isPersistenceContext(session.getDefinition())) {
-			final EntityManager em = (EntityManager) session.getScope().remove(ENTITY_MANAGER_ATTRIBUTE);
+			final EntityManager em = (EntityManager) session.getScope().remove(PERSISTENCE_CONTEXT_ATTRIBUTE);
 			Boolean commitStatus = session.getState().getAttributes().getBoolean("commit");
 			if (Boolean.TRUE.equals(commitStatus)) {
 				transactionTemplate.execute(new TransactionCallbackWithoutResult() {
@@ -156,7 +157,7 @@ public class JpaFlowExecutionListener extends FlowExecutionListenerAdapter {
 	}
 
 	private EntityManager getEntityManager(FlowSession session) {
-		return (EntityManager) session.getScope().get(ENTITY_MANAGER_ATTRIBUTE);
+		return (EntityManager) session.getScope().get(PERSISTENCE_CONTEXT_ATTRIBUTE);
 	}
 
 	private void bind(EntityManager em) {
diff --git a/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowExecutionListenerTests.java b/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowExecutionListenerTests.java
index 9fb06d47..82e78e8c 100644
--- a/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowExecutionListenerTests.java
+++ b/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowExecutionListenerTests.java
@@ -75,7 +75,7 @@ public class HibernateFlowExecutionListenerTests extends TestCase {
 		assertSessionBound();
 
 		// Session created and bound to conversation
-		final Session hibSession = (Session) flowSession.getScope().get("session");
+		final Session hibSession = (Session) flowSession.getScope().get("persistenceContext");
 		assertNotNull("Should have been populated", hibSession);
 		hibernateListener.paused(context);
 		assertSessionNotBound();
diff --git a/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowManagedPersistenceIntegrationTests.java b/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowManagedPersistenceIntegrationTests.java
index fd18d17c..098f8bb8 100644
--- a/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowManagedPersistenceIntegrationTests.java
+++ b/spring-webflow/src/test/java/org/springframework/webflow/persistence/HibernateFlowManagedPersistenceIntegrationTests.java
@@ -63,7 +63,7 @@ public class HibernateFlowManagedPersistenceIntegrationTests extends TestCase {
 		context.registerBean("loadTestBean", new Action() {
 			public Event execute(RequestContext context) throws Exception {
 				assertSessionBound();
-				Session session = (Session) context.getFlowScope().get("session");
+				Session session = (Session) context.getFlowScope().get("persistenceContext");
 				TestBean bean = (TestBean) session.get(TestBean.class, new Long(0));
 				assertNotNull(bean);
 				context.getFlowScope().put("testBean", bean);
diff --git a/spring-webflow/src/test/java/org/springframework/webflow/persistence/JpaFlowManagedPersistenceIntegrationTests.java b/spring-webflow/src/test/java/org/springframework/webflow/persistence/JpaFlowManagedPersistenceIntegrationTests.java
index 73c6947f..a3025391 100644
--- a/spring-webflow/src/test/java/org/springframework/webflow/persistence/JpaFlowManagedPersistenceIntegrationTests.java
+++ b/spring-webflow/src/test/java/org/springframework/webflow/persistence/JpaFlowManagedPersistenceIntegrationTests.java
@@ -58,7 +58,7 @@ public class JpaFlowManagedPersistenceIntegrationTests extends TestCase {
 		context.registerBean("loadTestBean", new Action() {
 			public Event execute(RequestContext context) throws Exception {
 				assertSessionBound();
-				EntityManager em = (EntityManager) context.getFlowScope().get("entityManager");
+				EntityManager em = (EntityManager) context.getFlowScope().get("persistenceContext");
 				TestBean bean = (TestBean) em.getReference(TestBean.class, new Integer(0));
 				assertNotNull(bean);
 				context.getFlowScope().put("testBean", bean);