Tomcat 10.1.19 · jakarta.servlet.ServletResponse · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	flushBuffer() Forces any content in the buffer to be written to the client.
public int	Returns: the actual buffer size used getBufferSize() Returns the actual buffer size used for the response.
public String	Returns: a `String` specifying the name of the character encoding, for example, `UTF-8` getCharacterEncoding() Returns the name of the character encoding (MIME charset) used for the body sent in this response.
public String	Returns: a `String` specifying the content type, for example, `text/html; charset=UTF-8`, or null getContentType() Returns the content type used for the MIME body sent in this response.
public Locale	Returns: The locale specified for this response using the `setLocale` method. If no locale has been specified, the container's default locale is returned. getLocale() Returns the locale specified for this response using the `setLocale` method.
public ServletOutputStream	Returns: a `ServletOutputStream` for writing binary data getOutputStream() Returns a `ServletOutputStream` suitable for writing binary data in the response.
public PrintWriter	Returns: a `PrintWriter` object that can return character data to the client getWriter() Returns a `PrintWriter` object that can send character text to the client.
public boolean	Returns: a boolean indicating if the response has been committed isCommitted() Returns a boolean indicating if the response has been committed.
public void	reset() Clears any data that exists in the buffer as well as the status code and headers.
public void	resetBuffer() Clears the content of the underlying buffer in the response without clearing headers or status code.
public void	setBufferSize(int the preferred buffer size size) Sets the preferred buffer size for the body of the response.
public void	setCharacterEncoding(String a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) charset) Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
public void	setContentLength(int an integer specifying the length of the content being returned to the client; sets the Content-Length header len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
public void	setContentLengthLong(long an integer specifying the length of the content being returned to the client; sets the Content-Length header length) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
public void	setContentType(String a `String` specifying the MIME type of the content type) Sets the content type of the response being sent to the client, if the response has not been committed yet.
public void	setLocale(Locale the locale of the response loc) Sets the locale of the response, if the response has not been committed yet.

Method Detail

flushBuffer back to summary

flushBuffer	back to summary
public void flushBuffer() throws IOException 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. Exceptions IOException: if an I/O occurs during the flushing of the response See Also `setBufferSize`, `getBufferSize`, `isCommitted`, `reset`

public void flushBuffer() throws IOException

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.

Exceptions

IOException:: if an I/O occurs during the flushing of the response

getBufferSize back to summary

getBufferSize	back to summary
public int getBufferSize() Returns the actual buffer size used for the response. If no buffering is used, this method returns 0. Returns:int the actual buffer size used See Also `setBufferSize`, `flushBuffer`, `isCommitted`, `reset`

public int getBufferSize()

Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.

Returns:int: the actual buffer size used
See Also: setBufferSize, flushBuffer, isCommitted, reset

getCharacterEncoding back to summary

getCharacterEncoding	back to summary
public String getCharacterEncoding() Returns the name of the character encoding (MIME charset) used for the body sent in this response. The charset for the MIME body response can be specified explicitly or implicitly. The priority order for specifying the response body is: explicitly per request using `setCharacterEncoding` and `setContentType` implicitly per request using `setLocale` per web application via the deployment descriptor or `ServletContext#setRequestCharacterEncoding(String)` container default via vendor specific configuration ISO-8859-1 Calls made to `setCharacterEncoding`, `setContentType` or `setLocale` after `getWriter` 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. Returns:String a `String` specifying the name of the character encoding, for example, `UTF-8`

public String getCharacterEncoding()

Returns the name of the character encoding (MIME charset) used for the body sent in this response. The charset for the MIME body response can be specified explicitly or implicitly. The priority order for specifying the response body is:

explicitly per request using setCharacterEncoding and setContentType
implicitly per request using setLocale
per web application via the deployment descriptor or ServletContext#setRequestCharacterEncoding(String)
container default via vendor specific configuration
ISO-8859-1

Calls made to setCharacterEncoding, setContentType or setLocale after getWriter 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.

Returns:String: a String specifying the name of the character encoding, for example, UTF-8

getContentType back to summary

getContentType	back to summary
public String getContentType() Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using `setContentType` 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 in `getCharacterEncoding`, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted. Returns:String a `String` specifying the content type, for example, `text/html; charset=UTF-8`, or null Since Servlet 2.4

public String getContentType()

Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using setContentType 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 in getCharacterEncoding, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.

Returns:String: a String specifying the content type, for example, text/html; charset=UTF-8, or null
Since: Servlet 2.4

getLocale back to summary

getLocale	back to summary
public Locale getLocale() Returns the locale specified for this response using the `setLocale` method. Calls made to `setLocale` after the response is committed have no effect. Returns:Locale The locale specified for this response using the `setLocale` method. If no locale has been specified, the container's default locale is returned. See Also `setLocale`

public Locale getLocale()

Returns the locale specified for this response using the setLocale method. Calls made to setLocale after the response is committed have no effect.

Returns:Locale: The locale specified for this response using the setLocale method. If no locale has been specified, the container's default locale is returned.
See Also: setLocale

getOutputStream back to summary

getOutputStream	back to summary
public ServletOutputStream getOutputStream() throws IOException Returns a `ServletOutputStream` 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 `getWriter` may be called to write the body, not both. Returns:ServletOutputStream a `ServletOutputStream` for writing binary data Exceptions IOException: if an input or output exception occurred IllegalStateException: if the `getWriter` method has been called on this response See Also `getWriter`

public ServletOutputStream getOutputStream() throws IOException

Returns a ServletOutputStream 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 getWriter may be called to write the body, not both.

Returns:ServletOutputStream

a ServletOutputStream for writing binary data

Exceptions

IOException:: if an input or output exception occurred
IllegalStateException:: if the getWriter method has been called on this response

See Also

getWriter

getWriter back to summary

getWriter	back to summary
public PrintWriter getWriter() throws IOException Returns a `PrintWriter` object that can send character text to the client. The `PrintWriter` uses the character encoding returned by `getCharacterEncoding`. If the response's character encoding has not been specified as described in `getCharacterEncoding` (i.e., the method just returns the default value `ISO-8859-1`), `getWriter` updates it to `ISO-8859-1`. Calling flush() on the `PrintWriter` commits the response. Either this method or `getOutputStream` may be called to write the body, not both. Returns:PrintWriter a `PrintWriter` object that can return character data to the client Exceptions IOException: if an input or output exception occurred UnsupportedEncodingException: if the character encoding returned by `getCharacterEncoding` cannot be used IllegalStateException: if the `getOutputStream` method has already been called for this response object See Also `getOutputStream`, `setCharacterEncoding`

public PrintWriter getWriter() throws IOException

Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding returned by getCharacterEncoding. If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

Calling flush() on the PrintWriter commits the response.

Either this method or getOutputStream may be called to write the body, not both.

Returns:PrintWriter

a PrintWriter object that can return character data to the client

Exceptions

IOException:: if an input or output exception occurred
UnsupportedEncodingException:: if the character encoding returned by getCharacterEncoding cannot be used
IllegalStateException:: if the getOutputStream method has already been called for this response object

isCommitted back to summary

isCommitted	back to summary
public boolean isCommitted() Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written. Returns:boolean a boolean indicating if the response has been committed See Also `setBufferSize`, `getBufferSize`, `flushBuffer`, `reset`

public boolean isCommitted()

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Returns:boolean: a boolean indicating if the response has been committed
See Also: setBufferSize, getBufferSize, flushBuffer, reset

reset back to summary

reset	back to summary
public void reset() 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 an `IllegalStateException`. Exceptions IllegalStateException: if the response has already been committed See Also `setBufferSize`, `getBufferSize`, `flushBuffer`, `isCommitted`

public void reset()

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 an IllegalStateException.

Exceptions

IllegalStateException:: if the response has already been committed

resetBuffer back to summary

resetBuffer	back to summary
public void resetBuffer() 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 an `IllegalStateException`. Since Servlet 2.3 See Also `setBufferSize`, `getBufferSize`, `isCommitted`, `reset`

public void resetBuffer()

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 an IllegalStateException.

Since: Servlet 2.3
See Also: setBufferSize, getBufferSize, isCommitted, reset

setBufferSize back to summary

setBufferSize	back to summary
public void setBufferSize(int size) 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 using `getBufferSize`. 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`. Parameters size:int the preferred buffer size Exceptions IllegalStateException: if this method is called after content has been written See Also `getBufferSize`, `flushBuffer`, `isCommitted`, `reset`

public void setBufferSize(int size)

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 using getBufferSize.

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.

Parameters

size:int: the preferred buffer size

Exceptions

IllegalStateException:: if this method is called after content has been written

setCharacterEncoding back to summary

setCharacterEncoding	back to summary
public void setCharacterEncoding(String charset) 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 by container default, ServletContext default, `setContentType` or `setLocale`, this method overrides it. Calling `setContentType` with the `String` of `text/html` and calling this method with the `String` of `UTF-8` is equivalent with calling `setContentType` with the `String` of `text/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. Parameters charset:String a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) Since Servlet 2.4 See Also `setLocale`

