01: /*
02: * Copyright 2004-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.springframework.webflow.execution;
17:
18: import org.springframework.webflow.core.FlowException;
19:
20: /**
21: * Base class for exceptions that occur within a flow while it is executing. Can
22: * be used directly, but you are encouraged to create a specific subclass for a
23: * particular use case.
24: * <p>
25: * Execution exceptions occur at runtime when the flow is executing requests on
26: * behalf of a client. They signal that an execution problem occured: e.g.
27: * action execution failed or no transition matched the current request context.
28: *
29: * @author Keith Donald
30: * @author Erwin Vervaet
31: */
32: public class FlowExecutionException extends FlowException {
33:
34: /**
35: * The id of the flow definition in which the exception occured.
36: */
37: private String flowId;
38:
39: /**
40: * The state of the flow where the exception occured (optional).
41: */
42: private String stateId;
43:
44: /**
45: * Creates a new flow execution exception.
46: * @param flowId the flow where the exception occured
47: * @param stateId the state where the exception occured
48: * @param message a descriptive message
49: */
50: public FlowExecutionException(String flowId, String stateId,
51: String message) {
52: super (message);
53: this .stateId = stateId;
54: this .flowId = flowId;
55: }
56:
57: /**
58: * Creates a new flow execution exception.
59: * @param flowId the flow where the exception occured
60: * @param stateId the state where the exception occured
61: * @param message a descriptive message
62: * @param cause the root cause
63: */
64: public FlowExecutionException(String flowId, String stateId,
65: String message, Throwable cause) {
66: super (message, cause);
67: this .stateId = stateId;
68: this .flowId = flowId;
69: }
70:
71: /**
72: * Returns the id of the flow definition that was executing when this
73: * exception occured.
74: */
75: public String getFlowId() {
76: return flowId;
77: }
78:
79: /**
80: * Returns the id of the state definition where the exception occured. Could
81: * be null if no state was active at the time when the exception was thrown.
82: */
83: public String getStateId() {
84: return stateId;
85: }
86: }
|