author | chagedorn |
Thu, 12 Sep 2019 12:23:25 +0200 | |
changeset 58104 | 46e11f978852 |
parent 57981 | c4ec55644b4b |
permissions | -rw-r--r-- |
2 | 1 |
/* |
53720
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
package com.sun.net.httpserver; |
|
27 |
||
28 |
import java.io.*; |
|
29 |
import java.nio.*; |
|
30 |
import java.nio.channels.*; |
|
31 |
import java.net.*; |
|
32 |
import javax.net.ssl.*; |
|
33 |
import java.util.*; |
|
34 |
||
35 |
/** |
|
36 |
* This class encapsulates a HTTP request received and a |
|
37 |
* response to be generated in one exchange. It provides methods |
|
38 |
* for examining the request from the client, and for building and |
|
39 |
* sending the response. |
|
40 |
* <p> |
|
41 |
* The typical life-cycle of a HttpExchange is shown in the sequence |
|
42 |
* below. |
|
43 |
* <ol><li>{@link #getRequestMethod()} to determine the command |
|
44 |
* <li>{@link #getRequestHeaders()} to examine the request headers (if needed) |
|
45 |
* <li>{@link #getRequestBody()} returns a {@link java.io.InputStream} for reading the request body. |
|
54147 | 46 |
* After reading the request body, the stream should be closed. |
2 | 47 |
* <li>{@link #getResponseHeaders()} to set any response headers, except content-length |
48 |
* <li>{@link #sendResponseHeaders(int,long)} to send the response headers. Must be called before |
|
49 |
* next step. |
|
50 |
* <li>{@link #getResponseBody()} to get a {@link java.io.OutputStream} to send the response body. |
|
51 |
* When the response body has been written, the stream must be closed to terminate the exchange. |
|
52 |
* </ol> |
|
53 |
* <b>Terminating exchanges</b> |
|
54 |
* <br> |
|
55 |
* Exchanges are terminated when both the request InputStream and response OutputStream are closed. |
|
56 |
* Closing the OutputStream, implicitly closes the InputStream (if it is not already closed). |
|
57 |
* However, it is recommended |
|
58 |
* to consume all the data from the InputStream before closing it. |
|
59 |
* The convenience method {@link #close()} does all of these tasks. |
|
60 |
* Closing an exchange without consuming all of the request body is not an error |
|
61 |
* but may make the underlying TCP connection unusable for following exchanges. |
|
62 |
* The effect of failing to terminate an exchange is undefined, but will typically |
|
63 |
* result in resources failing to be freed/reused. |
|
64 |
* @since 1.6 |
|
65 |
*/ |
|
66 |
||
57981
c4ec55644b4b
8229235: com.sun.net.httpserver.HttpExchange should implement AutoCloseable
michaelm
parents:
54147
diff
changeset
|
67 |
public abstract class HttpExchange implements AutoCloseable { |
2 | 68 |
|
69 |
protected HttpExchange () { |
|
70 |
} |
|
71 |
||
72 |
/** |
|
73 |
* Returns an immutable Map containing the HTTP headers that were |
|
74 |
* included with this request. The keys in this Map will be the header |
|
75 |
* names, while the values will be a List of Strings containing each value |
|
76 |
* that was included (either for a header that was listed several times, |
|
77 |
* or one that accepts a comma-delimited list of values on a single line). |
|
78 |
* In either of these cases, the values for the header name will be |
|
79 |
* presented in the order that they were included in the request. |
|
80 |
* <p> |
|
81 |
* The keys in Map are case-insensitive. |
|
82 |
* @return a read-only Map which can be used to access request headers |
|
83 |
*/ |
|
84 |
public abstract Headers getRequestHeaders () ; |
|
85 |
||
86 |
/** |
|
87 |
* Returns a mutable Map into which the HTTP response headers can be stored |
|
88 |
* and which will be transmitted as part of this response. The keys in the |
|
89 |
* Map will be the header names, while the values must be a List of Strings |
|
90 |
* containing each value that should be included multiple times |
|
91 |
* (in the order that they should be included). |
|
92 |
* <p> |
|
93 |
* The keys in Map are case-insensitive. |
|
94 |
* @return a writable Map which can be used to set response headers. |
|
95 |
*/ |
|
96 |
public abstract Headers getResponseHeaders () ; |
|
97 |
||
98 |
/** |
|
99 |
* Get the request URI |
|
100 |
* |
|
101 |
* @return the request URI |
|
102 |
*/ |
|
103 |
public abstract URI getRequestURI () ; |
|
104 |
||
105 |
/** |
|
106 |
* Get the request method |
|
107 |
* @return the request method |
|
108 |
*/ |
|
109 |
public abstract String getRequestMethod (); |
|
110 |
||
111 |
/** |
|
112 |
* Get the HttpContext for this exchange |
|
113 |
* @return the HttpContext |
|
114 |
*/ |
|
115 |
public abstract HttpContext getHttpContext (); |
|
116 |
||
117 |
/** |
|
30042 | 118 |
* Ends this exchange by doing the following in sequence:<ol> |
119 |
* <li>close the request InputStream, if not already closed;</li> |
|
120 |
* <li>close the response OutputStream, if not already closed.</li> |
|
2 | 121 |
* </ol> |
122 |
*/ |
|
123 |
public abstract void close () ; |
|
124 |
||
125 |
/** |
|
126 |
* returns a stream from which the request body can be read. |
|
127 |
* Multiple calls to this method will return the same stream. |
|
128 |
* It is recommended that applications should consume (read) all of the |
|
129 |
* data from this stream before closing it. If a stream is closed |
|
130 |
* before all data has been read, then the close() call will |
|
131 |
* read and discard remaining data (up to an implementation specific |
|
132 |
* number of bytes). |
|
133 |
* @return the stream from which the request body can be read. |
|
134 |
*/ |
|
135 |
public abstract InputStream getRequestBody () ; |
|
136 |
||
137 |
/** |
|
138 |
* returns a stream to which the response body must be |
|
139 |
* written. {@link #sendResponseHeaders(int,long)}) must be called prior to calling |
|
140 |
* this method. Multiple calls to this method (for the same exchange) |
|
141 |
* will return the same stream. In order to correctly terminate |
|
142 |
* each exchange, the output stream must be closed, even if no |
|
143 |
* response body is being sent. |
|
144 |
* <p> |
|
145 |
* Closing this stream implicitly |
|
146 |
* closes the InputStream returned from {@link #getRequestBody()} |
|
147 |
* (if it is not already closed). |
|
148 |
* <P> |
|
149 |
* If the call to sendResponseHeaders() specified a fixed response |
|
150 |
* body length, then the exact number of bytes specified in that |
|
151 |
* call must be written to this stream. If too many bytes are written, |
|
152 |
* then write() will throw an IOException. If too few bytes are written |
|
153 |
* then the stream close() will throw an IOException. In both cases, |
|
154 |
* the exchange is aborted and the underlying TCP connection closed. |
|
155 |
* @return the stream to which the response body is written |
|
156 |
*/ |
|
157 |
public abstract OutputStream getResponseBody () ; |
|
158 |
||
159 |
||
160 |
/** |
|
161 |
* Starts sending the response back to the client using the current set of response headers |
|
162 |
* and the numeric response code as specified in this method. The response body length is also specified |
|
163 |
* as follows. If the response length parameter is greater than zero, this specifies an exact |
|
164 |
* number of bytes to send and the application must send that exact amount of data. |
|
30042 | 165 |
* If the response length parameter is {@code zero}, then chunked transfer encoding is |
2 | 166 |
* used and an arbitrary amount of data may be sent. The application terminates the |
30042 | 167 |
* response body by closing the OutputStream. If response length has the value {@code -1} |
2 | 168 |
* then no response body is being sent. |
169 |
* <p> |
|
170 |
* If the content-length response header has not already been set then |
|
21278 | 171 |
* this is set to the appropriate value depending on the response length parameter. |
2 | 172 |
* <p> |
173 |
* This method must be called prior to calling {@link #getResponseBody()}. |
|
53720
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
174 |
* |
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
175 |
* @implNote This implementation allows the caller to instruct the |
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
176 |
* server to force a connection close after the exchange terminates, by |
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
177 |
* supplying a {@code Connection: close} header to the {@linkplain |
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
178 |
* #getResponseHeaders() response headers} before {@code sendResponseHeaders} |
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
179 |
* is called. |
3e451bff6f7f
8218554: HttpServer: allow custom handlers to request that the connection be closed after the exchange.
dfuchs
parents:
47216
diff
changeset
|
180 |
* |
2 | 181 |
* @param rCode the response code to send |
30797 | 182 |
* @param responseLength if {@literal > 0}, specifies a fixed response |
183 |
* body length and that exact number of bytes must be written |
|
2 | 184 |
* to the stream acquired from getResponseBody(), or else |
185 |
* if equal to 0, then chunked encoding is used, |
|
186 |
* and an arbitrary number of bytes may be written. |
|
30797 | 187 |
* if {@literal <= -1}, then no response body length is specified and |
2 | 188 |
* no response body may be written. |
189 |
* @see HttpExchange#getResponseBody() |
|
190 |
*/ |
|
191 |
public abstract void sendResponseHeaders (int rCode, long responseLength) throws IOException ; |
|
192 |
||
193 |
/** |
|
194 |
* Returns the address of the remote entity invoking this request |
|
195 |
* @return the InetSocketAddress of the caller |
|
196 |
*/ |
|
197 |
public abstract InetSocketAddress getRemoteAddress (); |
|
198 |
||
199 |
/** |
|
200 |
* Returns the response code, if it has already been set |
|
30042 | 201 |
* @return the response code, if available. {@code -1} if not available yet. |
2 | 202 |
*/ |
203 |
public abstract int getResponseCode (); |
|
204 |
||
205 |
/** |
|
206 |
* Returns the local address on which the request was received |
|
207 |
* @return the InetSocketAddress of the local interface |
|
208 |
*/ |
|
209 |
public abstract InetSocketAddress getLocalAddress (); |
|
210 |
||
211 |
/** |
|
212 |
* Returns the protocol string from the request in the form |
|
213 |
* <i>protocol/majorVersion.minorVersion</i>. For example, |
|
214 |
* "HTTP/1.1" |
|
215 |
* @return the protocol string from the request |
|
216 |
*/ |
|
217 |
public abstract String getProtocol (); |
|
218 |
||
219 |
/** |
|
220 |
* Filter modules may store arbitrary objects with HttpExchange |
|
221 |
* instances as an out-of-band communication mechanism. Other Filters |
|
222 |
* or the exchange handler may then access these objects. |
|
223 |
* <p> |
|
224 |
* Each Filter class will document the attributes which they make |
|
225 |
* available. |
|
226 |
* @param name the name of the attribute to retrieve |
|
227 |
* @return the attribute object, or null if it does not exist |
|
30042 | 228 |
* @throws NullPointerException if name is {@code null} |
2 | 229 |
*/ |
230 |
public abstract Object getAttribute (String name) ; |
|
231 |
||
232 |
/** |
|
233 |
* Filter modules may store arbitrary objects with HttpExchange |
|
234 |
* instances as an out-of-band communication mechanism. Other Filters |
|
235 |
* or the exchange handler may then access these objects. |
|
236 |
* <p> |
|
237 |
* Each Filter class will document the attributes which they make |
|
238 |
* available. |
|
239 |
* @param name the name to associate with the attribute value |
|
30042 | 240 |
* @param value the object to store as the attribute value. {@code null} |
2 | 241 |
* value is permitted. |
30042 | 242 |
* @throws NullPointerException if name is {@code null} |
2 | 243 |
*/ |
244 |
public abstract void setAttribute (String name, Object value) ; |
|
245 |
||
246 |
/** |
|
247 |
* Used by Filters to wrap either (or both) of this exchange's InputStream |
|
248 |
* and OutputStream, with the given filtered streams so |
|
249 |
* that subsequent calls to {@link #getRequestBody()} will |
|
250 |
* return the given {@link java.io.InputStream}, and calls to |
|
251 |
* {@link #getResponseBody()} will return the given |
|
252 |
* {@link java.io.OutputStream}. The streams provided to this |
|
253 |
* call must wrap the original streams, and may be (but are not |
|
254 |
* required to be) sub-classes of {@link java.io.FilterInputStream} |
|
255 |
* and {@link java.io.FilterOutputStream}. |
|
256 |
* @param i the filtered input stream to set as this object's inputstream, |
|
30042 | 257 |
* or {@code null} if no change. |
2 | 258 |
* @param o the filtered output stream to set as this object's outputstream, |
30042 | 259 |
* or {@code null} if no change. |
2 | 260 |
*/ |
261 |
public abstract void setStreams (InputStream i, OutputStream o); |
|
262 |
||
263 |
||
264 |
/** |
|
265 |
* If an authenticator is set on the HttpContext that owns this exchange, |
|
266 |
* then this method will return the {@link HttpPrincipal} that represents |
|
267 |
* the authenticated user for this HttpExchange. |
|
30042 | 268 |
* @return the HttpPrincipal, or {@code null} if no authenticator is set. |
2 | 269 |
*/ |
270 |
public abstract HttpPrincipal getPrincipal (); |
|
271 |
} |