public Interface HttpServletResponse

Status code (202) indicating that a request was accepted for processing, but was not completed.

Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.

Status code (400) indicating the request sent by the client was syntactically incorrect.

Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.

Status code (100) indicating the client can continue.

Status code (201) indicating the request succeeded and created a new resource on the server.

Status code (417) indicating that the server could not meet the expectation given in the Expect request header.

Status code (403) indicating the server understood the request but refused to fulfill it.

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.

Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy.

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.

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.

Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.

Status code (411) indicating that the request cannot be handled without a defined Content-Length.

Status code (405) indicating that the method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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.

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.

Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location.

Status code (204) indicating that the request succeeded but that there was no new information to return.

Status code (203) indicating that the meta information presented by the client did not originate from the server.

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.

Status code (404) indicating that the requested resource is not available.

Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.

Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.

Status code (200) indicating the request succeeded normally.

Status code (206) indicating that the server has fulfilled the partial GET request for the resource.

Status code (402) reserved for future use.

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.

Status code (407) indicating that the client MUST first authenticate itself with the proxy.

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.

Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait.

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.

Status code (416) indicating that the server cannot serve the requested byte range.

Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.

Status code (303) indicating that the response to the request can be found under a different URI.

Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.

Status code (101) indicating the server is switching protocols according to Upgrade header.

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.

Status code (401) indicating that the request requires HTTP authentication.

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.

Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

Parameters

cookie:Cookie

the Cookie to return to the client

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:String

the name of the header to set

date:long

the additional date value

See Also

setDateHeader

Adds a response header with the given name and value. This method allows response headers to have multiple values.

Parameters

name:String

the name of the header

value:String

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

setHeader

Adds a response header with the given name and integer value. This method allows response headers to have multiple values.

Parameters

name:String

the name of the header

value:int

the assigned integer value

See Also

setIntHeader

Returns a boolean indicating whether the named response header has already been set.

Parameters

name:String

the header name

Returns:boolean

true if the named response header has already been set; false otherwise

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. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary. 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.

If the URL is relative, it is always relative to the current HttpServletRequest.

Parameters

url:String

the url to be encoded.

Returns:String

the encoded URL if encoding is needed; the unchanged URL otherwise.

Exceptions

IllegalArgumentException:

if the url is not valid

See Also

sendRedirect, encodeUrl

Parameters

url:String

the url to be encoded.

Returns:String

the encoded URL if encoding is needed; the unchanged URL otherwise.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:

if the url is not valid

Encodes the specified URL by including the session ID, 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.

If the URL is relative, it is always relative to the current HttpServletRequest.

Parameters

url:String

the url to be encoded.

Returns:String

the encoded URL if encoding is needed; the unchanged URL otherwise.

Exceptions

IllegalArgumentException:

if the url is not valid

Parameters

url:String

the url to be encoded.

Returns:String

the encoded URL if encoding is needed; the unchanged URL otherwise.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:

if the url is not valid

Gets the value of the response header with the given name.

If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

This method considers only response headers set or added via setHeader, addHeader, setDateHeader, addDateHeader, setIntHeader, or addIntHeader, respectively.

Parameters

name:String

the name of the response header whose value to return

Returns:String

the value of the response header with the given name, or null if no header with the given name has been set on this response

Since

Servlet 3.0

Gets the names of the headers of this response.

This method considers only response headers set or added via setHeader, addHeader, setDateHeader, addDateHeader, setIntHeader, or addIntHeader, respectively.

Any changes to the returned Collection must not affect this HttpServletResponse.

Returns:Collection<String>

a (possibly empty) Collection of the names of the headers of this response

Since

Servlet 3.0

Gets the values of the response header with the given name.

This method considers only response headers set or added via setHeader, addHeader, setDateHeader, addDateHeader, setIntHeader, or addIntHeader, respectively.

Any changes to the returned Collection must not affect this HttpServletResponse.

Parameters

name:String

the name of the response header whose values to return

Returns:Collection<String>

a (possibly empty) Collection of the values of the response header with the given name

Since

Servlet 3.0

Gets the current status code of this response.

Returns:int

the current status code of this response

Since

Servlet 3.0

Gets the supplier of trailer headers.

Returns:Supplier<Map<String, String>>

Supplier of trailer headers

Since

Servlet 4.0

Sends an error response to the client using the specified status and clears the buffer. 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". The caller is not responsible for escaping or re-encoding the message to ensure it is safe with respect to the current response encoding and content type. This aspect of safety is the responsibility of the container, as it is generating the error page containing the message. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response.

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 and the msg parameter will be ignored.

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:int

the error status code

msg:String

the descriptive message

Exceptions

IOException:

If an input or output exception occurs

IllegalStateException:

If the response was committed

Sends an error response to the client using the specified status code and clears the buffer. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back the error page

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:int

the error status code

Exceptions

IOException:

If an input or output exception occurs

IllegalStateException:

If the response was committed before this method call

Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer. The buffer will be replaced with the data set by this method. Calling this method sets the status code to SC_FOUND 302 (Found). 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 location is relative with two leading '/' the container interprets it as a network-path reference (see RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, section 4.2 "Relative Reference").

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:String

the redirect location URL

Exceptions

IOException:

If an input or output exception occurs

IllegalStateException:

If the response was committed or if a partial URL is given and cannot be converted into a valid URL

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:String

the name of the header to set

date:long

the assigned date value

See Also

containsHeader, addDateHeader

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:String

the name of the header

value:String

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

containsHeader, addHeader

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:String

the name of the header

value:int

the assigned integer value

See Also

containsHeader, addIntHeader

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 SC_OK or SC_MOVED_TEMPORARILY status codes).

If this method is used to set an error code, then the container's error page mechanism will not be triggered. If there is an error and the caller wishes to invoke an error page defined in the web application, then sendError must be used instead.

This method preserves any cookies and other response headers.

Valid status codes are those in the 2XX, 3XX, 4XX, and 5XX ranges. Other status codes are treated as container specific.

Parameters

sc:int

the status code

See Also

sendError

Parameters

sc:int

the status code

sm:String

the status message

Annotations

@Deprecated

Sets the supplier of trailer headers.

The trailer header field value is defined as a comma-separated list (see Section 3.2.2 and Section 4.1.2 of RFC 7230).

The supplier will be called within the scope of whatever thread/call causes the response content to be completed. Typically this will be any thread calling close() on the output stream or writer.

The trailers that run afoul of the provisions of section 4.1.2 of RFC 7230 are ignored.

The RFC requires the name of every key that is to be in the supplied Map is included in the comma separated list that is the value of the "Trailer" response header. The application is responsible for ensuring this requirement is met. Failure to do so may lead to interoperability failures.

Parameters

supplier:Supplier<Map<String, String>>

the supplier of trailer headers

Exceptions

IllegalStateException:

if it is invoked after the response has has been committed, or the trailer is not supported in the request, for instance, the underlying protocol is HTTP 1.0, or the response is not in chunked encoding in HTTP 1.1.

Since

Servlet 4.0