Defines an object to assist a servlet in sending a response to the client. The servlet container creates aServletResponse object and passes it as an argument to the servlet'sservice method.
To send binary data in a MIME body response, use theServletOutputStream returned bygetOutputStream(). To send character data, use thePrintWriter object returned bygetWriter(). To mix binary and text data, for example, to create a multipart response, use aServletOutputStream and manage the character sections manually.
The charset for the MIME body response can be specified withsetContentType(java.lang.String). For example, "text/html; charset=Shift_JIS". The charset can alternately be set usingsetLocale(java.util.Locale). If no charset is specified, ISO-8859-1 will be used. ThesetContentType orsetLocale method must be called beforegetWriter for the charset to affect the construction of the writer.
See the Internet RFCs such as RFC 2045 for more information on MIME. Protocols such as SMTP and HTTP define profiles of MIME, and those standards are still evolving.
ServletOutputStreamflushBuffer()Forces any content in the buffer to be written to the client. | |
getBufferSize()Returns the actual buffer size used for the response. | |
getCharacterEncoding()Returns the name of the charset used for the MIME body sent in this response. | |
getLocale()Returns the locale assigned to the response. | |
getOutputStream()Returns a ServletOutputStream suitable for writing binary data in the response. | |
getWriter()Returns a PrintWriter object that can send character text to the client. | |
isCommitted()Returns a boolean indicating if the response has been committed. | |
reset()Clears any data that exists in the buffer as well as the status code and headers. | |
resetBuffer()Clears the content of the underlying buffer in the response without clearing headers or status code. | |
setBufferSize(int size)Sets the preferred buffer size for the body of the response. | |
setContentLength(int len)Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header. | |
setContentType(java.lang.String type)Sets the content type of the response being sent to the client. | |
setLocale(java.util.Locale loc)Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate. | |
public java.lang.StringgetCharacterEncoding()
If no charset has been assigned, it is implicitly set toISO-8859-1 (Latin-1).
See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt) for more information about character encoding and MIME.
String specifying thename of the charset, forexample,ISO-8859-1publicServletOutputStreamgetOutputStream() throws java.io.IOException
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 orgetWriter() may be called to write the body, not both.
ServletOutputStream for writing binary datajava.lang.IllegalStateException - if thegetWriter method has been called on this responsejava.io.IOException - if an input or output exception occurredgetWriter()public java.io.PrintWritergetWriter() throws java.io.IOException
PrintWriter object that can send character text to the client. The character encoding used is the one specified in thecharset= property of thesetContentType(java.lang.String) method, which must be calledbefore calling this method for the charset to take effect.If necessary, the MIME type of the response is modified to reflect the character encoding used.
Calling flush() on the PrintWriter commits the response.
Either this method orgetOutputStream() may be called to write the body, not both.
PrintWriter object that can return character data to the clientjava.io.UnsupportedEncodingException - if the charset specified insetContentType cannot beusedjava.lang.IllegalStateException - if thegetOutputStream method has already been called for this response objectjava.io.IOException - if an input or output exception occurredgetOutputStream(),setContentType(java.lang.String)public voidsetContentLength(int len)
len - an integer specifying the length of the content being returned to the client; setsthe Content-Length headerpublic voidsetContentType(java.lang.String type)
text/html; charset=ISO-8859-4.If obtaining aPrintWriter, this method should be called first.
type - aString specifying the MIME type of the contentgetOutputStream(),getWriter()public voidsetBufferSize(int size)
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, this method throws anIllegalStateException.
size - the preferred buffer sizejava.lang.IllegalStateException - if this method is called aftercontent has been writtengetBufferSize(),flushBuffer(),isCommitted(),reset()public intgetBufferSize()
setBufferSize(int),flushBuffer(),isCommitted(),reset()public voidflushBuffer() throws java.io.IOException
setBufferSize(int),getBufferSize(),isCommitted(),reset()public voidresetBuffer()
IllegalStateException.setBufferSize(int),getBufferSize(),isCommitted(),reset()public booleanisCommitted()
setBufferSize(int),getBufferSize(),flushBuffer(),reset()public voidreset()
IllegalStateException.java.lang.IllegalStateException - if the response has already been committedsetBufferSize(int),getBufferSize(),flushBuffer(),isCommitted()public voidsetLocale(java.util.Locale loc)
getWriter(). By default, the response locale is the default locale for the server.loc - the locale of the responsegetLocale()public java.util.LocalegetLocale()
setLocale(java.util.Locale)