org.eclipse.jetty.server
类 ServletResponseHttpWrapper

java.lang.Object
  javax.servlet.ServletResponseWrapper
      org.eclipse.jetty.server.ServletResponseHttpWrapper

所有已实现的接口：

HttpServletResponse, ServletResponse

public class ServletResponseHttpWrapper
extends ServletResponseWrapper
implements HttpServletResponse

Wrapper to tunnel a ServletResponse via a HttpServletResponse

字段摘要

从接口 javax.servlet.http.HttpServletResponse 继承的字段

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

构造方法摘要

ServletResponseHttpWrapper(ServletResponse response)

方法摘要

void	addCookie(Cookie cookie) Adds the specified cookie to the response.
void	addDateHeader(String name, long date) Adds a response header with the given name and date-value.
void	addHeader(String name, String value) Adds a response header with the given name and value.
void	addIntHeader(String name, int value) Adds a response header with the given name and integer value.
boolean	containsHeader(String name) Returns a boolean indicating whether the named response header has already been set.
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url) Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.
String	encodeUrl(String url)
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.
String	getHeader(String name) Gets the value of the response header with the given name.
Collection<String>	getHeaderNames() Gets the names of the headers of this response.
Collection<String>	getHeaders(String name) Gets the values of the response header with the given name.
int	getStatus() Gets the current status code of this response.
void	sendError(int sc) Sends an error response to the client using the specified status code and clears the buffer.
void	sendError(int sc, String msg) Sends an error response to the client using the specified status and clears the buffer.
void	sendRedirect(String location) Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.
void	setDateHeader(String name, long date) Sets a response header with the given name and date-value.
void	setHeader(String name, String value) Sets a response header with the given name and value.
void	setIntHeader(String name, int value) Sets a response header with the given name and integer value.
void	setStatus(int sc) Sets the status code for this response.
void	setStatus(int sc, String sm)

从类 javax.servlet.ServletResponseWrapper 继承的方法

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

从类 java.lang.Object 继承的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口 javax.servlet.ServletResponse 继承的方法

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

构造方法详细信息

ServletResponseHttpWrapper

public ServletResponseHttpWrapper(ServletResponse response)

方法详细信息

addCookie

public void addCookie(Cookie cookie)

从接口 HttpServletResponse 复制的描述

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

指定者：

接口 HttpServletResponse 中的 addCookie

参数：

cookie - the Cookie to return to the client

containsHeader

public boolean containsHeader(String name)

从接口 HttpServletResponse 复制的描述

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

指定者：

接口 HttpServletResponse 中的 containsHeader

参数：

name - the header name

返回：

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

encodeURL

public String encodeURL(String url)

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 encodeURL

参数：

url - the url to be encoded.

返回：

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

encodeRedirectURL

public String encodeRedirectURL(String url)

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 encodeRedirectURL

参数：

url - the url to be encoded.

返回：

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

另请参见：

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

encodeUrl

public String encodeUrl(String url)

指定者：

接口 HttpServletResponse 中的 encodeUrl

参数：

url - the url to be encoded.

返回：

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

encodeRedirectUrl

public String encodeRedirectUrl(String url)

指定者：

接口 HttpServletResponse 中的 encodeRedirectUrl

参数：

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

从接口 HttpServletResponse 复制的描述

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

指定者：

接口 HttpServletResponse 中的 sendError

参数：

sc - the error status code

msg - the descriptive message

抛出：

IOException - If an input or output exception occurs

sendError

public void sendError(int sc)
               throws IOException

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 sendError

参数：

sc - the error status code

抛出：

IOException - If an input or output exception occurs

sendRedirect

public void sendRedirect(String location)
                  throws IOException

从接口 HttpServletResponse 复制的描述

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

指定者：

接口 HttpServletResponse 中的 sendRedirect

参数：

location - the redirect location URL

抛出：

IOException - If an input or output exception occurs

