Class Response
- java.lang.Object
-
- org.eclipse.jetty.server.Response
-
- All Implemented Interfaces:
HttpServletResponse
,ServletResponse
@Deprecated(since="2021-05-27") public class Response extends Object implements HttpServletResponse
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.Response
provides the implementation forHttpServletResponse
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Response.OutputType
Deprecated.
-
Field Summary
Fields Modifier and Type Field Description static int
NO_CONTENT_LENGTH
Deprecated.static String
SET_INCLUDE_HEADER_PREFIX
Deprecated.If a header name starts with this string, the header (stripped of the prefix) can be set during include using onlysetHeader(String, String)
oraddHeader(String, String)
.static int
USE_KNOWN_CONTENT_LENGTH
Deprecated.-
Fields inherited from interface javax.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY
-
-
Constructor Summary
Constructors Constructor Description Response(HttpChannel channel, HttpOutput out)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addCookie(Cookie cookie)
Deprecated.Adds the specified cookie to the response.void
addCookie(HttpCookie cookie)
Deprecated.void
addDateHeader(String name, long date)
Deprecated.Adds a response header with the given name and date-value.void
addHeader(String name, String value)
Deprecated.Adds a response header with the given name and value.void
addIntHeader(String name, int value)
Deprecated.Adds a response header with the given name and integer value.void
closeOutput()
Deprecated.void
completeOutput()
Deprecated.UsecloseOutput()
void
completeOutput(Callback callback)
Deprecated.boolean
containsHeader(String name)
Deprecated.Returns a boolean indicating whether the named response header has already been set.String
encodeRedirectUrl(String url)
Deprecated.String
encodeRedirectURL(String url)
Deprecated.Encodes the specified URL for use in thesendRedirect
method or, if encoding is not needed, returns the URL unchanged.String
encodeUrl(String url)
Deprecated.String
encodeURL(String url)
Deprecated.Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.void
errorClose()
Deprecated.void
flushBuffer()
Deprecated.Forces any content in the buffer to be written to the client.int
getBufferSize()
Deprecated.Returns the actual buffer size used for the response.String
getCharacterEncoding()
Deprecated.Returns the name of the character encoding (MIME charset) used for the body sent in this response.MetaData.Response
getCommittedMetaData()
Deprecated.Get the MetaData.Response committed for this response.long
getContentCount()
Deprecated.long
getContentLength()
Deprecated.String
getContentType()
Deprecated.Returns the content type used for the MIME body sent in this response.String
getHeader(String name)
Deprecated.Return the value for the specified header, ornull
if this header has not been set.Collection<String>
getHeaderNames()
Deprecated.Get the header names set for this HTTP response.Collection<String>
getHeaders(String name)
Deprecated.Return a Collection of all the header values associated with the specified header name.HttpChannel
getHttpChannel()
Deprecated.HttpFields
getHttpFields()
Deprecated.HttpOutput
getHttpOutput()
Deprecated.Locale
getLocale()
Deprecated.Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)
method.long
getLongContentLength()
Deprecated.ServletOutputStream
getOutputStream()
Deprecated.Returns aServletOutputStream
suitable for writing binary data in the response.String
getReason()
Deprecated.int
getStatus()
Deprecated.Get the HTTP status code for this Response.Supplier<HttpFields>
getTrailers()
Deprecated.PrintWriter
getWriter()
Deprecated.Returns aPrintWriter
object that can send character text to the client.void
include()
Deprecated.void
included()
Deprecated.boolean
isAllContentWritten(long written)
Deprecated.boolean
isCommitted()
Deprecated.Returns a boolean indicating if the response has been committed.boolean
isContentComplete(long written)
Deprecated.boolean
isIncluding()
Deprecated.boolean
isStreaming()
Deprecated.boolean
isWriting()
Deprecated.boolean
isWritingOrStreaming()
Deprecated.static void
putHeaders(HttpServletResponse response, HttpContent content, long contentLength, boolean etag)
Deprecated.void
putHeaders(HttpContent content, long contentLength, boolean etag)
Deprecated.void
reopen()
Deprecated.void
replaceCookie(HttpCookie cookie)
Deprecated.Replace (or add) a cookie.void
reset()
Deprecated.Clears any data that exists in the buffer as well as the status code and headers.void
resetBuffer()
Deprecated.Clears the content of the underlying buffer in the response without clearing headers or status code.void
resetContent()
Deprecated.void
resetForForward()
Deprecated.void
sendError(int sc)
Deprecated.Sends an error response to the client using the specified status code and clears the buffer.void
sendError(int code, String message)
Deprecated.Send an error response.void
sendProcessing()
Deprecated.Sends a 102-Processing response.void
sendRedirect(int code, String location)
Deprecated.Sends a response with one of the 300 series redirection codes.void
sendRedirect(int code, String location, boolean consumeAll)
Deprecated.Sends a response with a given redirection code.void
sendRedirect(String location)
Deprecated.Sends a temporary redirect response to the client using the specified redirect location URL.void
sendRedirect(String location, boolean consumeAll)
Deprecated.Sends a response with a HTTP version appropriate 30x redirection.void
setBufferSize(int size)
Deprecated.Sets the preferred buffer size for the body of the response.void
setCharacterEncoding(String encoding)
Deprecated.Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.void
setContentLength(int len)
Deprecated.Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.void
setContentLengthLong(long length)
Deprecated.Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.void
setContentType(String contentType)
Deprecated.Sets the content type of the response being sent to the client, if the response has not been committed yet.void
setDateHeader(String name, long date)
Deprecated.Sets a response header with the given name and date-value.void
setHeader(String name, String value)
Deprecated.Sets a response header with the given name and value.void
setHeader(HttpHeader name, String value)
Deprecated.void
setIntHeader(String name, int value)
Deprecated.Sets a response header with the given name and integer value.void
setLocale(Locale locale)
Deprecated.Sets the locale of the response, if the response has not been committed yet.void
setLongContentLength(long len)
Deprecated.void
setStatus(int sc)
Deprecated.Sets the status code for this response.void
setStatus(int sc, String sm)
Deprecated.void
setStatusWithReason(int sc, String sm)
Deprecated.void
setTrailers(Supplier<HttpFields> trailers)
Deprecated.String
toString()
Deprecated.static HttpServletResponse
unwrap(ServletResponse servletResponse)
Deprecated.
-
-
-
Field Detail
-
NO_CONTENT_LENGTH
public static final int NO_CONTENT_LENGTH
Deprecated.- See Also:
- Constant Field Values
-
USE_KNOWN_CONTENT_LENGTH
public static final int USE_KNOWN_CONTENT_LENGTH
Deprecated.- See Also:
- Constant Field Values
-
SET_INCLUDE_HEADER_PREFIX
public static final String SET_INCLUDE_HEADER_PREFIX
Deprecated.If a header name starts with this string, the header (stripped of the prefix) can be set during include using onlysetHeader(String, String)
oraddHeader(String, String)
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Response
public Response(HttpChannel channel, HttpOutput out)
Deprecated.
-
-
Method Detail
-
getHttpChannel
public HttpChannel getHttpChannel()
Deprecated.
-
getHttpOutput
public HttpOutput getHttpOutput()
Deprecated.
-
reopen
public void reopen()
Deprecated.
-
errorClose
public void errorClose()
Deprecated.
-
isIncluding
public boolean isIncluding()
Deprecated.
-
include
public void include()
Deprecated.
-
included
public void included()
Deprecated.
-
addCookie
public void addCookie(HttpCookie cookie)
Deprecated.
-
replaceCookie
public void replaceCookie(HttpCookie cookie)
Deprecated.Replace (or add) a cookie. Using name, path and domain, look for a matching set-cookie header and replace it.- Parameters:
cookie
- The cookie to add/replace
-
addCookie
public void addCookie(Cookie cookie)
Deprecated.Description copied from interface:HttpServletResponse
Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.- Specified by:
addCookie
in interfaceHttpServletResponse
- Parameters:
cookie
- the Cookie to return to the client
-
containsHeader
public boolean containsHeader(String name)
Deprecated.Description copied from interface:HttpServletResponse
Returns a boolean indicating whether the named response header has already been set.- Specified by:
containsHeader
in interfaceHttpServletResponse
- Parameters:
name
- the header name- Returns:
true
if the named response header has already been set;false
otherwise
-
encodeURL
public String encodeURL(String url)
Deprecated.Description copied from interface:HttpServletResponse
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.
- Specified by:
encodeURL
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
encodeRedirectURL
public String encodeRedirectURL(String url)
Deprecated.Description copied from interface:HttpServletResponse
Encodes the specified URL for use in thesendRedirect
method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from theencodeURL
method.All URLs sent to the
HttpServletResponse.sendRedirect
method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.- Specified by:
encodeRedirectURL
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
- See Also:
HttpServletResponse.sendRedirect(java.lang.String)
,HttpServletResponse.encodeUrl(java.lang.String)
-
encodeUrl
@Deprecated public String encodeUrl(String url)
Deprecated.- Specified by:
encodeUrl
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
encodeRedirectUrl
@Deprecated public String encodeRedirectUrl(String url)
Deprecated.- Specified by:
encodeRedirectUrl
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
sendError
public void sendError(int sc) throws IOException
Deprecated.Description copied from interface:HttpServletResponse
Sends an error response to the client using the specified status code and clears the buffer. This is equivalent to callingHttpServletResponse.sendError(int, String)
with the same status code andnull
for the message.- Specified by:
sendError
in interfaceHttpServletResponse
- Parameters:
sc
- the error status code- Throws:
IOException
- If an input or output exception occurs
-
sendError
public void sendError(int code, String message) throws IOException
Deprecated.Send an error response.In addition to the servlet standard handling, this method supports some additional codes:
- 102
- Send a partial PROCESSING response and allow additional responses
- -1
- Abort the HttpChannel and close the connection/stream
- Specified by:
sendError
in interfaceHttpServletResponse
- Parameters:
code
- The error codemessage
- The message- Throws:
IOException
- If an IO problem occurred sending the error response.
-
sendProcessing
public void sendProcessing() throws IOException
Deprecated.Sends a 102-Processing response. If the connection is an HTTP connection, the version is 1.1 and the request has a Expect header starting with 102, then a 102 response is sent. This indicates that the request still be processed and real response can still be sent. This method is called by sendError if it is passed 102.- Throws:
IOException
- if unable to send the 102 response- See Also:
HttpServletResponse.sendError(int)
-
sendRedirect
public void sendRedirect(int code, String location) throws IOException
Deprecated.Sends a response with one of the 300 series redirection codes.- Parameters:
code
- the redirect status codelocation
- the location to send inLocation
headers- Throws:
IOException
- if unable to send the redirect
-
sendRedirect
public void sendRedirect(String location, boolean consumeAll) throws IOException
Deprecated.Sends a response with a HTTP version appropriate 30x redirection.- Parameters:
location
- the location to send inLocation
headersconsumeAll
- if True, consume any HTTP/1 request input before doing the redirection. If the input cannot be consumed without blocking, then add a `Connection: close` header to the response.- Throws:
IOException
- if unable to send the redirect
-
sendRedirect
public void sendRedirect(int code, String location, boolean consumeAll) throws IOException
Deprecated.Sends a response with a given redirection code.- Parameters:
code
- the redirect status codelocation
- the location to send inLocation
headersconsumeAll
- if True, consume any HTTP/1 request input before doing the redirection. If the input cannot be consumed without blocking, then add a `Connection: close` header to the response.- Throws:
IOException
- if unable to send the redirect
-
sendRedirect
public void sendRedirect(String location) throws IOException
Deprecated.Description copied from interface:HttpServletResponse
Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.
- Specified by:
sendRedirect
in interfaceHttpServletResponse
- Parameters:
location
- the redirect location URL- Throws:
IOException
- If an input or output exception occurs
-
setDateHeader
public void setDateHeader(String name, long date)
Deprecated.Description copied from interface:HttpServletResponse
Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. ThecontainsHeader
method can be used to test for the presence of a header before setting its value.- Specified by:
setDateHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the header to setdate
- the assigned date value- See Also:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addDateHeader(java.lang.String, long)
-
addDateHeader
public void addDateHeader(String name, long date)
Deprecated.Description copied from interface:HttpServletResponse
Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.- Specified by:
addDateHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the header to setdate
- the additional date value- See Also:
HttpServletResponse.setDateHeader(java.lang.String, long)
-
setHeader
public void setHeader(HttpHeader name, String value)
Deprecated.
-
setHeader
public void setHeader(String name, String value)
Deprecated.Description copied from interface:HttpServletResponse
Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeader
method can be used to test for the presence of a header before setting its value.- Specified by:
setHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the headervalue
- the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)- See Also:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addHeader(java.lang.String, java.lang.String)
-
getHeaderNames
public Collection<String> getHeaderNames()
Deprecated.Description copied from interface:HttpServletResponse
Get the header names set for this HTTP response.- Specified by:
getHeaderNames
in interfaceHttpServletResponse
- Returns:
- The header names set for this HTTP response.
-
getHeader
public String getHeader(String name)
Deprecated.Description copied from interface:HttpServletResponse
Return the value for the specified header, ornull
if this header has not been set. If more than one value was added for this name, only the first is returned; useHttpServletResponse.getHeaders(String)
to retrieve all of them.- Specified by:
getHeader
in interfaceHttpServletResponse
- Parameters:
name
- Header name to look up- Returns:
- The first value for the specified header. This is the raw value so if multiple values are specified in the first header then they will be returned as a single header value .
-
getHeaders
public Collection<String> getHeaders(String name)
Deprecated.Description copied from interface:HttpServletResponse
Return a Collection of all the header values associated with the specified header name.- Specified by:
getHeaders
in interfaceHttpServletResponse
- Parameters:
name
- Header name to look up- Returns:
- The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.
-
addHeader
public void addHeader(String name, String value)
Deprecated.Description copied from interface:HttpServletResponse
Adds a response header with the given name and value. This method allows response headers to have multiple values.- Specified by:
addHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the headervalue
- the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)- See Also:
HttpServletResponse.setHeader(java.lang.String, java.lang.String)
-
setIntHeader
public void setIntHeader(String name, int value)
Deprecated.Description copied from interface:HttpServletResponse
Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeader
method can be used to test for the presence of a header before setting its value.- Specified by:
setIntHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the headervalue
- the assigned integer value- See Also:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addIntHeader(java.lang.String, int)
-
addIntHeader
public void addIntHeader(String name, int value)
Deprecated.Description copied from interface:HttpServletResponse
Adds a response header with the given name and integer value. This method allows response headers to have multiple values.- Specified by:
addIntHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the headervalue
- the assigned integer value- See Also:
HttpServletResponse.setIntHeader(java.lang.String, int)
-
setStatus
public void setStatus(int sc)
Deprecated.Description copied from interface:HttpServletResponse
Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, thesendError
method should be used instead.The container clears the buffer and sets the Location header, preserving cookies and other headers.
- Specified by:
setStatus
in interfaceHttpServletResponse
- Parameters:
sc
- the status code- See Also:
HttpServletResponse.sendError(int, java.lang.String)
-
setStatus
@Deprecated public void setStatus(int sc, String sm)
Deprecated.Description copied from interface:HttpServletResponse
Sets the status code and message for this response.- Specified by:
setStatus
in interfaceHttpServletResponse
- Parameters:
sc
- the status codesm
- the status message
-
setStatusWithReason
public void setStatusWithReason(int sc, String sm)
Deprecated.
-
getCharacterEncoding
public String getCharacterEncoding()
Deprecated.Description copied from interface:ServletResponse
Returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using theServletResponse.setCharacterEncoding(java.lang.String)
orServletResponse.setContentType(java.lang.String)
methods, or implicitly using theServletResponse.setLocale(java.util.Locale)
method. Explicit specifications take precedence over implicit specifications. Calls made to these methods aftergetWriter
has been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified,ISO-8859-1
is returned.See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
- Specified by:
getCharacterEncoding
in interfaceServletResponse
- Returns:
- a
String
specifying the name of the character encoding, for example,UTF-8
-
getContentType
public String getContentType()
Deprecated.Description copied from interface:ServletResponse
Returns the content type used for the MIME body sent in this response. The content type proper must have been specified usingServletResponse.setContentType(java.lang.String)
before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified and a character encoding has been explicitly or implicitly specified as described inServletResponse.getCharacterEncoding()
, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.- Specified by:
getContentType
in interfaceServletResponse
- Returns:
- a
String
specifying the content type, for example,text/html; charset=UTF-8
, or null
-
getOutputStream
public ServletOutputStream getOutputStream() throws IOException
Deprecated.Description copied from interface:ServletResponse
Returns aServletOutputStream
suitable for writing binary data in the response. The servlet container does not encode the binary data.Calling flush() on the ServletOutputStream commits the response. Either this method or
ServletResponse.getWriter()
may be called to write the body, not both.- Specified by:
getOutputStream
in interfaceServletResponse
- Returns:
- a
ServletOutputStream
for writing binary data - Throws:
IOException
- if an input or output exception occurred- See Also:
ServletResponse.getWriter()
-
isWriting
public boolean isWriting()
Deprecated.
-
isStreaming
public boolean isStreaming()
Deprecated.
-
isWritingOrStreaming
public boolean isWritingOrStreaming()
Deprecated.
-
getWriter
public PrintWriter getWriter() throws IOException
Deprecated.Description copied from interface:ServletResponse
Returns aPrintWriter
object that can send character text to the client. ThePrintWriter
uses the character encoding returned byServletResponse.getCharacterEncoding()
. If the response's character encoding has not been specified as described ingetCharacterEncoding
(i.e., the method just returns the default valueISO-8859-1
),getWriter
updates it toISO-8859-1
.Calling flush() on the
PrintWriter
commits the response.Either this method or
ServletResponse.getOutputStream()
may be called to write the body, not both.- Specified by:
getWriter
in interfaceServletResponse
- Returns:
- a
PrintWriter
object that can return character data to the client - Throws:
UnsupportedEncodingException
- if the character encoding returned bygetCharacterEncoding
cannot be usedIOException
- if an input or output exception occurred- See Also:
ServletResponse.getOutputStream()
,ServletResponse.setCharacterEncoding(java.lang.String)
-
setContentLength
public void setContentLength(int len)
Deprecated.Description copied from interface:ServletResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
setContentLength
in interfaceServletResponse
- Parameters:
len
- an integer specifying the length of the content being returned to the client; sets the Content-Length header
-
getContentLength
public long getContentLength()
Deprecated.
-
isAllContentWritten
public boolean isAllContentWritten(long written)
Deprecated.
-
isContentComplete
public boolean isContentComplete(long written)
Deprecated.
-
closeOutput
public void closeOutput() throws IOException
Deprecated.- Throws:
IOException
-
completeOutput
@Deprecated public void completeOutput() throws IOException
Deprecated.UsecloseOutput()
close the output- Throws:
IOException
-
completeOutput
public void completeOutput(Callback callback)
Deprecated.
-
getLongContentLength
public long getLongContentLength()
Deprecated.
-
setLongContentLength
public void setLongContentLength(long len)
Deprecated.
-
setContentLengthLong
public void setContentLengthLong(long length)
Deprecated.Description copied from interface:ServletResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
setContentLengthLong
in interfaceServletResponse
- Parameters:
length
- an integer specifying the length of the content being returned to the client; sets the Content-Length header
-
setCharacterEncoding
public void setCharacterEncoding(String encoding)
Deprecated.Description copied from interface:ServletResponse
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set byServletResponse.setContentType(java.lang.String)
orServletResponse.setLocale(java.util.Locale)
, this method overrides it. CallingServletResponse.setContentType(java.lang.String)
with theString
oftext/html
and calling this method with theString
ofUTF-8
is equivalent with callingsetContentType
with theString
oftext/html; charset=UTF-8
.This method can be called repeatedly to change the character encoding. This method has no effect if it is called after
getWriter
has been called or after the response has been committed.Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the
Content-Type
header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.- Specified by:
setCharacterEncoding
in interfaceServletResponse
- Parameters:
encoding
- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)- See Also:
#setLocale
-
setContentType
public void setContentType(String contentType)
Deprecated.Description copied from interface:ServletResponse
Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example,text/html;charset=UTF-8
. The response's character encoding is only set from the given content type if this method is called beforegetWriter
is called.This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after
getWriter
has been called or after the response has been committed.Containers must communicate the content type and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the
Content-Type
header is used.- Specified by:
setContentType
in interfaceServletResponse
- Parameters:
contentType
- aString
specifying the MIME type of the content- See Also:
ServletResponse.setLocale(java.util.Locale)
,ServletResponse.setCharacterEncoding(java.lang.String)
,ServletResponse.getOutputStream()
,ServletResponse.getWriter()
-
setBufferSize
public void setBufferSize(int size)
Deprecated.Description copied from interface:ServletResponse
Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found usinggetBufferSize
.A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.
This method must be called before any response body content is written; if content has been written or the response object has been committed, this method throws an
IllegalStateException
.- Specified by:
setBufferSize
in interfaceServletResponse
- Parameters:
size
- the preferred buffer size- See Also:
ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
,ServletResponse.reset()
-
getBufferSize
public int getBufferSize()
Deprecated.Description copied from interface:ServletResponse
Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.- Specified by:
getBufferSize
in interfaceServletResponse
- Returns:
- the actual buffer size used
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
,ServletResponse.reset()
-
flushBuffer
public void flushBuffer() throws IOException
Deprecated.Description copied from interface:ServletResponse
Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.- Specified by:
flushBuffer
in interfaceServletResponse
- Throws:
IOException
- if an I/O occurs during the flushing of the response- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.isCommitted()
,ServletResponse.reset()
-
reset
public void reset()
Deprecated.Description copied from interface:ServletResponse
Clears any data that exists in the buffer as well as the status code and headers. If the response has been committed, this method throws anIllegalStateException
.- Specified by:
reset
in interfaceServletResponse
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
-
resetContent
public void resetContent()
Deprecated.
-
resetForForward
public void resetForForward()
Deprecated.
-
resetBuffer
public void resetBuffer()
Deprecated.Description copied from interface:ServletResponse
Clears the content of the underlying buffer in the response without clearing headers or status code. If the response has been committed, this method throws anIllegalStateException
.- Specified by:
resetBuffer
in interfaceServletResponse
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.isCommitted()
,ServletResponse.reset()
-
setTrailers
public void setTrailers(Supplier<HttpFields> trailers)
Deprecated.
-
getTrailers
public Supplier<HttpFields> getTrailers()
Deprecated.
-
getCommittedMetaData
public MetaData.Response getCommittedMetaData()
Deprecated.Get the MetaData.Response committed for this response. This may differ from the meta data in this response for exceptional responses (eg 4xx and 5xx responses generated by the container) and the committedMetaData should be used for logging purposes.- Returns:
- The committed MetaData or a
newResponseMetaData()
if not yet committed.
-
isCommitted
public boolean isCommitted()
Deprecated.Description copied from interface:ServletResponse
Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.- Specified by:
isCommitted
in interfaceServletResponse
- Returns:
- a boolean indicating if the response has been committed
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.reset()
-
setLocale
public void setLocale(Locale locale)
Deprecated.Description copied from interface:ServletResponse
Sets the locale of the response, if the response has not been committed yet. It also sets the response's character encoding appropriately for the locale, if the character encoding has not been explicitly set usingServletResponse.setContentType(java.lang.String)
orServletResponse.setCharacterEncoding(java.lang.String)
,getWriter
hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains alocale-encoding-mapping-list
element, and that element provides a mapping for the given locale, that mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.This method may be called repeatedly to change locale and character encoding. The method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after
ServletResponse.setContentType(java.lang.String)
has been called with a charset specification, afterServletResponse.setCharacterEncoding(java.lang.String)
has been called, aftergetWriter
has been called, or after the response has been committed.Containers must communicate the locale and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the locale is communicated via the
Content-Language
header, the character encoding as part of theContent-Type
header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.- Specified by:
setLocale
in interfaceServletResponse
- Parameters:
locale
- the locale of the response- See Also:
ServletResponse.getLocale()
,ServletResponse.setContentType(java.lang.String)
,ServletResponse.setCharacterEncoding(java.lang.String)
-
getLocale
public Locale getLocale()
Deprecated.Description copied from interface:ServletResponse
Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)
method. Calls made tosetLocale
after the response is committed have no effect.- Specified by:
getLocale
in interfaceServletResponse
- Returns:
- The locale specified for this response using the
ServletResponse.setLocale(java.util.Locale)
method. If no locale has been specified, the container's default locale is returned. - See Also:
ServletResponse.setLocale(java.util.Locale)
-
getStatus
public int getStatus()
Deprecated.Description copied from interface:HttpServletResponse
Get the HTTP status code for this Response.- Specified by:
getStatus
in interfaceHttpServletResponse
- Returns:
- The HTTP status code for this Response
-
getReason
public String getReason()
Deprecated.
-
getHttpFields
public HttpFields getHttpFields()
Deprecated.
-
getContentCount
public long getContentCount()
Deprecated.
-
putHeaders
public void putHeaders(HttpContent content, long contentLength, boolean etag)
Deprecated.
-
putHeaders
public static void putHeaders(HttpServletResponse response, HttpContent content, long contentLength, boolean etag)
Deprecated.
-
unwrap
public static HttpServletResponse unwrap(ServletResponse servletResponse)
Deprecated.
-
-