+ * A JSF implementation will automatically pass its original resolver into the constructor of a configured resolver, + * provided that there is a corresponding constructor argument. + * + * @param resolverDelegate the original VariableResolver + */ + public FlowExecutionPropertyResolver(PropertyResolver resolverDelegate) { + this.resolverDelegate = resolverDelegate; + } + + public Class getType(Object base, int index) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + return resolverDelegate.getType(base, index); + } + else { + // can't access flow execution property by index - return null + return null; + } + } + + public Class getType(Object base, Object property) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + return resolverDelegate.getType(base, property); + } + if (property == null) { + throw new PropertyNotFoundException("Unable to get value from flow execution - property (key) is null"); + } + if (!(property instanceof String)) { + throw new PropertyNotFoundException("Unable to get value from flow execution - key is non-String"); + } + if ("flashScope".equals(property)) { + return Map.class; + } else if ("flowScope".equals(property)) { + return Map.class; + } else if ("conversationScope".equals(property)) { + return Map.class; + } else { + FlowExecution execution = (FlowExecution)base; + String attributeName = (String)property; + Object value = execution.getActiveSession().getFlashMap().get(attributeName); + if (value != null) { + return value.getClass(); + } + value = execution.getActiveSession().getScope().get(attributeName); + if (value != null) { + return value.getClass(); + } + value = execution.getConversationScope().get(attributeName); + if (value != null) { + return value.getClass(); + } + return null; + } + } + + public Object getValue(Object base, int index) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + return resolverDelegate.getValue(base, index); + } + else { + throw new ReferenceSyntaxException("Cannot apply an index value to flow execution"); + } + } + + public Object getValue(Object base, Object property) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + return resolverDelegate.getValue(base, property); + } + if (!(property instanceof String)) { + throw new PropertyNotFoundException("Unable to get value from flow execution - key is non-String"); + } + FlowExecution execution = (FlowExecution) base; + if ("flashScope".equals(property)) { + return execution.getActiveSession().getScope().asMap(); + } else if ("flowScope".equals(property)) { + return execution.getConversationScope().asMap(); + } else if ("conversationScope".equals(property)) { + return execution.getActiveSession().getFlashMap().asMap(); + } else { + String attributeName = (String)property; + Object value = execution.getActiveSession().getFlashMap().get(attributeName); + if (value != null) { + return value; + } + value = execution.getActiveSession().getScope().get(attributeName); + if (value != null) { + return value; + } + value = execution.getConversationScope().get(attributeName); + if (value != null) { + return value; + } + throw new PropertyNotFoundException("Cannot resolve flow execution property '" + property + "'"); + } + } + + public boolean isReadOnly(Object base, int index) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + return resolverDelegate.isReadOnly(base, index); + } + return false; + } + + public boolean isReadOnly(Object base, Object property) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + return resolverDelegate.isReadOnly(base, property); + } + return false; + } + + public void setValue(Object base, int index, Object value) throws EvaluationException, PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + resolverDelegate.setValue(base, index, value); + } + throw new ReferenceSyntaxException("Cannot apply an index value to a flow execution"); + } + + public void setValue(Object base, Object property, Object value) throws EvaluationException, + PropertyNotFoundException { + if (!(base instanceof FlowExecution)) { + resolverDelegate.setValue(base, property, value); + return; + } + if (property == null || !(property instanceof String) + || ((String)property).length() == 0) { + throw new PropertyNotFoundException( + "Attempt to set flow execution attribute with null name, empty name, or non-String name"); + } + FlowExecution execution = (FlowExecution)base; + String attributeName = (String)property; + if (execution.getActiveSession().getFlashMap().contains(attributeName)) { + execution.getActiveSession().getFlashMap().put(attributeName, value); + } + else if (execution.getActiveSession().getScope().contains(attributeName)) { + execution.getActiveSession().getScope().put(attributeName, value); + } else if (execution.getConversationScope().contains(attributeName)) { + execution.getConversationScope().put(attributeName, value); + } else { + throw new PropertyNotFoundException("Settable flow execution property '" + property + "' not found"); + } + } +} \ No newline at end of file diff --git a/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowExecutionVariableResolver.java b/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowExecutionVariableResolver.java new file mode 100644 index 00000000..134c3245 --- /dev/null +++ b/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowExecutionVariableResolver.java @@ -0,0 +1,83 @@ +/* + * 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.executor.jsf; + +import javax.faces.context.FacesContext; +import javax.faces.el.EvaluationException; +import javax.faces.el.VariableResolver; + +import org.springframework.webflow.execution.FlowExecution; + +/** + * Custom variable resolver that resolves to a thread-bound FlowExecution object for binding expressions prefixed with a + * {@link #FLOW_EXECUTION_VARIABLE_NAME}. For instance "flowExecution.conversationScope.myProperty". + * + * This class is designed to be used with a {@link FlowExecutionPropertyResolver}. + * + * This class is a more flexible alternative to the {@link FlowVariableResolver} which is expected to be used ONLY with + * a {@link FlowPropertyResolver} to resolve flow scope variables. It is more flexible because it provides access to any + * property accessible from a {@link FlowExecution} object. + * + * @author Keith Donald + */ +public class FlowExecutionVariableResolver extends VariableResolver { + + /** + * Name of the flow execution variable. + */ + public static final String FLOW_EXECUTION_VARIABLE_NAME = "flowExecution"; + + /** + * The standard variable resolver to delegate to if this one doesn't apply. + */ + private VariableResolver resolverDelegate; + + /** + * Create a new FlowExecutionVariableResolver, using the given original VariableResolver. + *
+ * A JSF implementation will automatically pass its original resolver into the constructor of a configured resolver, + * provided that there is a corresponding constructor argument. + * + * @param resolverDelegate the original VariableResolver + */ + public FlowExecutionVariableResolver(VariableResolver resolverDelegate) { + this.resolverDelegate = resolverDelegate; + } + + /** + * Return the original VariableResolver that this resolver delegates to. + */ + protected final VariableResolver getResolverDelegate() { + return resolverDelegate; + } + + /** + * Check for the special "flow" variable first, then delegate to the original VariableResolver. + */ + public Object resolveVariable(FacesContext context, String name) throws EvaluationException { + if (!FLOW_EXECUTION_VARIABLE_NAME.equals(name)) { + return resolverDelegate.resolveVariable(context, name); + } + else { + FlowExecutionHolder holder = FlowExecutionHolderUtils.getFlowExecutionHolder(context); + if (holder == null) + throw new EvaluationException("'" + FLOW_EXECUTION_VARIABLE_NAME + + "' variable prefix specified but a FlowExecution is not bound to current thread context: " + + "has the flow ended or expired?"); + return holder.getFlowExecution(); + } + } +} \ No newline at end of file diff --git a/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowVariableResolver.java b/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowVariableResolver.java index 154d9fbc..2528ad3c 100644 --- a/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowVariableResolver.java +++ b/spring-webflow/src/main/java/org/springframework/webflow/executor/jsf/FlowVariableResolver.java @@ -71,7 +71,7 @@ public class FlowVariableResolver extends VariableResolver { FlowExecutionHolder holder = FlowExecutionHolderUtils.getFlowExecutionHolder(context); if (holder == null) throw new EvaluationException( - "'flowScope' variable prefix specified, but a FlowExecution is not bound to current thread context as it should be"); + "'flowScope' variable prefix specified but a FlowExecution is not bound to current thread context - has the flow ended or expired?"); return holder.getFlowExecution(); } }