- * Subclasses simply need to implement {@link #getScope()} to instruct this - * class which {@link FlowExecutionContext} scope to read attributes from. - * + * Subclasses simply need to implement {@link #getScope()} to return the + * {@link MutableAttributeMap scope map} to access. *
* Relies on a thread-bound
- * @{link FlowExecutionContext} instance wich is located through a
+ * @{link FlowExecutionContext} instance located through the
* @{link FlowExecutionContextHolder}.
*
* @see FlowExecutionContext
@@ -50,48 +48,39 @@ public abstract class AbstractWebFlowScope implements Scope {
*/
protected final Log logger = LogFactory.getLog(getClass());
- /**
- * Template method that determines the actual target scope.
- * @return the target scope
- * @see RequestContext#getConversationScope()
- * @see RequestContext#getFlowScope()
- * @see RequestContext#getRequestScope()
- * @see RequestContext#getFlashScope()
- */
- protected abstract MutableAttributeMap getScope();
-
public Object get(String name, ObjectFactory objectFactory) {
- MutableAttributeMap scope;
- try {
- scope = getScope();
- } catch (IllegalStateException e) {
- throw new ScopedBeanException("Cannot retrieve scoped bean '" + name
- + "' before the scope has been populated");
- }
+ MutableAttributeMap scope = getScope();
Object scopedObject = scope.get(name);
if (scopedObject == null) {
if (logger.isDebugEnabled()) {
- logger.debug("Could not find existing scoped instance of '" + name + "'; creating new instace");
+ logger.debug("No scoped instance '" + name + "' found; creating new instance");
}
scopedObject = objectFactory.getObject();
scope.put(name, scopedObject);
- } else {
+ }
+ else {
if (logger.isDebugEnabled()) {
- logger.debug("Found existing scoped instance of '" + name + "'");
+ logger.debug("Returning scoped instance '" + name + "'");
}
}
return scopedObject;
}
public Object remove(String name) {
- try {
- return getScope().remove(name);
- } catch (IllegalStateException e) {
- throw new ScopedBeanException("Cannot remove scoped bean '" + name
- + "' before the scope has been populated");
- }
+ return getScope().remove(name);
}
+ /**
+ * Template method that returns the target scope map.
+ * @return the target scope map
+ * @see FlowExecutionContext#getConversationScope()
+ * @see FlowExecutionContext#getActiveSession()
+ * @see FlowSession#getFlashMap()
+ * @see FlowSession#getScope()
+ * @throws IllegalStateException if the scope could not be accessed
+ */
+ protected abstract MutableAttributeMap getScope() throws IllegalStateException;
+
/**
* Always returns null as most Spring Web Flow scopes do not
* have obvious conversation ids. Subclasses should override this method
@@ -118,8 +107,9 @@ public abstract class AbstractWebFlowScope implements Scope {
* Returns the current flow execution context. Used by subclasses to easily
* get access to the thread-bound flow execution context.
* @return the current thread-bound flow execution context
+ * @throws IllegalStateException if the current flow execution context is not bound
*/
- protected FlowExecutionContext getFlowExecutionContext() {
+ protected FlowExecutionContext getFlowExecutionContext() throws IllegalStateException {
return FlowExecutionContextHolder.getFlowExecutionContext();
}
diff --git a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ConversationScope.java b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ConversationScope.java
index 95c2684f..50605759 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ConversationScope.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ConversationScope.java
@@ -28,9 +28,7 @@ import org.springframework.webflow.execution.FlowExecution;
* @since 1.1
*/
public class ConversationScope extends AbstractWebFlowScope {
-
protected MutableAttributeMap getScope() {
return getFlowExecutionContext().getConversationScope();
}
-
}
diff --git a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlashScope.java b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlashScope.java
index d2c506cb..51cb6d9e 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlashScope.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlashScope.java
@@ -28,9 +28,7 @@ import org.springframework.webflow.execution.FlowSession;
* @since 1.1
*/
public class FlashScope extends AbstractWebFlowScope {
-
protected MutableAttributeMap getScope() {
return getFlowExecutionContext().getActiveSession().getFlashMap();
}
-
}
diff --git a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlowScope.java b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlowScope.java
index 32b769b9..fe68264d 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlowScope.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/FlowScope.java
@@ -28,9 +28,7 @@ import org.springframework.webflow.execution.FlowSession;
* @since 1.1
*/
public class FlowScope extends AbstractWebFlowScope {
-
protected MutableAttributeMap getScope() {
return getFlowExecutionContext().getActiveSession().getScope();
}
-
}
diff --git a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ScopedBeanException.java b/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ScopedBeanException.java
deleted file mode 100644
index 3e9cb8ad..00000000
--- a/spring-webflow/src/main/java/org/springframework/webflow/config/scope/ScopedBeanException.java
+++ /dev/null
@@ -1,47 +0,0 @@
-/*
- * Copyright 2004-2007 the original author or authors.
- *
- * Licensed 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.springframework.webflow.config.scope;
-
-import org.springframework.webflow.core.FlowException;
-
-/**
- * Thrown when a bean cannot be retrieved because the scope it resides in has
- * not yet been populated. This might occur if the bean is being referenced
- * before the FlowExecution has been retrieved.
- *
- * @author Ben Hale
- * @since 1.1
- */
-public class ScopedBeanException extends FlowException {
-
- /**
- * Create a new scoped bean exception.
- * @param message the message
- * @param cause the root cause of the failure
- */
- public ScopedBeanException(String message, Throwable cause) {
- super(message, cause);
- }
-
- /**
- * Create a new scoped bean exception.
- * @param message the message
- */
- public ScopedBeanException(String message) {
- super(message);
- }
-
-}
diff --git a/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionContextHolder.java b/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionContextHolder.java
index cbe4c413..4b9fea15 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionContextHolder.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionContextHolder.java
@@ -51,7 +51,7 @@ public class FlowExecutionContextHolder {
* @throws IllegalStateException if no FlowExecutionContext is bound to this
* thread
*/
- public static FlowExecutionContext getFlowExecutionContext() {
+ public static FlowExecutionContext getFlowExecutionContext() throws IllegalStateException {
Assert.state(flowExecutionContextHolder.get() != null,
"No flow execution context is bound to this thread");
return (FlowExecutionContext) flowExecutionContextHolder.get();
diff --git a/spring-webflow/src/test/java/org/springframework/webflow/config/scope/ConversationScopeTests.java b/spring-webflow/src/test/java/org/springframework/webflow/config/scope/ConversationScopeTests.java
index b4f131a1..d78cf1dd 100644
--- a/spring-webflow/src/test/java/org/springframework/webflow/config/scope/ConversationScopeTests.java
+++ b/spring-webflow/src/test/java/org/springframework/webflow/config/scope/ConversationScopeTests.java
@@ -70,8 +70,8 @@ public class ConversationScopeTests extends TestCase {
StubObjectFactory factory = new StubObjectFactory();
try {
scope.get("name", factory);
- fail("Should have thrown a ScopedBeanException without a request context");
- } catch (ScopedBeanException e) {
+ fail("Should have thrown a IllegalStateException without a request context");
+ } catch (IllegalStateException e) {
}
}
@@ -98,8 +98,8 @@ public class ConversationScopeTests extends TestCase {
FlowExecutionContextHolder.setFlowExecutionContext(null);
try {
scope.remove("name");
- fail("Should have thrown a ScopedBeanException without a request context");
- } catch (ScopedBeanException e) {
+ fail("Should have thrown a IllegalStateException without a request context");
+ } catch (IllegalStateException e) {
}
}
diff --git a/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlashScopeTests.java b/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlashScopeTests.java
index 8bdb07f7..931553c0 100644
--- a/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlashScopeTests.java
+++ b/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlashScopeTests.java
@@ -70,8 +70,8 @@ public class FlashScopeTests extends TestCase {
StubObjectFactory factory = new StubObjectFactory();
try {
scope.get("name", factory);
- fail("Should have thrown a ScopedBeanException without a request context");
- } catch (ScopedBeanException e) {
+ fail("Should have thrown a IllegalStateException without a request context");
+ } catch (IllegalStateException e) {
}
}
@@ -100,8 +100,8 @@ public class FlashScopeTests extends TestCase {
FlowExecutionContextHolder.setFlowExecutionContext(null);
try {
scope.remove("name");
- fail("Should have thrown a ScopedBeanException without a request context");
- } catch (ScopedBeanException e) {
+ fail("Should have thrown a IllegalStateException without a request context");
+ } catch (IllegalStateException e) {
}
}
diff --git a/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlowScopeTests.java b/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlowScopeTests.java
index 6fdb8405..baa76465 100644
--- a/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlowScopeTests.java
+++ b/spring-webflow/src/test/java/org/springframework/webflow/config/scope/FlowScopeTests.java
@@ -70,8 +70,7 @@ public class FlowScopeTests extends TestCase {
StubObjectFactory factory = new StubObjectFactory();
try {
scope.get("name", factory);
- fail("Should have thrown a ScopedBeanException without a request context");
- } catch (ScopedBeanException e) {
+ } catch (IllegalStateException e) {
}
}
@@ -98,8 +97,8 @@ public class FlowScopeTests extends TestCase {
FlowExecutionContextHolder.setFlowExecutionContext(null);
try {
scope.remove("name");
- fail("Should have thrown a ScopedBeanException without a request context");
- } catch (ScopedBeanException e) {
+ fail("Should have thrown a IllegalStateException without a request context");
+ } catch (IllegalStateException e) {
}
}