All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.webflow.test.MockFlowBuilderContext Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * Copyright 2004-2012 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.test;

import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.webflow.core.collection.AttributeMap;
import org.springframework.webflow.core.collection.CollectionUtils;
import org.springframework.webflow.definition.registry.FlowDefinitionRegistryImpl;
import org.springframework.webflow.engine.Flow;
import org.springframework.webflow.engine.builder.support.FlowBuilderContextImpl;

/**
 * A stub flow service locator implementation suitable for a test environment.
 * 

* Allows programmatic registration of subflows needed by a flow execution being tested, see * {@link #registerSubflow(Flow)}. Subflows registered are typically stubs that verify parent flow input and output * scenarios. *

* Also supports programmatic registration of additional custom services needed by a flow (such as Actions) managed in a * backing Spring {@link ConfigurableBeanFactory}. See the {@link #registerBean(String, Object)} method. Beans * registered are typically mocks or stubs of business services invoked by the flow. * * @author Keith Donald */ public class MockFlowBuilderContext extends FlowBuilderContextImpl { /** * Creates a new mock flow service locator. */ public MockFlowBuilderContext(String flowId) { this(flowId, CollectionUtils.EMPTY_ATTRIBUTE_MAP); } /** * Creates a new mock flow service locator. */ public MockFlowBuilderContext(String flowId, AttributeMap attributes) { super(flowId, attributes, new FlowDefinitionRegistryImpl(), TestFlowBuilderServicesFactory.getServices()); } /** * Register a subflow definition in the backing flow registry, typically to support a flow execution test. For test * scenarios, the subflow is often a stub used to verify parent flow input and output mapping behavior. * @param subflow the subflow */ public void registerSubflow(Flow subflow) { ((FlowDefinitionRegistryImpl) getFlowDefinitionLocator()).registerFlowDefinition(subflow); } /** * Register a bean in the backing bean factory, typically to support a flow execution test. For test scenarios, if * the bean is a service invoked by a bean invoking action it is often a stub or dynamic mock implementation of the * service's business interface. * @param beanName the bean name * @param bean the singleton instance */ public void registerBean(String beanName, Object bean) { ((ConfigurableApplicationContext) getApplicationContext()).getBeanFactory().registerSingleton(beanName, bean); } }