org.springframework.webflow.engine.impl.FlowExecutionImplStateRestorer Maven / Gradle / Ivy
/*
* Copyright 2002-2006 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.engine.impl;
import java.util.ListIterator;
import java.util.Map;
import org.springframework.util.Assert;
import org.springframework.webflow.core.collection.AttributeMap;
import org.springframework.webflow.core.collection.CollectionUtils;
import org.springframework.webflow.core.collection.LocalAttributeMap;
import org.springframework.webflow.core.collection.MutableAttributeMap;
import org.springframework.webflow.definition.registry.FlowDefinitionLocator;
import org.springframework.webflow.engine.Flow;
import org.springframework.webflow.execution.FlowExecution;
import org.springframework.webflow.execution.factory.FlowExecutionListenerLoader;
import org.springframework.webflow.execution.factory.StaticFlowExecutionListenerLoader;
import org.springframework.webflow.execution.repository.support.FlowExecutionStateRestorer;
/**
* Restores the transient state of deserialized {@link FlowExecutionImpl}
* objects.
*
* @author Keith Donald
*/
public class FlowExecutionImplStateRestorer implements FlowExecutionStateRestorer {
/**
* Used to restore the flow execution's flow definition.
*/
private FlowDefinitionLocator definitionLocator;
/**
* Used to restore the flow execution's listeners.
*/
private FlowExecutionListenerLoader executionListenerLoader = StaticFlowExecutionListenerLoader.EMPTY_INSTANCE;
/**
* Used to restore the flow execution's system attributes.
*/
private AttributeMap executionAttributes = CollectionUtils.EMPTY_ATTRIBUTE_MAP;
/**
* Creates a new execution transient state restorer.
* @param definitionLocator the flow definition locator
*/
public FlowExecutionImplStateRestorer(FlowDefinitionLocator definitionLocator) {
Assert.notNull(definitionLocator, "The flow definition locator is required");
this.definitionLocator = definitionLocator;
}
/**
* Sets the attributes to apply to restored flow executions.
* Execution attributes may affect flow execution behavior.
* @param executionAttributes flow execution system attributes
*/
public void setExecutionAttributes(AttributeMap executionAttributes) {
Assert.notNull(executionAttributes, "The execution attributes map is required");
this.executionAttributes = executionAttributes;
}
/**
* Sets the attributes to apply to restored flow executions.
* Execution attributes may affect flow execution behavior.
*
* Convenience setter that takes a simple java.util.Map to ease
* bean style configuration.
* @param executionAttributes flow execution system attributes
*/
public void setExecutionAttributesMap(Map executionAttributes) {
Assert.notNull(executionAttributes, "The execution attributes map is required");
this.executionAttributes = new LocalAttributeMap(executionAttributes);
}
/**
* Sets the strategy for loading listeners that should observe executions of
* a flow definition. Allows full control over what listeners should apply.
* for executions of a flow definition.
*/
public void setExecutionListenerLoader(FlowExecutionListenerLoader executionListenerLoader) {
Assert.notNull(executionListenerLoader, "The listener loader is required");
this.executionListenerLoader = executionListenerLoader;
}
public FlowExecution restoreState(FlowExecution flowExecution, MutableAttributeMap conversationScope) {
FlowExecutionImpl impl = (FlowExecutionImpl)flowExecution;
// the root flow should be a top-level flow visible by the flow def locator
Flow flow = (Flow)definitionLocator.getFlowDefinition(impl.getFlowId());
impl.setFlow(flow);
if (impl.hasSessions()) {
FlowSessionImpl root = impl.getRootSession();
root.setFlow(flow);
root.setState(flow.getStateInstance(root.getStateId()));
if (impl.hasSubflowSessions()) {
Flow parent = flow;
for (ListIterator it = impl.getSubflowSessionIterator(); it.hasNext();) {
FlowSessionImpl subflow = (FlowSessionImpl)it.next();
Flow definition;
if (parent.containsInlineFlow(subflow.getFlowId())) {
// subflow is an inline flow of it's parent
definition = parent.getInlineFlow(subflow.getFlowId());
} else {
// subflow is a top-level flow
definition = (Flow)definitionLocator.getFlowDefinition(subflow.getFlowId());
}
subflow.setFlow(definition);
subflow.setState(definition.getStateInstance(subflow.getStateId()));
parent = definition;
}
}
}
if (conversationScope == null) {
conversationScope = new LocalAttributeMap();
}
impl.setConversationScope(conversationScope);
impl.setListeners(new FlowExecutionListeners(executionListenerLoader.getListeners(flow)));
impl.setAttributes(executionAttributes);
return flowExecution;
}
}