org.springframework.webflow.config.AbstractFlowConfiguration Maven / Gradle / Ivy
/*
* Copyright 2004-2014 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;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.annotation.Configuration;
import org.springframework.webflow.definition.registry.FlowDefinitionLocator;
import org.springframework.webflow.definition.registry.FlowDefinitionRegistry;
import org.springframework.webflow.engine.builder.support.FlowBuilderServices;
import org.springframework.webflow.executor.FlowExecutor;
/**
* A base class for {@link Configuration @Configuration} classes to configure
* Spring Web Flow.
*
* Does not provides any configuration (i.e. no {@code @Bean} methods}.
* Instead it provides access, via protected methods, to builders for one (or more)
* of the following:
*
* - {@link FlowExecutor}
*
- {@link FlowDefinitionRegistry}
*
- {@link FlowBuilderServices}
*
*
* Sub-classes are expected to declare {@code @Bean} methods themselves and use the
* appropriate builder from these methods.
* @author Rossen Stoyanchev
* @since 2.4
*/
public class AbstractFlowConfiguration implements ApplicationContextAware {
private ApplicationContext applicationContext;
public void setApplicationContext(ApplicationContext applicationContext) {
this.applicationContext = applicationContext;
}
public ApplicationContext getApplicationContext() {
return this.applicationContext;
}
/**
* Return a builder for creating a {@link FlowExecutor} instance.
* @param flowRegistry the {@link FlowDefinitionRegistry} to configure on the flow executor
* @return the created builder
*/
protected FlowExecutorBuilder getFlowExecutorBuilder(FlowDefinitionLocator flowRegistry) {
return new FlowExecutorBuilder(flowRegistry, this.applicationContext);
}
/**
* Return a builder for creating a {@link FlowDefinitionRegistry} instance.
* @return the created builder
*/
protected FlowDefinitionRegistryBuilder getFlowDefinitionRegistryBuilder() {
return new FlowDefinitionRegistryBuilder(this.applicationContext);
}
/**
* Return a builder for creating a {@link FlowDefinitionRegistry} instance.
* @param flowBuilderServices the {@link FlowBuilderServices} to configure on the flow registry with
* @return the created builder
*/
protected FlowDefinitionRegistryBuilder getFlowDefinitionRegistryBuilder(FlowBuilderServices flowBuilderServices) {
return new FlowDefinitionRegistryBuilder(this.applicationContext, flowBuilderServices);
}
/**
* Return a builder for creating a {@link FlowBuilderServices} instance.
* @return the created builder
*/
protected FlowBuilderServicesBuilder getFlowBuilderServicesBuilder() {
return new FlowBuilderServicesBuilder(this.applicationContext);
}
}