-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SimpleFlowFactoryBean.java
222 lines (189 loc) · 6.33 KB
/
SimpleFlowFactoryBean.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
* Copyright 2012-2022 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
*
* https://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.batch.core.configuration.xml;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.springframework.batch.core.job.flow.Flow;
import org.springframework.batch.core.job.flow.FlowExecutionStatus;
import org.springframework.batch.core.job.flow.FlowExecutor;
import org.springframework.batch.core.job.flow.FlowHolder;
import org.springframework.batch.core.job.flow.State;
import org.springframework.batch.core.job.flow.support.SimpleFlow;
import org.springframework.batch.core.job.flow.support.StateTransition;
import org.springframework.batch.core.job.flow.support.state.AbstractState;
import org.springframework.batch.core.job.flow.support.state.StepState;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;
/**
* Convenience factory for {@link SimpleFlow} instances for use in the XML namespace. It
* replaces the states in the input with proxies that have a unique name formed
* from the flow name and the original state name (unless the name is already in
* that form -- in that case, it is not modified).
*
* @author Dave Syer
* @author Michael Minella
*/
public class SimpleFlowFactoryBean implements FactoryBean<SimpleFlow>, InitializingBean {
private String name;
private List<StateTransition> stateTransitions;
private String prefix;
private Comparator<StateTransition> stateTransitionComparator;
private Class<SimpleFlow> flowType;
/**
* @param stateTransitionComparator {@link Comparator} implementation that addresses
* the ordering of state evaluation.
*/
public void setStateTransitionComparator(Comparator<StateTransition> stateTransitionComparator) {
this.stateTransitionComparator = stateTransitionComparator;
}
/**
* @param flowType Used to inject the type of flow (regular Spring Batch or JSR-352).
*/
public void setFlowType(Class<SimpleFlow> flowType) {
this.flowType = flowType;
}
/**
* The name of the flow that is created by this factory.
* @param name the value of the name
*/
public void setName(String name) {
this.name = name;
this.prefix = name + ".";
}
/**
* The raw state transitions for the flow. They are transformed into
* proxies that have the same behavior but unique names prefixed with the
* flow name.
*
* @param stateTransitions the list of transitions
*/
public void setStateTransitions(List<StateTransition> stateTransitions) {
this.stateTransitions = stateTransitions;
}
/**
* Check mandatory properties (name).
* @throws Exception thrown if error occurs.
*/
@Override
public void afterPropertiesSet() throws Exception {
Assert.hasText(name, "The flow must have a name");
if (flowType == null) {
flowType = SimpleFlow.class;
}
}
/*
* (non-Javadoc)
*
* @see org.springframework.beans.factory.FactoryBean#getObject()
*/
@Override
public SimpleFlow getObject() throws Exception {
SimpleFlow flow = flowType.getConstructor(String.class).newInstance(name);
flow.setStateTransitionComparator(stateTransitionComparator);
List<StateTransition> updatedTransitions = new ArrayList<>();
for (StateTransition stateTransition : stateTransitions) {
State state = getProxyState(stateTransition.getState());
updatedTransitions.add(StateTransition.switchOriginAndDestination(stateTransition, state,
getNext(stateTransition.getNext())));
}
flow.setStateTransitions(updatedTransitions);
flow.afterPropertiesSet();
return flow;
}
private String getNext(String next) {
if (next == null) {
return null;
}
return (next.startsWith(this.prefix) ? "" : this.prefix) + next;
}
/**
* Convenience method to get a state that proxies the input but with a
* different name, appropriate to this flow. If the state is a {@link StepState},
* the step name is also changed.
*
* @param state
* @return
*/
private State getProxyState(State state) {
String oldName = state.getName();
if (oldName.startsWith(prefix)) {
return state;
}
String stateName = prefix + oldName;
if (state instanceof StepState) {
return createNewStepState(state, oldName, stateName);
}
return new DelegateState(stateName, state);
}
/**
* Provides an extension point to provide alternative {@link StepState}
* implementations within a {@link SimpleFlow}.
*
* @param state The state that is used to create the {@code StepState}.
* @param oldName The name to be replaced.
* @param stateName The name for the new State.
* @return a state for the requested data.
*/
protected State createNewStepState(State state, String oldName, String stateName) {
return new StepState(stateName, ((StepState) state).getStep(oldName));
}
@Override
public Class<?> getObjectType() {
return SimpleFlow.class;
}
@Override
public boolean isSingleton() {
return true;
}
/**
* A State that proxies a delegate and changes its name but leaves its behavior
* unchanged.
*
* @author Dave Syer
*
*/
public static class DelegateState extends AbstractState implements FlowHolder {
private final State state;
private DelegateState(String name, State state) {
super(name);
this.state = state;
}
/**
* Gets the current state.
*
* @return The {@link State} being used by the factory bean.
*/
public State getState() {
return this.state;
}
@Override
public boolean isEndState() {
return state.isEndState();
}
@Override
public FlowExecutionStatus handle(FlowExecutor executor) throws Exception {
return state.handle(executor);
}
@Override
public Collection<Flow> getFlows() {
return (state instanceof FlowHolder) ? ((FlowHolder) state).getFlows() : Collections.<Flow>emptyList();
}
}
}