Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.mortbay.jetty.servlet.ServletHttpResponse
Field Summary | |
static int | |
static int | |
static int | |
static int |
Constructor Summary | |
|
Method Summary | |
void | |
void |
|
void |
|
void |
|
boolean |
|
String |
|
String |
|
String |
|
String |
|
void |
|
int |
|
String |
|
String |
|
Locale |
|
ServletOutputStream |
|
PrintWriter |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
static ServletHttpResponse |
|
public static final int DISABLED
- Field Value:
- -1
public static final int NO_OUT
- Field Value:
- 0
public static final int OUTPUTSTREAM_OUT
- Field Value:
- 1
public static final int WRITER_OUT
- Field Value:
- 2
public void addCookie(Cookie cookie)
Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
- Specified by:
- addCookie in interface HttpServletResponse
- Parameters:
cookie
- the Cookie to return to the client
public void addDateHeader(String name, long value)
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 interface HttpServletResponse
- Parameters:
name
- the name of the header to set
public void addHeader(String name, String value)
Adds a response header with the given name and value. This method allows response headers to have multiple values.
- Specified by:
- addHeader in interface HttpServletResponse
- 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)
public void addIntHeader(String name, int value)
Adds a response header with the given name and integer value. This method allows response headers to have multiple values.
- Specified by:
- addIntHeader in interface HttpServletResponse
- Parameters:
name
- the name of the headervalue
- the assigned integer value
public boolean containsHeader(String name)
Returns a boolean indicating whether the named response header has already been set.
- Specified by:
- containsHeader in interface HttpServletResponse
- Parameters:
name
- the header name
- Returns:
true
if the named response header has already been set;false
otherwise
public String encodeRedirectURL(String url)
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 separete from theencodeURL
method. All URLs sent to theHttpServletResponse.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 interface HttpServletResponse
- Parameters:
url
- the url to be encoded.
- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
public String encodeRedirectUrl(String url)
Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead
- Specified by:
- encodeRedirectUrl in interface HttpServletResponse
public String encodeURL(String url)
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 interface HttpServletResponse
- Parameters:
url
- the url to be encoded.
- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
public String encodeUrl(String url)
Deprecated. As of version 2.1, use encodeURL(String url) instead
- Specified by:
- encodeUrl in interface HttpServletResponse
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.
- Specified by:
- flushBuffer in interface ServletResponse
public int getBufferSize()
Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.
- Specified by:
- getBufferSize in interface ServletResponse
- Returns:
- the actual buffer size used
public String getCharacterEncoding()
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(String)
orServletResponse.setContentType(String)
methods, or implicitly using theServletResponse.setLocale(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 interface ServletResponse
- Returns:
- a
String
specifying the name of the character encoding, for example,UTF-8
public String getContentType()
Returns the content type used for the MIME body sent in this response. The content type proper must have been specified usingServletResponse.setContentType(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 interface ServletResponse
- Returns:
- a
String
specifying the content type, for example,text/html; charset=UTF-8
, or null
- Since:
- Servlet 2.4
public Locale getLocale()
Returns the locale specified for this response using theServletResponse.setLocale(Locale)
method. Calls made tosetLocale
after the response is committed have no effect. If no locale has been specified, the container's default locale is returned.
- Specified by:
- getLocale in interface ServletResponse
- See Also:
ServletResponse.setLocale(Locale)
public ServletOutputStream getOutputStream()
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 orServletResponse.getWriter()
may be called to write the body, not both.
- Specified by:
- getOutputStream in interface ServletResponse
- Returns:
- a
ServletOutputStream
for writing binary data
- See Also:
ServletResponse.getWriter()
public PrintWriter getWriter() throws IOException
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 thePrintWriter
commits the response. Either this method orServletResponse.getOutputStream()
may be called to write the body, not both.
- Specified by:
- getWriter in interface ServletResponse
- Returns:
- a
PrintWriter
object that can return character data to the client
public boolean isCommitted()
Returns a boolean indicating if the response has been committed. A commited response has already had its status code and headers written.
- Specified by:
- isCommitted in interface ServletResponse
- 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. If the response has been committed, this method throws anIllegalStateException
.
- Specified by:
- reset in interface ServletResponse
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 anIllegalStateException
.
- Specified by:
- resetBuffer in interface ServletResponse
- Since:
- Servlet 2.3
public void sendError(int status) throws IOException
Sends an error response to the client using the specified status code and clearing the buffer. 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:
- sendError in interface HttpServletResponse
- Parameters:
public void sendError(int status, String message) throws IOException
Sends an error response to the client using the specified status. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter. 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:
- sendError in interface HttpServletResponse
- Parameters:
public void sendRedirect(String url) throws IOException
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 interface HttpServletResponse
- Parameters:
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 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 anIllegalStateException
.
- Specified by:
- setBufferSize in interface ServletResponse
- Parameters:
size
- the preferred buffer size
public void setCharacterEncoding(String encoding)
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(String)
orServletResponse.setLocale(Locale)
, this method overrides it. CallingServletResponse.setContentType(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 aftergetWriter
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 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:
- setCharacterEncoding in interface ServletResponse
- Parameters:
- Since:
- Servlet 2.4
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.
- Specified by:
- setContentLength in interface ServletResponse
- Parameters:
len
- an integer specifying the length of the content being returned to the client; sets the Content-Length header
public void setContentType(String contentType)
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 aftergetWriter
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, theContent-Type
header is used.
- Specified by:
- setContentType in interface ServletResponse
- Parameters:
public void setDateHeader(String name, long value)
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 interface HttpServletResponse
- Parameters:
name
- the name of the header to set
public void setHeader(String name, String value)
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 interface HttpServletResponse
- 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)
public void setIntHeader(String name, int value)
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 interface HttpServletResponse
- Parameters:
name
- the name of the headervalue
- the assigned integer value
public void setLocale(Locale locale)
Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate. This method should be called before a call togetWriter()
. By default, the response locale is the default locale for the server.
- Specified by:
- setLocale in interface ServletResponse
- Parameters:
locale
- the Locale of the response
- See Also:
getLocale()
public void setStatus(int status)
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 applicaion, 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 interface HttpServletResponse
- Parameters:
- See Also:
sendError
public void setStatus(int status, String message)
Deprecated. As of version 2.1 of the Servlet spec. To set a status code use
setStatus(int)
, to send an error with a description usesendError(int, String)
. Sets the status code and message for this response.
- Specified by:
- setStatus in interface HttpServletResponse
- Parameters:
status
- the status codemessage
- the status message
public String toString()
public static ServletHttpResponse unwrap(ServletResponse response)
Unwrap a ServletResponse.
- Parameters:
response
-
- Returns:
- The core ServletHttpResponse which must be the underlying response object