HttpServletResponse (Java EE 5)

servlet 容器创建 HttpServletResponse 对象，并将该对象作为参数传递给 servlet 的 service 方法（doGet、doPost，等等）。

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

See Also:

ServletResponse

英文文档：

SC_CONTINUE

static final int SC_CONTINUE

Status code (100) indicating the client can continue.

See Also:

Constant Field Values

英文文档：

SC_SWITCHING_PROTOCOLS

static final int SC_SWITCHING_PROTOCOLS

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

See Also:

Constant Field Values

英文文档：

SC_OK

static final int SC_OK

Status code (200) indicating the request succeeded normally.

See Also:

Constant Field Values

英文文档：

SC_CREATED

static final int SC_CREATED

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

See Also:

Constant Field Values

英文文档：

SC_ACCEPTED

static final int SC_ACCEPTED

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

See Also:

Constant Field Values

英文文档：

SC_NON_AUTHORITATIVE_INFORMATION

static final int SC_NON_AUTHORITATIVE_INFORMATION

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

See Also:

Constant Field Values

英文文档：

SC_NO_CONTENT

static final int SC_NO_CONTENT

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

See Also:

Constant Field Values

英文文档：

SC_RESET_CONTENT

static final int SC_RESET_CONTENT

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

See Also:

Constant Field Values

英文文档：

SC_PARTIAL_CONTENT

static final int SC_PARTIAL_CONTENT

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

See Also:

Constant Field Values

英文文档：

SC_MULTIPLE_CHOICES

static final 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.

See Also:

Constant Field Values

英文文档：

SC_MOVED_PERMANENTLY

static final 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.

See Also:

Constant Field Values

英文文档：

SC_MOVED_TEMPORARILY

static final 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. This definition is being retained for backwards compatibility. SC_FOUND is now the preferred definition.

See Also:

Constant Field Values

英文文档：

SC_FOUND

static final int SC_FOUND

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.

See Also:

Constant Field Values

英文文档：

SC_SEE_OTHER

static final int SC_SEE_OTHER

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

See Also:

Constant Field Values

英文文档：

SC_NOT_MODIFIED

static final int SC_NOT_MODIFIED

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

See Also:

Constant Field Values

英文文档：

SC_USE_PROXY

static final int SC_USE_PROXY

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

See Also:

Constant Field Values

英文文档：

SC_TEMPORARY_REDIRECT

static final int SC_TEMPORARY_REDIRECT

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.

See Also:

Constant Field Values

英文文档：

SC_BAD_REQUEST

static final int SC_BAD_REQUEST

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

See Also:

Constant Field Values

英文文档：

SC_UNAUTHORIZED

static final int SC_UNAUTHORIZED

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

See Also:

Constant Field Values

英文文档：

SC_PAYMENT_REQUIRED

static final int SC_PAYMENT_REQUIRED

Status code (402) reserved for future use.

See Also:

Constant Field Values

英文文档：

SC_FORBIDDEN

static final int SC_FORBIDDEN

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

See Also:

Constant Field Values

英文文档：

SC_NOT_FOUND

static final int SC_NOT_FOUND

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

See Also:

Constant Field Values

英文文档：

SC_METHOD_NOT_ALLOWED

static final 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.

See Also:

Constant Field Values

英文文档：

SC_NOT_ACCEPTABLE

static final 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.

See Also:

Constant Field Values

英文文档：

SC_PROXY_AUTHENTICATION_REQUIRED

static final int SC_PROXY_AUTHENTICATION_REQUIRED

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

See Also:

Constant Field Values

英文文档：

SC_REQUEST_TIMEOUT

static final 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.

See Also:

Constant Field Values

英文文档：

SC_CONFLICT

static final 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.

See Also:

Constant Field Values

英文文档：

SC_GONE

static final int SC_GONE

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.

See Also:

Constant Field Values

英文文档：

SC_LENGTH_REQUIRED

static final int SC_LENGTH_REQUIRED

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

See Also:

Constant Field Values

英文文档：

SC_PRECONDITION_FAILED

static final 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.

See Also:

Constant Field Values

英文文档：

SC_REQUEST_ENTITY_TOO_LARGE

static final 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.

See Also:

Constant Field Values

英文文档：

SC_REQUEST_URI_TOO_LONG

static final 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.

See Also:

Constant Field Values

英文文档：

SC_UNSUPPORTED_MEDIA_TYPE

static final 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.

See Also:

Constant Field Values

英文文档：

SC_REQUESTED_RANGE_NOT_SATISFIABLE

static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE

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

See Also:

Constant Field Values

英文文档：

SC_EXPECTATION_FAILED

static final int SC_EXPECTATION_FAILED

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

See Also:

Constant Field Values

英文文档：

SC_INTERNAL_SERVER_ERROR

