-
Notifications
You must be signed in to change notification settings - Fork 78
/
HttpServletResponseWrapper.java
280 lines (252 loc) · 9.33 KB
/
HttpServletResponseWrapper.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
/*
* Copyright (c) 1997, 2023 Oracle and/or its affiliates and others.
* 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 jakarta.servlet.http;
import jakarta.servlet.ServletResponseWrapper;
import java.io.IOException;
import java.util.Collection;
import java.util.Map;
import java.util.function.Supplier;
/**
*
* Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers
* wishing to adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default
* to calling through to the wrapped response object.
*
* @author Various
* @since Servlet 2.3
*
* @see jakarta.servlet.http.HttpServletResponse
*/
public class HttpServletResponseWrapper extends ServletResponseWrapper implements HttpServletResponse {
/**
* Constructs a response adaptor wrapping the given response.
*
* @param response the {@link HttpServletResponse} to be wrapped.
*
* @throws java.lang.IllegalArgumentException if the response is null
*/
public HttpServletResponseWrapper(HttpServletResponse response) {
super(response);
}
private HttpServletResponse _getHttpServletResponse() {
return (HttpServletResponse) super.getResponse();
}
/**
* The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.
*/
@Override
public void addCookie(Cookie cookie) {
this._getHttpServletResponse().addCookie(cookie);
}
/**
* The default behavior of this method is to call containsHeader(String name) on the wrapped response object.
*/
@Override
public boolean containsHeader(String name) {
return this._getHttpServletResponse().containsHeader(name);
}
/**
* The default behavior of this method is to call encodeURL(String url) on the wrapped response object.
*/
@Override
public String encodeURL(String url) {
return this._getHttpServletResponse().encodeURL(url);
}
/**
* The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.
*/
@Override
public String encodeRedirectURL(String url) {
return this._getHttpServletResponse().encodeRedirectURL(url);
}
/**
* The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
*/
@Override
public void sendError(int sc, String msg) throws IOException {
this._getHttpServletResponse().sendError(sc, msg);
}
/**
* The default behavior of this method is to call sendError(int sc) on the wrapped response object.
*/
@Override
public void sendError(int sc) throws IOException {
this._getHttpServletResponse().sendError(sc);
}
/**
* The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.
*/
@Override
public void sendRedirect(String location) throws IOException {
this._getHttpServletResponse().sendRedirect(location);
}
/**
* The default behavior of this method is to return sendRedirect(String location, int sc) on the wrapped response
* object.
*/
@Override
public void sendRedirect(String location, int sc) throws IOException {
this._getHttpServletResponse().sendRedirect(location, sc);
}
/**
* The default behavior of this method is to return sendRedirect(String location, boolean clearBuffer) on the wrapped
* response object.
*/
@Override
public void sendRedirect(String location, boolean clearBuffer) throws IOException {
this._getHttpServletResponse().sendRedirect(location, clearBuffer);
}
/**
* The default behavior of this method is to return sendRedirect(String location, int sc, boolean clearBuffer) on the
* wrapped response object.
*/
@Override
public void sendRedirect(String location, int sc, boolean clearBuffer) throws IOException {
this._getHttpServletResponse().sendRedirect(location, sc, clearBuffer);
}
/**
* The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
*/
@Override
public void setDateHeader(String name, long date) {
this._getHttpServletResponse().setDateHeader(name, date);
}
/**
* The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
*/
@Override
public void addDateHeader(String name, long date) {
this._getHttpServletResponse().addDateHeader(name, date);
}
/**
* The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
*/
@Override
public void setHeader(String name, String value) {
this._getHttpServletResponse().setHeader(name, value);
}
/**
* The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
*/
@Override
public void addHeader(String name, String value) {
this._getHttpServletResponse().addHeader(name, value);
}
/**
* The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
*/
@Override
public void setIntHeader(String name, int value) {
this._getHttpServletResponse().setIntHeader(name, value);
}
/**
* The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
*/
@Override
public void addIntHeader(String name, int value) {
this._getHttpServletResponse().addIntHeader(name, value);
}
/**
* The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
*/
@Override
public void setStatus(int sc) {
this._getHttpServletResponse().setStatus(sc);
}
/**
* The default behaviour of this method is to call {@link HttpServletResponse#getStatus} on the wrapped response object.
*
* @return the current status code of the wrapped response
*
* @since Servlet 3.0
*/
@Override
public int getStatus() {
return _getHttpServletResponse().getStatus();
}
/**
* The default behaviour of this method is to call {@link HttpServletResponse#getHeader} on the wrapped response object.
*
* @param name the name of the response header whose value to return
*
* @return the value of the response header with the given name, or <tt>null</tt> if no header with the given name has
* been set on the wrapped response
*
* @since Servlet 3.0
*/
@Override
public String getHeader(String name) {
return _getHttpServletResponse().getHeader(name);
}
/**
* The default behaviour of this method is to call {@link HttpServletResponse#getHeaders} on the wrapped response
* object.
*
* <p>
* Any changes to the returned <code>Collection</code> must not affect this <code>HttpServletResponseWrapper</code>.
*
* @param name the name of the response header whose values to return
*
* @return a (possibly empty) <code>Collection</code> of the values of the response header with the given name
*
* @since Servlet 3.0
*/
@Override
public Collection<String> getHeaders(String name) {
return _getHttpServletResponse().getHeaders(name);
}
/**
* The default behaviour of this method is to call {@link HttpServletResponse#getHeaderNames} on the wrapped response
* object.
*
* <p>
* Any changes to the returned <code>Collection</code> must not affect this <code>HttpServletResponseWrapper</code>.
*
* @return a (possibly empty) <code>Collection</code> of the names of the response headers
*
* @since Servlet 3.0
*/
@Override
public Collection<String> getHeaderNames() {
return _getHttpServletResponse().getHeaderNames();
}
/**
* The default behaviour of this method is to call {@link HttpServletResponse#setTrailerFields} on the wrapped response
* object.
*
* @param supplier of trailer headers
*
* @since Servlet 4.0
*/
@Override
public void setTrailerFields(Supplier<Map<String, String>> supplier) {
_getHttpServletResponse().setTrailerFields(supplier);
}
/**
* The default behaviour of this method is to call {@link HttpServletResponse#getTrailerFields} on the wrapped response
* object.
*
* @return supplier of trailer headers
*
* @since Servlet 4.0
*/
@Override
public Supplier<Map<String, String>> getTrailerFields() {
return _getHttpServletResponse().getTrailerFields();
}
}