-
Notifications
You must be signed in to change notification settings - Fork 138
/
ResponseFacade.java
464 lines (351 loc) · 10.3 KB
/
ResponseFacade.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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
/*
* Copyright (c) 2022, 2022 Contributors to the Eclipse Foundation.
* Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
* Copyright 2004 The Apache Software Foundation
*
* 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.apache.catalina.connector;
import static org.apache.catalina.LogFacade.NULL_RESPONSE_OBJECT;
import jakarta.servlet.ServletOutputStream;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.nio.charset.UnsupportedCharsetException;
import java.security.PrivilegedAction;
import java.util.Collection;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.function.Supplier;
import org.apache.catalina.LogFacade;
/**
* Facade class that wraps a Coyote response object. All methods are delegated to the wrapped response.
*
* @author Remy Maucherat
* @author Jean-Francois Arcand
*/
public class ResponseFacade implements HttpServletResponse {
private static final ResourceBundle rb = LogFacade.getLogger().getResourceBundle();
// ----------------------------------------------- Class/Instance Variables
/**
* The wrapped response.
*/
protected Response response;
// ----------------------------------------------------------- DoPrivileged
private final class SetContentTypePrivilegedAction implements PrivilegedAction<Void> {
private String contentType;
public SetContentTypePrivilegedAction(String contentType) {
this.contentType = contentType;
}
@Override
public Void run() {
response.setContentType(contentType);
return null;
}
}
// ----------------------------------------------------------- Constructors
/**
* Construct a wrapper for the specified response.
*
* @param response The response to be wrapped
*/
public ResponseFacade(Response response) {
this.response = response;
}
// --------------------------------------------------------- Public Methods
/**
* Prevent cloning the facade.
*/
@Override
protected Object clone() throws CloneNotSupportedException {
throw new CloneNotSupportedException();
}
/**
* Clear facade.
*/
public void clear() {
response = null;
}
public void finish() {
checkResponseNull();
response.setSuspended(true);
}
public boolean isFinished() {
checkResponseNull();
return response.isSuspended();
}
// ------------------------------------------------ ServletResponse Methods
@Override
public String getCharacterEncoding() {
checkResponseNull();
return response.getCharacterEncoding();
}
@Override
public ServletOutputStream getOutputStream() throws IOException {
checkResponseNull();
ServletOutputStream sos = response.getOutputStream();
if (isFinished()) {
response.setSuspended(true);
}
return sos;
}
@Override
public PrintWriter getWriter() throws IOException {
checkResponseNull();
try {
PrintWriter writer = response.getWriter();
if (isFinished()) {
response.setSuspended(true);
}
return writer;
} catch (UnsupportedCharsetException e) {
// Servlet 6 states we should throw an UnsupportedEncodingException, but our backend
// naturally throws an UnsupportedCharsetException.
UnsupportedEncodingException unsupportedEncodingException = new UnsupportedEncodingException();
unsupportedEncodingException.initCause(e);
throw unsupportedEncodingException;
}
}
@Override
public void setContentLength(int len) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setContentLength(len);
}
@Override
public void setContentLengthLong(long len) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setContentLengthLong(len);
}
@Override
public void setContentType(String type) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setContentType(type);
}
@Override
public void setBufferSize(int size) {
checkResponseNull();
checkCommitted();
response.setBufferSize(size);
}
@Override
public int getBufferSize() {
checkResponseNull();
return response.getBufferSize();
}
@Override
public void flushBuffer() throws IOException {
checkResponseNull();
if (isFinished()) {
return;
}
response.setAppCommitted(true);
response.flushBuffer();
}
@Override
public void resetBuffer() {
checkResponseNull();
checkCommitted();
response.resetBuffer();
}
@Override
public boolean isCommitted() {
checkResponseNull();
return (response.isAppCommitted());
}
@Override
public void reset() {
checkResponseNull();
checkCommitted();
response.reset();
}
@Override
public void setLocale(Locale loc) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setLocale(loc);
}
@Override
public Locale getLocale() {
checkResponseNull();
return response.getLocale();
}
@Override
public void addCookie(Cookie cookie) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.addCookie(cookie);
}
@Override
public boolean containsHeader(String name) {
checkResponseNull();
return response.containsHeader(name);
}
@Override
public String encodeURL(String url) {
checkResponseNull();
return response.encodeURL(url);
}
@Override
public String encodeRedirectURL(String url) {
checkResponseNull();
return response.encodeRedirectURL(url);
}
@Override
public void sendError(int sc, String msg) throws IOException {
checkResponseNull();
checkCommitted();
response.setAppCommitted(true);
response.sendError(sc, msg);
}
@Override
public void sendError(int sc) throws IOException {
checkResponseNull();
checkCommitted();
response.setAppCommitted(true);
response.sendError(sc);
}
@Override
public void sendRedirect(String location) throws IOException {
checkResponseNull();
checkCommitted();
response.setAppCommitted(true);
response.sendRedirect(location);
}
@Override
public void setDateHeader(String name, long date) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setDateHeader(name, date);
}
@Override
public void addDateHeader(String name, long date) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.addDateHeader(name, date);
}
@Override
public void setHeader(String name, String value) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setHeader(name, value);
}
@Override
public void addHeader(String name, String value) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.addHeader(name, value);
}
@Override
public void setIntHeader(String name, int value) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setIntHeader(name, value);
}
@Override
public void addIntHeader(String name, int value) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.addIntHeader(name, value);
}
@Override
public void setStatus(int sc) {
checkResponseNull();
if (isCommitted()) {
return;
}
response.setStatus(sc);
}
@Override
public String getContentType() {
checkResponseNull();
return response.getContentType();
}
@Override
public void setCharacterEncoding(String arg0) {
checkResponseNull();
response.setCharacterEncoding(arg0);
}
@Override
public int getStatus() {
checkResponseNull();
return response.getStatus();
}
@Override
public String getHeader(String name) {
checkResponseNull();
return response.getHeader(name);
}
@Override
public Collection<String> getHeaders(String name) {
checkResponseNull();
return response.getHeaders(name);
}
@Override
public Collection<String> getHeaderNames() {
checkResponseNull();
return response.getHeaderNames();
}
@Override
public Supplier<Map<String, String>> getTrailerFields() {
checkResponseNull();
return response.getTrailerFields();
}
@Override
public void setTrailerFields(Supplier<Map<String, String>> supplier) {
checkResponseNull();
response.setTrailerFields(supplier);
}
private void checkResponseNull() {
if (response == null) {
throw new IllegalStateException(rb.getString(NULL_RESPONSE_OBJECT));
}
}
private void checkCommitted() {
if (isCommitted()) {
throw new IllegalStateException();
}
}
@Override
public void sendRedirect(String location, int sc, boolean clearBuffer) throws IOException {
// TODO TODO SERVLET 6.1
// TODO Auto-generated method stub
}
}