| javax.servlet.http.HttpServletResponse
All known Subclasses: javax.servlet.http.HttpServletResponseWrapper, org.apache.catalina.connector.Response, org.apache.catalina.core.DummyResponse, org.apache.catalina.connector.ResponseFacade,
| HttpServletResponse | | public interface HttpServletResponse extends ServletResponse(Code) | | Extends the
ServletResponse interface to provide HTTP-specific
functionality in sending a response. For example, it has methods
to access HTTP headers and cookies.
The servlet container creates an HttpServletResponse object
and passes it as an argument to the servlet's service methods
(doGet, doPost, etc).
author:
Various
version:
$Version$
See Also: javax.servlet.ServletResponse |
| Field Summary | |
| final public static int | SC_ACCEPTED
Status code (202) indicating that a request was accepted for
processing, but was not completed. | | final public static int | SC_BAD_GATEWAY
Status code (502) indicating that the HTTP server received an
invalid response from a server it consulted when acting as a
proxy or gateway. | | final public static int | SC_BAD_REQUEST
Status code (400) indicating the request sent by the client was
syntactically incorrect. | | final public static int | SC_CONFLICT
Status code (409) indicating that the request could not be
completed due to a conflict with the current state of the
resource. | | final public static int | SC_CONTINUE
Status code (100) indicating the client can continue. | | final public static int | SC_CREATED
Status code (201) indicating the request succeeded and created
a new resource on the server. | | final public static int | SC_EXPECTATION_FAILED
Status code (417) indicating that the server could not meet the
expectation given in the Expect request header. | | final public static int | SC_FORBIDDEN
Status code (403) indicating the server understood the request
but refused to fulfill it. | | final public static int | SC_FOUND
Status code (302) indicating that the resource reside
temporarily under a different URI. | | final public static int | SC_GATEWAY_TIMEOUT
Status code (504) indicating that the server did not receive
a timely response from the upstream server while acting as
a gateway or proxy. | | final public static int | SC_GONE
Status code (410) indicating that the resource is no longer
available at the server and no forwarding address is known. | | final public static int | SC_HTTP_VERSION_NOT_SUPPORTED
Status code (505) indicating that the server does not support
or refuses to support the HTTP protocol version that was used
in the request message. | | final public static int | SC_INTERNAL_SERVER_ERROR
Status code (500) indicating an error inside the HTTP server
which prevented it from fulfilling the request. | | final public static int | SC_LENGTH_REQUIRED
Status code (411) indicating that the request cannot be handled
without a defined Content-Length. | | final public static int | SC_METHOD_NOT_ALLOWED
Status code (405) indicating that the method specified in the
Request-Line is not allowed for the resource
identified by the Request-URI. | | final public static int | SC_MOVED_PERMANENTLY
Status code (301) indicating that the resource has permanently
moved to a new location, and that future references should use a
new URI with their requests. | | final public static int | SC_MOVED_TEMPORARILY
Status code (302) indicating that the resource has temporarily
moved to another location, but that future references should
still use the original URI to access the resource. | | final public static int | SC_MULTIPLE_CHOICES
Status code (300) indicating that the requested resource
corresponds to any one of a set of representations, each with
its own specific location. | | final public static int | SC_NON_AUTHORITATIVE_INFORMATION
Status code (203) indicating that the meta information presented
by the client did not originate from the server. | | final public static int | SC_NOT_ACCEPTABLE
Status code (406) indicating that the resource identified by the
request is only capable of generating response entities which have
content characteristics not acceptable according to the accept
headers sent in the request. | | final public static int | SC_NOT_FOUND
Status code (404) indicating that the requested resource is not
available. | | final public static int | SC_NOT_IMPLEMENTED
Status code (501) indicating the HTTP server does not support
the functionality needed to fulfill the request. | | final public static int | SC_NOT_MODIFIED
Status code (304) indicating that a conditional GET operation
found that the resource was available and not modified. | | final public static int | SC_NO_CONTENT
Status code (204) indicating that the request succeeded but that
there was no new information to return. | | final public static int | SC_OK
Status code (200) indicating the request succeeded normally. | | final public static int | SC_PARTIAL_CONTENT
Status code (206) indicating that the server has fulfilled
the partial GET request for the resource. | | final public static int | SC_PAYMENT_REQUIRED
Status code (402) reserved for future use. | | final public static int | SC_PRECONDITION_FAILED
Status code (412) indicating that the precondition given in one
or more of the request-header fields evaluated to false when it
was tested on the server. | | final public static int | SC_PROXY_AUTHENTICATION_REQUIRED
Status code (407) indicating that the client MUST first
authenticate itself with the proxy. | | final public static int | SC_REQUESTED_RANGE_NOT_SATISFIABLE
Status code (416) indicating that the server cannot serve the
requested byte range. | | final public static int | SC_REQUEST_ENTITY_TOO_LARGE
Status code (413) indicating that the server is refusing to process
the request because the request entity is larger than the server is
willing or able to process. | | final public static int | SC_REQUEST_TIMEOUT
Status code (408) indicating that the client did not produce a
request within the time that the server was prepared to wait. | | final public static int | SC_REQUEST_URI_TOO_LONG
Status code (414) indicating that the server is refusing to service
the request because the Request-URI is longer
than the server is willing to interpret. | | final public static int | SC_RESET_CONTENT
Status code (205) indicating that the agent SHOULD reset
the document view which caused the request to be sent. | | final public static int | SC_SEE_OTHER
Status code (303) indicating that the response to the request
can be found under a different URI. | | final public static int | SC_SERVICE_UNAVAILABLE
Status code (503) indicating that the HTTP server is
temporarily overloaded, and unable to handle the request. | | final public static int | SC_SWITCHING_PROTOCOLS
Status code (101) indicating the server is switching protocols
according to Upgrade header. | | final public static int | SC_TEMPORARY_REDIRECT
Status code (307) indicating that the requested resource
resides temporarily under a different URI. | | final public static int | SC_UNAUTHORIZED
Status code (401) indicating that the request requires HTTP
authentication. | | final public static int | SC_UNSUPPORTED_MEDIA_TYPE
Status code (415) indicating that the server is refusing to service
the request because the entity of the request is in a format not
supported by the requested resource for the requested method. | | final public static int | SC_USE_PROXY
Status code (305) indicating that the requested resource
MUST be accessed through the proxy given by the
Location field. |
| Method Summary | |
| public void | addCookie(Cookie cookie)
Adds the specified cookie to the response. | | public void | addDateHeader(String name, long date)
Adds a response header with the given name and
date-value. | | public void | addHeader(String name, String value)
Adds a response header with the given name and value. | | public void | addIntHeader(String name, int value)
Adds a response header with the given name and
integer value. | | public boolean | containsHeader(String name)
Returns a boolean indicating whether the named response header
has already been set. | | public String | encodeRedirectURL(String url)
Encodes the specified URL for use in the
sendRedirect method or, if encoding is not needed,
returns the URL unchanged. | | public String | encodeRedirectUrl(String url)
| | 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. | | public String | encodeUrl(String url)
| | public void | sendError(int sc, String msg)
Sends an error response to the client using the specified
status. | | public void | sendError(int sc)
Sends an error response to the client using the specified status
code and clearing the buffer. | | public void | sendRedirect(String location)
Sends a temporary redirect response to the client using the
specified redirect location URL. | | public void | setDateHeader(String name, long date)
Sets a response header with the given name and
date-value. | | 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. | | public void | setIntHeader(String name, int value)
Sets a response header with the given name and
integer value. | | public void | setStatus(int sc)
Sets the status code for this response. | | public void | setStatus(int sc, String sm)
|
| SC_ACCEPTED | | final public static int SC_ACCEPTED(Code) | | Status code (202) indicating that a request was accepted for
processing, but was not completed.
|
| SC_BAD_GATEWAY | | final public static int SC_BAD_GATEWAY(Code) | | Status code (502) indicating that the HTTP server received an
invalid response from a server it consulted when acting as a
proxy or gateway.
|
| SC_BAD_REQUEST | | final public static int SC_BAD_REQUEST(Code) | | Status code (400) indicating the request sent by the client was
syntactically incorrect.
|
| SC_CONFLICT | | final public static int SC_CONFLICT(Code) | | Status code (409) indicating that the request could not be
completed due to a conflict with the current state of the
resource.
|
| SC_CONTINUE | | final public static int SC_CONTINUE(Code) | | Status code (100) indicating the client can continue.
|
| SC_CREATED | | final public static int SC_CREATED(Code) | | Status code (201) indicating the request succeeded and created
a new resource on the server.
|
| SC_EXPECTATION_FAILED | | final public static int SC_EXPECTATION_FAILED(Code) | | Status code (417) indicating that the server could not meet the
expectation given in the Expect request header.
|
| SC_FORBIDDEN | | final public static int SC_FORBIDDEN(Code) | | Status code (403) indicating the server understood the request
but refused to fulfill it.
|
| SC_FOUND | | final public static int SC_FOUND(Code) | | Status code (302) indicating that the resource reside
temporarily under a different URI. Since the redirection might
be altered on occasion, the client should continue to use the
Request-URI for future requests.(HTTP/1.1) To represent the
status code (302), it is recommended to use this variable.
|
| SC_GATEWAY_TIMEOUT | | final public static int SC_GATEWAY_TIMEOUT(Code) | | Status code (504) indicating that the server did not receive
a timely response from the upstream server while acting as
a gateway or proxy.
|
| SC_GONE | | final public static int SC_GONE(Code) | | Status code (410) indicating that the resource is no longer
available at the server and no forwarding address is known.
This condition SHOULD be considered permanent.
|
| SC_HTTP_VERSION_NOT_SUPPORTED | | final public static int SC_HTTP_VERSION_NOT_SUPPORTED(Code) | | Status code (505) indicating that the server does not support
or refuses to support the HTTP protocol version that was used
in the request message.
|
| SC_INTERNAL_SERVER_ERROR | | final public static int SC_INTERNAL_SERVER_ERROR(Code) | | Status code (500) indicating an error inside the HTTP server
which prevented it from fulfilling the request.
|
| SC_LENGTH_REQUIRED | | final public static int SC_LENGTH_REQUIRED(Code) | | Status code (411) indicating that the request cannot be handled
without a defined Content-Length.
|
| SC_METHOD_NOT_ALLOWED | | final public static int SC_METHOD_NOT_ALLOWED(Code) | | Status code (405) indicating that the method specified in the
Request-Line is not allowed for the resource
identified by the Request-URI.
|
| SC_MOVED_PERMANENTLY | | final public static int SC_MOVED_PERMANENTLY(Code) | | Status code (301) indicating that the resource has permanently
moved to a new location, and that future references should use a
new URI with their requests.
|
| SC_MOVED_TEMPORARILY | | final public static int SC_MOVED_TEMPORARILY(Code) | | Status code (302) indicating that the resource has temporarily
moved to another location, but that future references should
still use the original URI to access the resource.
This definition is being retained for backwards compatibility.
SC_FOUND is now the preferred definition.
|
| SC_MULTIPLE_CHOICES | | final public static int SC_MULTIPLE_CHOICES(Code) | | Status code (300) indicating that the requested resource
corresponds to any one of a set of representations, each with
its own specific location.
|
| SC_NON_AUTHORITATIVE_INFORMATION | | final public static int SC_NON_AUTHORITATIVE_INFORMATION(Code) | | Status code (203) indicating that the meta information presented
by the client did not originate from the server.
|
| SC_NOT_ACCEPTABLE | | final public static int SC_NOT_ACCEPTABLE(Code) | | Status code (406) indicating that the resource identified by the
request is only capable of generating response entities which have
content characteristics not acceptable according to the accept
headers sent in the request.
|
| SC_NOT_FOUND | | final public static int SC_NOT_FOUND(Code) | | Status code (404) indicating that the requested resource is not
available.
|
| SC_NOT_IMPLEMENTED | | final public static int SC_NOT_IMPLEMENTED(Code) | | Status code (501) indicating the HTTP server does not support
the functionality needed to fulfill the request.
|
| SC_NOT_MODIFIED | | final public static int SC_NOT_MODIFIED(Code) | | Status code (304) indicating that a conditional GET operation
found that the resource was available and not modified.
|
| SC_NO_CONTENT | | final public static int SC_NO_CONTENT(Code) | | Status code (204) indicating that the request succeeded but that
there was no new information to return.
|
| SC_OK | | final public static int SC_OK(Code) | | Status code (200) indicating the request succeeded normally.
|
| SC_PARTIAL_CONTENT | | final public static int SC_PARTIAL_CONTENT(Code) | | Status code (206) indicating that the server has fulfilled
the partial GET request for the resource.
|
| SC_PAYMENT_REQUIRED | | final public static int SC_PAYMENT_REQUIRED(Code) | | Status code (402) reserved for future use.
|
| SC_PRECONDITION_FAILED | | final public static int SC_PRECONDITION_FAILED(Code) | | Status code (412) indicating that the precondition given in one
or more of the request-header fields evaluated to false when it
was tested on the server.
|
| SC_PROXY_AUTHENTICATION_REQUIRED | | final public static int SC_PROXY_AUTHENTICATION_REQUIRED(Code) | | Status code (407) indicating that the client MUST first
authenticate itself with the proxy.
|
| SC_REQUESTED_RANGE_NOT_SATISFIABLE | | final public static int SC_REQUESTED_RANGE_NOT_SATISFIABLE(Code) | | Status code (416) indicating that the server cannot serve the
requested byte range.
|
| SC_REQUEST_ENTITY_TOO_LARGE | | final public static int SC_REQUEST_ENTITY_TOO_LARGE(Code) | | Status code (413) indicating that the server is refusing to process
the request because the request entity is larger than the server is
willing or able to process.
|
| SC_REQUEST_TIMEOUT | | final public static int SC_REQUEST_TIMEOUT(Code) | | Status code (408) indicating that the client did not produce a
request within the time that the server was prepared to wait.
|
| SC_REQUEST_URI_TOO_LONG | | final public static int SC_REQUEST_URI_TOO_LONG(Code) | | Status code (414) indicating that the server is refusing to service
the request because the Request-URI is longer
than the server is willing to interpret.
|
| SC_RESET_CONTENT | | final public static int SC_RESET_CONTENT(Code) | | Status code (205) indicating that the agent SHOULD reset
the document view which caused the request to be sent.
|
| SC_SEE_OTHER | | final public static int SC_SEE_OTHER(Code) | | Status code (303) indicating that the response to the request
can be found under a different URI.
|
| SC_SERVICE_UNAVAILABLE | | final public static int SC_SERVICE_UNAVAILABLE(Code) | | Status code (503) indicating that the HTTP server is
temporarily overloaded, and unable to handle the request.
|
| SC_SWITCHING_PROTOCOLS | | final public static int SC_SWITCHING_PROTOCOLS(Code) | | Status code (101) indicating the server is switching protocols
according to Upgrade header.
|
| SC_TEMPORARY_REDIRECT | | final public static int SC_TEMPORARY_REDIRECT(Code) | | Status code (307) indicating that the requested resource
resides temporarily under a different URI. The temporary URI
SHOULD be given by the Location
field in the response.
|
| SC_UNAUTHORIZED | | final public static int SC_UNAUTHORIZED(Code) | | Status code (401) indicating that the request requires HTTP
authentication.
|
| SC_UNSUPPORTED_MEDIA_TYPE | | final public static int SC_UNSUPPORTED_MEDIA_TYPE(Code) | | Status code (415) indicating that the server is refusing to service
the request because the entity of the request is in a format not
supported by the requested resource for the requested method.
|
| SC_USE_PROXY | | final public static int SC_USE_PROXY(Code) | | Status code (305) indicating that the requested resource
MUST be accessed through the proxy given by the
Location field.
|
| addCookie | | public void addCookie(Cookie cookie)(Code) | | Adds the specified cookie to the response. This method can be called
multiple times to set more than one cookie.
Parameters:
cookie - the Cookie to return to the client |
| addDateHeader | | public void addDateHeader(String name, long date)(Code) | | 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.
Parameters:
name - the name of the header to set
Parameters:
date - the additional date value
See Also: HttpServletResponse.setDateHeader |
| addHeader | | public void addHeader(String name, String value)(Code) | | Adds a response header with the given name and value.
This method allows response headers to have multiple values.
Parameters:
name - the name of the header
Parameters:
value - the additional header value If it containsoctet string, it should be encodedaccording to RFC 2047(http://www.ietf.org/rfc/rfc2047.txt)
See Also: HttpServletResponse.setHeader |
| addIntHeader | | public void addIntHeader(String name, int value)(Code) | | Adds a response header with the given name and
integer value. This method allows response headers to have multiple
values.
Parameters:
name - the name of the header
Parameters:
value - the assigned integer value
See Also: HttpServletResponse.setIntHeader |
| containsHeader | | public boolean containsHeader(String name)(Code) | | Returns a boolean indicating whether the named response header
has already been set.
Parameters:
name - the header name true if the named response header has already been set; false otherwise |
| encodeRedirectURL | | public String encodeRedirectURL(String url)(Code) | | Encodes the specified URL for use in the
sendRedirect 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 the
encodeURL 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.
Parameters:
url - the url to be encoded. the encoded URL if encoding is needed;the unchanged URL otherwise.
See Also: HttpServletResponse.sendRedirect
See Also: HttpServletResponse.encodeUrl |
| encodeRedirectUrl | | public String encodeRedirectUrl(String url)(Code) | |
Parameters:
url - the url to be encoded. the encoded URL if encoding is needed; the unchanged URL otherwise. |
| encodeURL | | public String encodeURL(String url)(Code) | | 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.
Parameters:
url - the url to be encoded. the encoded URL if encoding is needed;the unchanged URL otherwise. |
| encodeUrl | | public String encodeUrl(String url)(Code) | |
Parameters:
url - the url to be encoded. the encoded URL if encoding is needed; the unchanged URL otherwise. |
| sendError | | public void sendError(int sc, String msg) throws IOException(Code) | | 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.
Parameters:
sc - the error status code
Parameters:
msg - the descriptive message
exception:
IOException - If an input or output exception occurs
exception:
IllegalStateException - If the response was committed |
| sendError | | public void sendError(int sc) throws IOException(Code) | | 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.
Parameters:
sc - the error status code
exception:
IOException - If an input or output exception occurs
exception:
IllegalStateException - If the response was committedbefore this method call |
| sendRedirect | | public void sendRedirect(String location) throws IOException(Code) | | 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.
Parameters:
location - the redirect location URL
exception:
IOException - If an input or output exception occurs
exception:
IllegalStateException - If the response was committed orif a partial URL is given and cannot be converted into a valid URL |
| setDateHeader | | public void setDateHeader(String name, long date)(Code) | | 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. The
containsHeader method can be used to test for the
presence of a header before setting its value.
Parameters:
name - the name of the header to set
Parameters:
date - the assigned date value
See Also: HttpServletResponse.containsHeader
See Also: HttpServletResponse.addDateHeader |
| setHeader | | public void setHeader(String name, String value)(Code) | | Sets a response header with the given name and value.
If the header had already been set, the new value overwrites the
previous one. The containsHeader method can be
used to test for the presence of a header before setting its
value.
Parameters:
name - the name of the header
Parameters:
value - 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
See Also: HttpServletResponse.addHeader |
| setIntHeader | | public void setIntHeader(String name, int value)(Code) | | 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. The containsHeader
method can be used to test for the presence of a header before
setting its value.
Parameters:
name - the name of the header
Parameters:
value - the assigned integer value
See Also: HttpServletResponse.containsHeader
See Also: HttpServletResponse.addIntHeader |
| setStatus | | public void setStatus(int sc)(Code) | | 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, the sendError method should be used
instead.
The container clears the buffer and sets the Location header, preserving
cookies and other headers.
Parameters:
sc - the status code
See Also: HttpServletResponse.sendError |
| setStatus | | public void setStatus(int sc, String sm)(Code) | |
Parameters:
sc - the status code
Parameters:
sm - the status message |
|
|