static final int SC_INTERNAL_SERVER_ERROR

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

See Also:

Constant Field Values

英文文档：

SC_NOT_IMPLEMENTED

static final int SC_NOT_IMPLEMENTED

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

See Also:

Constant Field Values

英文文档：

SC_BAD_GATEWAY

static final 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.

See Also:

Constant Field Values

英文文档：

SC_SERVICE_UNAVAILABLE

static final int SC_SERVICE_UNAVAILABLE

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

See Also:

Constant Field Values

英文文档：

SC_GATEWAY_TIMEOUT

static final 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.

See Also:

Constant Field Values

英文文档：

SC_HTTP_VERSION_NOT_SUPPORTED

static final 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.

See Also:

Constant Field Values

public void addCookie(Cookie cookie)
将指定 cookie 添加到响应。可多次调用此方法设置一个以上的 cookie。

cookie

要返回给客户端的 Cookie

英文文档：

addCookie

void addCookie(Cookie cookie)

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

public boolean containsHeader(String name)
返回一个 boolean 值，指示是否已经设置指定的响应头。

name	头名称
return	如果已经设置指定的响应头，则返回 true；否则返回 false

英文文档：

containsHeader

boolean containsHeader(String name)

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

Parameters:

name - the header name

Returns:

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

public String encodeURL(String url)
通过将会话 ID 包含在指定 URL 中对该 URL 进行编码，如果不需要编码，则返回未更改的 URL。此方法的实现包含可以确定会话 ID 是否需要在 URL 中编码的逻辑。例如，如果浏览器支持 cookie，或者关闭了会话跟踪，则 URL 编码就不是必需的。

对于健壮的会话跟踪，servlet 发出的所有 URL 都应该通过此方法运行。否则，URL 重写不能用于不支持 cookie 的浏览器。

url	要编码的 URL。
return	如果需要编码，则返回编码的 URL；否则返回未更改的 URL。

英文文档：

encodeURL

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.

Parameters:

url - the url to be encoded.

Returns:

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

public String encodeRedirectURL(String url)
对指定 URL 进行编码，以便在 sendRedirect 方法中使用它，如果不需要编码，则返回未更改的 URL。此方法的实现包含可以确定会话 ID 是否需要在 URL 中编码的逻辑。因为进行此确定的规则可能不同于用来确定是否对普通链接进行编码的规则，所以此方法与 encodeURL 方法是分开的。

发送到 HttpServletResponse.sendRedirect 方法的所有 URL 都应该通过此方法运行。否则，URL 重写不能用于不支持 cookie 的浏览器。

url	要编码的 URL。
return	如果需要编码，则返回编码的 URL；否则返回未更改的 URL。
See also	sendRedirect, encodeUrl

英文文档：

encodeRedirectURL

String encodeRedirectURL(String url)

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.

Returns:

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

See Also:

sendRedirect(java.lang.String), encodeUrl(java.lang.String)

public String encodeUrl(String url)

deprecated	从版本 2.1 起，请改用 encodeURL(String url)
url	要编码的 URL。
return	如果需要编码，则返回编码的 URL；否则返回未更改的 URL。

英文文档：

encodeUrl

String encodeUrl(String url)

Deprecated. As of version 2.1, use encodeURL(String url) instead

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	从版本 2.1 起，请改用 encodeRedirectURL(String url)
url	要编码的 URL。
return	如果需要编码，则返回编码的 URL；否则返回未更改的 URL。

英文文档：

encodeRedirectUrl

String encodeRedirectUrl(String url)

Deprecated. As of version 2.1, use encodeRedirectURL(String url) instead

Parameters:

url - the url to be encoded.

Returns:

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

public void sendError(int sc, String msg) throws java.io.IOException
使用指定状态将错误响应发送到客户端。默认情况下，服务器将创建类似 HTML 格式的服务器错误页面的响应，该页面包含指定消息，内容类型设置为 "text/html"，并且保持 cookie 和其他头不变。 如果已经对 Web 应用程序进行了对应于传入状态代码的错误页面声明，则将优先处理建议的 msg 参数。

如果已经提交了响应，则此方法抛出 IllegalStateException。使用此方法后，响应应该被视为已经被提交，不能再写入。

sc	错误状态代码
msg	描述性消息
Throws	java.io.IOException: 如果发生输入或输出异常
Throws	IllegalStateException: 如果提交了响应

英文文档：

sendError

void sendError(int sc,
               String msg)
               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.

Parameters:

sc - the error status code

msg - the descriptive message

Throws:

IOException - If an input or output exception occurs

IllegalStateException - If the response was committed

public void sendError(int sc) throws java.io.IOException
使用指定状态代码并清除缓冲区将错误响应发送到客户端。

如果已经提交了响应，则此方法抛出 IllegalStateException。使用此方法后，响应应该被视为已经被提交，不能再写入。

