|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
public class HttpServletResponseWrapper
Wraps a servlet request in another request. Filters may use HttpServletResponseWrapper to modify the headers passed to the servlet.
The default methods just call the wrapped request methods.
Field Summary |
---|
Constructor Summary | |
---|---|
HttpServletResponseWrapper(HttpServletResponse response)
Creates a new Response wrapper |
Method Summary | |
---|---|
void |
addCookie(Cookie cookie)
Sends a new cookie to the client. |
void |
addDateHeader(java.lang.String name,
long date)
Adds a header by converting a date to a string. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Adds a header. |
void |
addIntHeader(java.lang.String name,
int value)
Adds a header by converting an integer value to a string. |
boolean |
containsHeader(java.lang.String name)
Returns true if the output headers include name |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
Deprecated. |
java.lang.String |
encodeRedirectURL(java.lang.String name)
Encodes session information in a URL suitable for sendRedirect() |
java.lang.String |
encodeUrl(java.lang.String url)
Deprecated. |
java.lang.String |
encodeURL(java.lang.String url)
Encodes session information in a URL. |
java.lang.String |
getHeader(java.lang.String name)
Retuns value of header with a given name |
java.util.Collection<java.lang.String> |
getHeaderNames()
Returns an Iterable for header names set 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. |
java.util.Collection<java.lang.String> |
getHeaders(java.lang.String name)
Returns an Iterable for header values with a given name |
int |
getStatus()
Returns the current status code of this response |
void |
sendError(int sc)
Sends an HTTP error page based on the status code |
void |
sendError(int sc,
java.lang.String msg)
Sends an HTTP error page based on the status code |
void |
sendRedirect(java.lang.String location)
Redirects the client to another page. |
void |
setDateHeader(java.lang.String name,
long date)
Sets a header by converting a date to a string. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Sets a header. |
void |
setIntHeader(java.lang.String name,
int value)
Sets a header by converting an integer value to a string. |
void |
setResponse(ServletResponse response)
Sets a response object. |
void |
setStatus(int sc)
Sets the HTTP status |
void |
setStatus(int sc,
java.lang.String msg)
|
Methods inherited from class javax.servlet.ServletResponseWrapper |
---|
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.ServletResponse |
---|
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale |
Constructor Detail |
---|
public HttpServletResponseWrapper(HttpServletResponse response)
response
- the wrapped responseMethod Detail |
---|
public void setResponse(ServletResponse response)
setResponse
in class ServletResponseWrapper
response
- the response objectpublic void setStatus(int sc)
setStatus
in interface HttpServletResponse
sc
- the HTTP status codepublic void sendError(int sc, java.lang.String msg) throws java.io.IOException
sendError
in interface HttpServletResponse
sc
- the HTTP status code
java.io.IOException
public void sendError(int sc) throws java.io.IOException
sendError
in interface HttpServletResponse
sc
- the HTTP status code
java.io.IOException
public void sendRedirect(java.lang.String location) throws java.io.IOException
sendRedirect
in interface HttpServletResponse
location
- the location to redirect to.
java.io.IOException
public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface HttpServletResponse
name
- the header namevalue
- the header valuepublic void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface HttpServletResponse
name
- the header namevalue
- the header valuepublic boolean containsHeader(java.lang.String name)
name
containsHeader
in interface HttpServletResponse
name
- the header name to testpublic void setDateHeader(java.lang.String name, long date)
To set the page to expire in 15 seconds use the following:
long now = System.currentTime();
response.setDateHeader("Expires", now + 15000);
setDateHeader
in interface HttpServletResponse
name
- name of the headerdate
- the date in milliseconds since the epoch.public void addDateHeader(java.lang.String name, long date)
addDateHeader
in interface HttpServletResponse
name
- name of the headerdate
- the date in milliseconds since the epoch.public void setIntHeader(java.lang.String name, int value)
setIntHeader
in interface HttpServletResponse
name
- name of the headervalue
- the value as an integerpublic void addIntHeader(java.lang.String name, int value)
addIntHeader
in interface HttpServletResponse
name
- name of the headervalue
- the value as an integerpublic void addCookie(Cookie cookie)
addCookie
in interface HttpServletResponse
public java.lang.String encodeURL(java.lang.String url)
encodeURL
in interface HttpServletResponse
url
- the url to encode
public java.lang.String encodeRedirectURL(java.lang.String name)
sendRedirect()
encodeRedirectURL
in interface HttpServletResponse
url
- the url to encode
public void setStatus(int sc, java.lang.String msg)
setStatus
in interface HttpServletResponse
public int getStatus()
HttpServletResponse
getStatus
in interface HttpServletResponse
public java.lang.String getHeader(java.lang.String name)
HttpServletResponse
getHeader
in interface HttpServletResponse
public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
HttpServletResponse
getHeaders
in interface HttpServletResponse
public java.util.Collection<java.lang.String> getHeaderNames()
HttpServletResponse
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.
getHeaderNames
in interface HttpServletResponse
public java.lang.String encodeUrl(java.lang.String url)
encodeUrl
in interface HttpServletResponse
public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl
in interface HttpServletResponse
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |