-
Notifications
You must be signed in to change notification settings - Fork 974
/
ManagedServlet.java
342 lines (288 loc) · 12.6 KB
/
ManagedServlet.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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 io.undertow.servlet.core;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
import javax.servlet.MultipartConfigElement;
import javax.servlet.Servlet;
import javax.servlet.ServletException;
import javax.servlet.SingleThreadModel;
import javax.servlet.UnavailableException;
import io.undertow.server.handlers.form.FormEncodedDataDefinition;
import io.undertow.server.handlers.form.FormParserFactory;
import io.undertow.server.handlers.form.MultiPartParserDefinition;
import io.undertow.server.handlers.resource.ResourceChangeListener;
import io.undertow.server.handlers.resource.ResourceManager;
import io.undertow.servlet.UndertowServletLogger;
import io.undertow.servlet.UndertowServletMessages;
import io.undertow.servlet.api.DeploymentManager;
import io.undertow.servlet.api.InstanceFactory;
import io.undertow.servlet.api.InstanceHandle;
import io.undertow.servlet.api.LifecycleInterceptor;
import io.undertow.servlet.api.ServletInfo;
import io.undertow.servlet.spec.ServletConfigImpl;
import io.undertow.servlet.spec.ServletContextImpl;
/**
* Manager for a servlets lifecycle.
*
* @author Stuart Douglas
*/
public class ManagedServlet implements Lifecycle {
private final ServletInfo servletInfo;
private final ServletContextImpl servletContext;
private volatile boolean started = false;
private final InstanceStrategy instanceStrategy;
private volatile boolean permanentlyUnavailable = false;
private long maxRequestSize;
private FormParserFactory formParserFactory;
private MultipartConfigElement multipartConfig;
public ManagedServlet(final ServletInfo servletInfo, final ServletContextImpl servletContext) {
this.servletInfo = servletInfo;
this.servletContext = servletContext;
if (SingleThreadModel.class.isAssignableFrom(servletInfo.getServletClass())) {
instanceStrategy = new SingleThreadModelPoolStrategy(servletInfo.getInstanceFactory(), servletInfo, servletContext);
} else {
instanceStrategy = new DefaultInstanceStrategy(servletInfo.getInstanceFactory(), servletInfo, servletContext);
}
setupMultipart(servletContext);
}
public void setupMultipart(ServletContextImpl servletContext) {
FormEncodedDataDefinition formDataParser = new FormEncodedDataDefinition()
.setDefaultEncoding(servletContext.getDeployment().getDeploymentInfo().getDefaultEncoding());
MultipartConfigElement multipartConfig = servletInfo.getMultipartConfig();
if(multipartConfig == null) {
multipartConfig = servletContext.getDeployment().getDeploymentInfo().getDefaultMultipartConfig();
}
this.multipartConfig = multipartConfig;
if (multipartConfig != null) {
//todo: fileSizeThreshold
MultipartConfigElement config = multipartConfig;
if (config.getMaxRequestSize() != -1) {
maxRequestSize = config.getMaxRequestSize();
} else {
maxRequestSize = -1;
}
final Path tempDir;
if(config.getLocation() == null || config.getLocation().isEmpty()) {
tempDir = servletContext.getDeployment().getDeploymentInfo().getTempPath();
} else {
String location = config.getLocation();
Path locFile = Paths.get(location);
if(locFile.isAbsolute()) {
tempDir = locFile;
} else {
tempDir = servletContext.getDeployment().getDeploymentInfo().getTempPath().resolve(location);
}
}
MultiPartParserDefinition multiPartParserDefinition = new MultiPartParserDefinition(tempDir);
if(config.getMaxFileSize() > 0) {
multiPartParserDefinition.setMaxIndividualFileSize(config.getMaxFileSize());
}
multiPartParserDefinition.setDefaultEncoding(servletContext.getDeployment().getDeploymentInfo().getDefaultEncoding());
formParserFactory = FormParserFactory.builder(false)
.addParser(formDataParser)
.addParser(multiPartParserDefinition)
.build();
} else {
//no multipart config we don't allow multipart requests
formParserFactory = FormParserFactory.builder(false).addParser(formDataParser).build();
maxRequestSize = -1;
}
}
public synchronized void start() throws ServletException {
}
public void createServlet() throws ServletException {
if (permanentlyUnavailable) {
return;
}
try {
if (!started && servletInfo.getLoadOnStartup() != null && servletInfo.getLoadOnStartup() >= 0) {
instanceStrategy.start();
started = true;
}
} catch (UnavailableException e) {
if (e.isPermanent()) {
permanentlyUnavailable = true;
stop();
}
}
}
public synchronized void stop() {
if (started) {
instanceStrategy.stop();
}
started = false;
}
@Override
public boolean isStarted() {
return started;
}
public boolean isPermanentlyUnavailable() {
return permanentlyUnavailable;
}
public void setPermanentlyUnavailable(final boolean permanentlyUnavailable) {
this.permanentlyUnavailable = permanentlyUnavailable;
}
public InstanceHandle<? extends Servlet> getServlet() throws ServletException {
if(servletContext.getDeployment().getDeploymentState() != DeploymentManager.State.STARTED) {
throw UndertowServletMessages.MESSAGES.deploymentStopped(servletContext.getDeployment().getDeploymentInfo().getDeploymentName());
}
if (!started) {
synchronized (this) {
if (!started) {
instanceStrategy.start();
started = true;
}
}
}
return instanceStrategy.getServlet();
}
public ServletInfo getServletInfo() {
return servletInfo;
}
public long getMaxRequestSize() {
return maxRequestSize;
}
public FormParserFactory getFormParserFactory() {
return formParserFactory;
}
public MultipartConfigElement getMultipartConfig() {
return multipartConfig;
}
@Override
public String toString() {
return "ManagedServlet{" +
"servletInfo=" + servletInfo +
'}';
}
/**
* interface used to abstract the difference between single thread model servlets and normal servlets
*/
interface InstanceStrategy {
void start() throws ServletException;
void stop();
InstanceHandle<? extends Servlet> getServlet() throws ServletException;
}
/**
* The default servlet pooling strategy that just uses a single instance for all requests
*/
private static class DefaultInstanceStrategy implements InstanceStrategy {
private final InstanceFactory<? extends Servlet> factory;
private final ServletInfo servletInfo;
private final ServletContextImpl servletContext;
private volatile InstanceHandle<? extends Servlet> handle;
private volatile Servlet instance;
private ResourceChangeListener changeListener;
DefaultInstanceStrategy(final InstanceFactory<? extends Servlet> factory, final ServletInfo servletInfo, final ServletContextImpl servletContext) {
this.factory = factory;
this.servletInfo = servletInfo;
this.servletContext = servletContext;
}
public synchronized void start() throws ServletException {
try {
handle = factory.createInstance();
} catch (Exception e) {
throw UndertowServletMessages.MESSAGES.couldNotInstantiateComponent(servletInfo.getName(), e);
}
instance = handle.getInstance();
new LifecyleInterceptorInvocation(servletContext.getDeployment().getDeploymentInfo().getLifecycleInterceptors(), servletInfo, instance, new ServletConfigImpl(servletInfo, servletContext)).proceed();
//if a servlet implements FileChangeCallback it will be notified of file change events
final ResourceManager resourceManager = servletContext.getDeployment().getDeploymentInfo().getResourceManager();
if(instance instanceof ResourceChangeListener && resourceManager.isResourceChangeListenerSupported()) {
resourceManager.registerResourceChangeListener(changeListener = (ResourceChangeListener) instance);
}
}
public synchronized void stop() {
if (handle != null) {
final ResourceManager resourceManager = servletContext.getDeployment().getDeploymentInfo().getResourceManager();
if(changeListener != null) {
resourceManager.removeResourceChangeListener(changeListener);
}
invokeDestroy();
handle.release();
}
}
private void invokeDestroy() {
List<LifecycleInterceptor> interceptors = servletContext.getDeployment().getDeploymentInfo().getLifecycleInterceptors();
try {
new LifecyleInterceptorInvocation(interceptors, servletInfo, instance).proceed();
} catch (Exception e) {
UndertowServletLogger.ROOT_LOGGER.failedToDestroy(servletInfo, e);
}
}
public InstanceHandle<? extends Servlet> getServlet() {
return new InstanceHandle<Servlet>() {
@Override
public Servlet getInstance() {
return instance;
}
@Override
public void release() {
}
};
}
}
/**
* pooling strategy for single thread model servlet
*/
private static class SingleThreadModelPoolStrategy implements InstanceStrategy {
private final InstanceFactory<? extends Servlet> factory;
private final ServletInfo servletInfo;
private final ServletContextImpl servletContext;
private SingleThreadModelPoolStrategy(final InstanceFactory<? extends Servlet> factory, final ServletInfo servletInfo, final ServletContextImpl servletContext) {
this.factory = factory;
this.servletInfo = servletInfo;
this.servletContext = servletContext;
}
@Override
public void start() throws ServletException {
if(servletInfo.getLoadOnStartup() != null) {
//see UNDERTOW-734, make sure init method is called for load on startup
getServlet().release();
}
}
@Override
public void stop() {
}
@Override
public InstanceHandle<? extends Servlet> getServlet() throws ServletException {
final InstanceHandle<? extends Servlet> instanceHandle;
final Servlet instance;
//TODO: pooling
try {
instanceHandle = factory.createInstance();
} catch (Exception e) {
throw UndertowServletMessages.MESSAGES.couldNotInstantiateComponent(servletInfo.getName(), e);
}
instance = instanceHandle.getInstance();
new LifecyleInterceptorInvocation(servletContext.getDeployment().getDeploymentInfo().getLifecycleInterceptors(), servletInfo, instance, new ServletConfigImpl(servletInfo, servletContext)).proceed();
return new InstanceHandle<Servlet>() {
@Override
public Servlet getInstance() {
return instance;
}
@Override
public void release() {
instance.destroy();
instanceHandle.release();
}
};
}
}
}