sc	错误状态代码
Throws	java.io.IOException: 如果发生输入或输出异常
Throws	IllegalStateException: 如果在此方法调用之前提交了响应

英文文档：

sendError

void sendError(int sc)
               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.

Parameters:

sc - the error status code

Throws:

IOException - If an input or output exception occurs

IllegalStateException - If the response was committed before this method call

public void sendRedirect(String location) throws java.io.IOException
使用指定重定向位置 URL 将临时重定向响应发送到客户端。此方法可以接受相对 URL；servlet 容器必须在将响应发送到客户端之前将相对 URL 转换为绝对 URL。如果位置是相对的，没有前导 '/'，则容器将相对于当前请求 URI 对其进行解释。如果位置是相对的，有一个前导 '/'，则容器将相对于 servlet 容器根对其进行解释。

如果已经提交了响应，则此方法抛出 IllegalStateException。使用此方法后，响应应该被视为已经被提交，不能再写入。

location	重定向位置 URL
Throws	java.io.IOException: 如果发生输入或输出异常
Throws	IllegalStateException: 如果提交了响应，或者部分 URL 是给定的且无法将其转换为有效 URL

英文文档：

sendRedirect

void sendRedirect(String location)
                  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.

Parameters:

location - the redirect location URL

Throws:

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

public void setDateHeader(String name, long date)
用给定名称和日期值设置响应头。该日期根据距历元时间的毫秒数指定。如果已经设置了头，则新值将重写以前的值。containsHeader 方法可用于测试在设置其值之前头是否存在。

name	要设置的头的名称
date	指定的日期值
See also	containsHeader, addDateHeader

英文文档：

setDateHeader

void setDateHeader(String name,
                   long date)

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

date - the assigned date value

See Also:

containsHeader(java.lang.String), addDateHeader(java.lang.String, long)

public void addDateHeader(String name, long date)
用给定名称和日期值添加响应头。该日期根据距历元时间的毫秒数指定。此方法允许响应头有多个值。

name	要设置的头的名称
date	附加的日期值
See also	setDateHeader

英文文档：

addDateHeader

void addDateHeader(String name,
                   long date)

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

date - the additional date value

See Also:

setDateHeader(java.lang.String, long)

public void setHeader(String name, String value)
用给定名称和值设置响应头。如果已经设置了头，则新值将重写以前的值。containsHeader 方法可用于测试在设置其值之前头是否存在。

name	头的名称
value	头值，如果该值包含八位字节字符串，则应该根据 RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) 对其进行编码
See also	containsHeader, addHeader

英文文档：

setHeader

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

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:

containsHeader(java.lang.String), addHeader(java.lang.String, java.lang.String)

public void addHeader(String name, String value)
用给定名称和值添加响应头。此方法允许响应头有多个值。

name	头的名称
value	附加的头值，如果该值包含八位字节字符串，则应该根据 RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) 对其进行编码
See also	setHeader

英文文档：

addHeader

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.

Parameters:

name - the name of the header

value - 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(java.lang.String, java.lang.String)

public void setIntHeader(String name, int value)
用给定名称和整数值设置响应头。如果已经设置了头，则新值将重写以前的值。containsHeader 方法可用于测试在设置其值之前头是否存在。

name	头的名称
value	指定的整数值
See also	containsHeader, addIntHeader

英文文档：

setIntHeader

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

value - the assigned integer value

See Also:

containsHeader(java.lang.String), addIntHeader(java.lang.String, int)

public void addIntHeader(String name, int value)
用给定名称和整数值添加响应头。此方法允许响应头有多个值。

name	头的名称
value	指定的整数值
See also	setIntHeader

英文文档：

addIntHeader

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.

Parameters:

name - the name of the header

value - the assigned integer value

See Also:

setIntHeader(java.lang.String, int)

public void setStatus(int sc)
设置此响应的状态代码。此方法用于设置没有错误时的返回状态代码（例如状态代码 SC_OK 或 SC_MOVED_TEMPORARILY）。如果有错误，并且调用者希望调用 Web 应用程序中定义的错误页面，则应改用 sendError 方法。

容器清除缓冲区，设置 Location 头，并保留 cookie 和其他头。

sc	状态代码
See also	sendError

英文文档：

setStatus

void setStatus(int sc)

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:

sendError(int, java.lang.String)

public void setStatus(int sc, String sm)

deprecated	从版本 2.1 起，由于消息参数的含义不明确。使用 setStatus(int) 设置状态代码，使用 sendError(int, String) 发送带描述的错误。 设置此响应的状态代码和消息。
sc	状态代码
sm	状态消息

英文文档：

setStatus

void setStatus(int sc,
               String sm)

Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.

Parameters:

sc - the status code

sm - the status message

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.