-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
AutomaticJobRegistrar.java
211 lines (181 loc) · 5.71 KB
/
AutomaticJobRegistrar.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
/*
* Copyright 2006-2018 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.support;
import java.util.ArrayList;
import java.util.Collection;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.configuration.DuplicateJobException;
import org.springframework.batch.core.configuration.JobRegistry;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.Lifecycle;
import org.springframework.context.SmartLifecycle;
import org.springframework.context.event.ApplicationContextEvent;
import org.springframework.core.Ordered;
import org.springframework.util.Assert;
/**
* Loads and unloads {@link Job Jobs} when the application context is created and destroyed. Each provided resource is
* loaded as an application context with the current context as its parent. Then all the jobs from the child context
* are registered under their bean names. A {@link JobRegistry} is required.
*
* @author Lucas Ward
* @author Dave Syer
* @author Mahmoud Ben Hassine
* @since 2.1
*/
public class AutomaticJobRegistrar implements Ordered, SmartLifecycle, ApplicationContextAware, InitializingBean {
private Collection<ApplicationContextFactory> applicationContextFactories = new ArrayList<>();
private JobLoader jobLoader;
private ApplicationContext applicationContext;
private volatile boolean running = false;
private int phase = Integer.MIN_VALUE + 1000;
private boolean autoStartup = true;
private Object lifecycleMonitor = new Object();
private int order = Ordered.LOWEST_PRECEDENCE;
/**
* The enclosing application context, which you can use to check whether {@link ApplicationContextEvent events} come
* from the expected source.
*
* @param applicationContext the enclosing application context, if there is one
* @see ApplicationContextAware#setApplicationContext(ApplicationContext)
*/
@Override
public void setApplicationContext(ApplicationContext applicationContext) {
this.applicationContext = applicationContext;
}
/**
* Add a single {@link ApplicationContextFactory} to the set that is used to load contexts and jobs.
*
* @param applicationContextFactory the {@link ApplicationContextFactory} values to use
*/
public void addApplicationContextFactory(ApplicationContextFactory applicationContextFactory) {
if (applicationContextFactory instanceof ApplicationContextAware) {
((ApplicationContextAware) applicationContextFactory).setApplicationContext(applicationContext);
}
this.applicationContextFactories.add(applicationContextFactory);
}
/**
* Add an array of {@link ApplicationContextFactory} instances to the set that is used to load contexts and jobs.
*
* @param applicationContextFactories the {@link ApplicationContextFactory} values to use
*/
public void setApplicationContextFactories(ApplicationContextFactory[] applicationContextFactories) {
for (ApplicationContextFactory applicationContextFactory : applicationContextFactories) {
this.applicationContextFactories.add(applicationContextFactory);
}
}
/**
* The job loader that is used to load and manage jobs.
*
* @param jobLoader the {@link JobLoader} to set
*/
public void setJobLoader(JobLoader jobLoader) {
this.jobLoader = jobLoader;
}
@Override
public int getOrder() {
return order;
}
/**
* The order in which to start up and shutdown.
* @param order the order (default {@link Ordered#LOWEST_PRECEDENCE}).
* @see Ordered
*/
public void setOrder(int order) {
this.order = order;
}
/**
*/
@Override
public void afterPropertiesSet() {
Assert.state(jobLoader != null, "A JobLoader must be provided");
}
/**
* Delegates to {@link JobLoader#clear()}.
*
* @see Lifecycle#stop()
*/
@Override
public void stop() {
synchronized (this.lifecycleMonitor) {
jobLoader.clear();
running = false;
}
}
/**
* Take all the contexts from the factories provided and pass them to the
* {@link JobLoader}.
*
* @see Lifecycle#start()
*/
@Override
public void start() {
synchronized (this.lifecycleMonitor) {
if (running) {
return;
}
for (ApplicationContextFactory factory : applicationContextFactories) {
try {
jobLoader.load(factory);
}
catch (DuplicateJobException e) {
throw new IllegalStateException(e);
}
}
running = true;
}
}
/**
* Check whether this component has been started.
*
* @return {@code true} if started successfully and not stopped.
* @see Lifecycle#isRunning()
*/
@Override
public boolean isRunning() {
synchronized (this.lifecycleMonitor) {
return running;
}
}
@Override
public boolean isAutoStartup() {
return autoStartup;
}
/**
* @param autoStartup {@code true} for auto start.
* @see #isAutoStartup()
*/
public void setAutoStartup(boolean autoStartup) {
this.autoStartup = autoStartup;
}
@Override
public int getPhase() {
return phase;
}
/**
* @param phase the phase.
* @see #getPhase()
*/
public void setPhase(int phase) {
this.phase = phase;
}
@Override
public void stop(Runnable callback) {
stop();
callback.run();
}
}