setDateHeader

public void setDateHeader(String name,
                          long date)

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 setDateHeader

参数：

name - the name of the header to set

date - the assigned date value

另请参见：

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

addDateHeader

public void addDateHeader(String name,
                          long date)

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 addDateHeader

参数：

name - the name of the header to set

date - the additional date value

另请参见：

HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String name,
                      String value)

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 setHeader

参数：

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)

另请参见：

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

addHeader

public void addHeader(String name,
                      String value)

从接口 HttpServletResponse 复制的描述

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

指定者：

接口 HttpServletResponse 中的 addHeader

参数：

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)

另请参见：

HttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(String name,
                         int value)

从接口 HttpServletResponse 复制的描述

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.

指定者：

接口 HttpServletResponse 中的 setIntHeader

参数：

name - the name of the header

value - the assigned integer value

另请参见：

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

addIntHeader

public void addIntHeader(String name,
                         int value)

从接口 HttpServletResponse 复制的描述

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

指定者：

接口 HttpServletResponse 中的 addIntHeader

参数：

name - the name of the header

value - the assigned integer value

另请参见：

HttpServletResponse.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc)

从接口 HttpServletResponse 复制的描述

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 HttpServletResponse.sendError(int, java.lang.String) 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.

指定者：

接口 HttpServletResponse 中的 setStatus

参数：

sc - the status code

另请参见：

HttpServletResponse.sendError(int, java.lang.String)

setStatus

public void setStatus(int sc,
                      String sm)

指定者：

接口 HttpServletResponse 中的 setStatus

参数：

sc - the status code

sm - the status message

getHeader

public String getHeader(String name)

从接口 HttpServletResponse 复制的描述

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 HttpServletResponse.setHeader(java.lang.String, java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String), HttpServletResponse.setDateHeader(java.lang.String, long), HttpServletResponse.addDateHeader(java.lang.String, long), HttpServletResponse.setIntHeader(java.lang.String, int), or HttpServletResponse.addIntHeader(java.lang.String, int), respectively.

指定者：

接口 HttpServletResponse 中的 getHeader

参数：

name - the name of the response header whose value to return

返回：

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

另请参见：

HttpServletResponse.getHeader(java.lang.String)

getHeaderNames

public Collection<String> getHeaderNames()

从接口 HttpServletResponse 复制的描述

Gets the names of the headers of this response.

This method considers only response headers set or added via HttpServletResponse.setHeader(java.lang.String, java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String), HttpServletResponse.setDateHeader(java.lang.String, long), HttpServletResponse.addDateHeader(java.lang.String, long), HttpServletResponse.setIntHeader(java.lang.String, int), or HttpServletResponse.addIntHeader(java.lang.String, int), respectively.

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

指定者：

接口 HttpServletResponse 中的 getHeaderNames

返回：

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

另请参见：

HttpServletResponse.getHeaderNames()

getHeaders

public Collection<String> getHeaders(String name)

从接口 HttpServletResponse 复制的描述

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

This method considers only response headers set or added via HttpServletResponse.setHeader(java.lang.String, java.lang.String), HttpServletResponse.addHeader(java.lang.String, java.lang.String), HttpServletResponse.setDateHeader(java.lang.String, long), HttpServletResponse.addDateHeader(java.lang.String, long), HttpServletResponse.setIntHeader(java.lang.String, int), or HttpServletResponse.addIntHeader(java.lang.String, int), respectively.

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

指定者：

接口 HttpServletResponse 中的 getHeaders

参数：

name - the name of the response header whose values to return

返回：

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

另请参见：

HttpServletResponse.getHeaders(java.lang.String)

getStatus

public int getStatus()

从接口 HttpServletResponse 复制的描述

Gets the current status code of this response.

指定者：

接口 HttpServletResponse 中的 getStatus

返回：

the current status code of this response

另请参见：

HttpServletResponse.getStatus()