org.springframework.webflow.executor.FlowExecutor Maven / Gradle / Ivy
/*
* 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.executor;
import org.springframework.webflow.context.ExternalContext;
import org.springframework.webflow.core.FlowException;
import org.springframework.webflow.core.collection.MutableAttributeMap;
/**
* The central facade and entry-point service interface into the Spring Web Flow system for driving the executions of
* flow definitions. This interface defines a coarse-grained system boundary suitable for invocation by most
* clients.
*
* Implementations of this interface abstract away much of the internal complexity of the web flow execution subsystem,
* which consists of launching and resuming managed flow executions.
*
* @author Keith Donald
*/
public interface FlowExecutor {
/**
* Launch a new execution of the flow with the provided id.
* @param flowId the flow definition identifier; should be unique among all top-level flow definitions (required).
* @param input input to pass to the new execution on startup (optional)
* @param context access to the calling environment (required)
*/
public FlowExecutionResult launchExecution(String flowId, MutableAttributeMap input, ExternalContext context)
throws FlowException;
/**
* Resume the flow execution with the provided execution key.
* @param flowExecutionKey the key of a paused execution of the flow definition
* @param context access to the calling environment
*/
public FlowExecutionResult resumeExecution(String flowExecutionKey, ExternalContext context) throws FlowException;
}