-
Notifications
You must be signed in to change notification settings - Fork 78
/
ServletOutputStream.java
307 lines (283 loc) · 9.47 KB
/
ServletOutputStream.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
/*
* Copyright (c) 1997, 2022 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;
import java.io.CharConversionException;
import java.io.IOException;
import java.io.OutputStream;
import java.text.MessageFormat;
import java.util.ResourceBundle;
/**
* Provides an output stream for sending binary data to the client. A <code>ServletOutputStream</code> object is
* normally retrieved via the {@link ServletResponse#getOutputStream} method.
*
* <p>
* This is an abstract class that the servlet container implements. Subclasses of this class must implement the
* <code>java.io.OutputStream.write(int)</code> method.
*
*
* @author Various
*
* @see ServletResponse
*
*/
public abstract class ServletOutputStream extends OutputStream {
private static final String LSTRING_FILE = "jakarta.servlet.LocalStrings";
private static ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE);
/**
*
* Does nothing, because this is an abstract class.
*
*/
protected ServletOutputStream() {
}
/**
* Writes a <code>String</code> to the client, without a carriage return-line feed (CRLF) character at the end.
*
*
* @param s the <code>String</code> to send to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void print(String s) throws IOException {
if (s == null)
s = "null";
int len = s.length();
byte[] out = new byte[len];
for (int i = 0; i < len; i++) {
char c = s.charAt(i);
//
// XXX NOTE: This is clearly incorrect for many strings,
// but is the only consistent approach within the current
// servlet framework. It must suffice until servlet output
// streams properly encode their output.
//
if ((c & 0xff00) != 0) { // high order byte must be zero
String errMsg = lStrings.getString("err.not_iso8859_1");
Object[] errArgs = new Object[1];
errArgs[0] = Character.valueOf(c);
errMsg = MessageFormat.format(errMsg, errArgs);
throw new CharConversionException(errMsg);
}
out[i] = (byte) (0xff & c);
}
write(out, 0, len);
}
/**
* Writes a <code>boolean</code> value to the client, with no carriage return-line feed (CRLF) character at the end.
*
* @param b the <code>boolean</code> value to send to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void print(boolean b) throws IOException {
print(lStrings.getString(b ? "value.true" : "value.false"));
}
/**
* Writes a character to the client, with no carriage return-line feed (CRLF) at the end.
*
* @param c the character to send to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void print(char c) throws IOException {
print(String.valueOf(c));
}
/**
*
* Writes an int to the client, with no carriage return-line feed (CRLF) at the end.
*
* @param i the int to send to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void print(int i) throws IOException {
print(String.valueOf(i));
}
/**
*
* Writes a <code>long</code> value to the client, with no carriage return-line feed (CRLF) at the end.
*
* @param l the <code>long</code> value to send to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void print(long l) throws IOException {
print(String.valueOf(l));
}
/**
*
* Writes a <code>float</code> value to the client, with no carriage return-line feed (CRLF) at the end.
*
* @param f the <code>float</code> value to send to the client
*
* @exception IOException if an input or output exception occurred
*
*
*/
public void print(float f) throws IOException {
print(String.valueOf(f));
}
/**
*
* Writes a <code>double</code> value to the client, with no carriage return-line feed (CRLF) at the end.
*
* @param d the <code>double</code> value to send to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void print(double d) throws IOException {
print(String.valueOf(d));
}
/**
* Writes a carriage return-line feed (CRLF) to the client.
*
*
*
* @exception IOException if an input or output exception occurred
*
*/
public void println() throws IOException {
print("\r\n");
}
/**
* Writes a <code>String</code> to the client, followed by a carriage return-line feed (CRLF).
*
*
* @param s the <code>String</code> to write to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(String s) throws IOException {
print(s == null ? "null\r\n" : (s + "\r\n"));
}
/**
*
* Writes a <code>boolean</code> value to the client, followed by a carriage return-line feed (CRLF).
*
*
* @param b the <code>boolean</code> value to write to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(boolean b) throws IOException {
println(lStrings.getString(b ? "value.true" : "value.false"));
}
/**
*
* Writes a character to the client, followed by a carriage return-line feed (CRLF).
*
* @param c the character to write to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(char c) throws IOException {
println(String.valueOf(c));
}
/**
*
* Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
*
*
* @param i the int to write to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(int i) throws IOException {
println(String.valueOf(i));
}
/**
*
* Writes a <code>long</code> value to the client, followed by a carriage return-line feed (CRLF).
*
*
* @param l the <code>long</code> value to write to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(long l) throws IOException {
println(String.valueOf(l));
}
/**
*
* Writes a <code>float</code> value to the client, followed by a carriage return-line feed (CRLF).
*
* @param f the <code>float</code> value to write to the client
*
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(float f) throws IOException {
println(String.valueOf(f));
}
/**
*
* Writes a <code>double</code> value to the client, followed by a carriage return-line feed (CRLF).
*
*
* @param d the <code>double</code> value to write to the client
*
* @exception IOException if an input or output exception occurred
*
*/
public void println(double d) throws IOException {
println(String.valueOf(d));
}
/**
* Returns true if data can be written without blocking else returns false.
* <p>
* If this method returns false and a {@link WriteListener} has been set with {@link #setWriteListener(WriteListener)},
* then container will subsequently invoke {@link WriteListener#onWritePossible()} once a write operation becomes
* possible without blocking. Other than the initial call, {@link WriteListener#onWritePossible()} will only be called
* if and only if this method is called and returns false.
*
* @return <code>true</code> if data can be written without blocking, otherwise returns <code>false</code>.
* @see WriteListener
* @since Servlet 3.1
*/
public abstract boolean isReady();
/**
* Instructs the <code>ServletOutputStream</code> to invoke the provided {@link WriteListener} when it is possible to
* write
*
*
* @param writeListener the {@link WriteListener} that should be notified when it's possible to write
*
* @exception IllegalStateException if one of the following conditions is true
* <ul>
* <li>the associated request is neither upgraded nor the async started
* <li>setWriteListener is called more than once within the scope of the same request.
* </ul>
*
* @throws NullPointerException if writeListener is null
*
* @since Servlet 3.1
*/
public abstract void setWriteListener(WriteListener writeListener);
}