public void setCharacterEncoding(String charset)

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 by container default, ServletContext default, setContentType or setLocale, this method overrides it. Calling setContentType with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/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.

Parameters

charset:String: a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)

Since

Servlet 2.4

See Also

setLocale

setContentLength	back to summary
public void setContentLength(int len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header. Parameters len:int an integer specifying the length of the content being returned to the client; sets the Content-Length header

setContentLength

back to summary

public void setContentLength(int len)

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Parameters

len:int: an integer specifying the length of the content being returned to the client; sets the Content-Length header

setContentLengthLong	back to summary
public void setContentLengthLong(long length) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header. Parameters length:long an integer specifying the length of the content being returned to the client; sets the Content-Length header Since Servlet 3.1

setContentLengthLong

back to summary

public void setContentLengthLong(long length)

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Parameters

length:long: an integer specifying the length of the content being returned to the client; sets the Content-Length header

Since

Servlet 3.1

setContentType back to summary

setContentType	back to summary
public void setContentType(String type) 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 before `getWriter` 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. Parameters type:String a `String` specifying the MIME type of the content See Also `setLocale`, `setCharacterEncoding`, `getOutputStream`, `getWriter`

public void setContentType(String type)

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 before getWriter 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.

Parameters

type:String: a String specifying the MIME type of the content

setLocale back to summary

setLocale	back to summary
public void setLocale(Locale loc) 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 using `setContentType` or `setCharacterEncoding`, `getWriter` hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains a `locale-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 `setContentType` has been called with a charset specification, after `setCharacterEncoding` has been called, after `getWriter` 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 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. Parameters loc:Locale the locale of the response See Also `getLocale`, `setContentType`, `setCharacterEncoding`

public void setLocale(Locale loc)

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 using setContentType or setCharacterEncoding, getWriter hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains a locale-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 setContentType has been called with a charset specification, after setCharacterEncoding has been called, after getWriter 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 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.

Parameters

loc:Locale: the locale of the response

public Interface ServletResponse

Method Summary

Method Detail