|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletResponseWrapper
org.eclipse.jetty.server.ServletResponseHttpWrapper
public class ServletResponseHttpWrapper
Wrapper to tunnel a ServletResponse via a HttpServletResponse
Field Summary |
---|
Constructor Summary | |
---|---|
ServletResponseHttpWrapper(ServletResponse response)
|
Method Summary | |
---|---|
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. |
void |
sendError(int sc)
Sends an error response to the client using the specified status code and clearing the buffer. |
void |
sendError(int sc,
String msg)
Sends an error response to the client using the specified status. |
void |
sendRedirect(String location)
Sends a temporary redirect response to the client using the specified redirect location URL. |
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)
|
Methods inherited from class javax.servlet.ServletResponseWrapper |
---|
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse |
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 ServletResponseHttpWrapper(ServletResponse response)
Method Detail |
---|
public void addCookie(Cookie cookie)
HttpServletResponse
addCookie
in interface HttpServletResponse
cookie
- the Cookie to return to the clientpublic boolean containsHeader(String name)
HttpServletResponse
containsHeader
in interface HttpServletResponse
name
- the header name
true
if the named response header
has already been set;
false
otherwisepublic String encodeURL(String url)
HttpServletResponse
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.
encodeURL
in interface HttpServletResponse
url
- the url to be encoded.
public String encodeRedirectURL(String url)
HttpServletResponse
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.
encodeRedirectURL
in interface HttpServletResponse
url
- the url to be encoded.
HttpServletResponse.sendRedirect(java.lang.String)
,
HttpServletResponse.encodeUrl(java.lang.String)
public String encodeUrl(String url)
encodeUrl
in interface HttpServletResponse
url
- the url to be encoded.
public String encodeRedirectUrl(String url)
encodeRedirectUrl
in interface HttpServletResponse
url
- the url to be encoded.
public void sendError(int sc, String msg) throws IOException
HttpServletResponse
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.
sendError
in interface HttpServletResponse
sc
- the error status codemsg
- the descriptive message
IOException
- If an input or output exception occurspublic void sendError(int sc) throws IOException
HttpServletResponse
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.
sendError
in interface HttpServletResponse
sc
- the error status code
IOException
- If an input or output exception occurspublic void sendRedirect(String location) throws IOException
HttpServletResponse
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.
sendRedirect
in interface HttpServletResponse
location
- the redirect location URL
IOException
- If an input or output exception occurspublic void setDateHeader(String name, long date)
HttpServletResponse
containsHeader
method can be used to test for the
presence of a header before setting its value.
setDateHeader
in interface HttpServletResponse
name
- the name of the header to setdate
- the assigned date valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addDateHeader(java.lang.String, long)
public void addDateHeader(String name, long date)
HttpServletResponse
addDateHeader
in interface HttpServletResponse
name
- the name of the header to setdate
- the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)
public void setHeader(String name, String value)
HttpServletResponse
containsHeader
method can be
used to test for the presence of a header before setting its
value.
setHeader
in interface HttpServletResponse
name
- the name of the headervalue
- 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)
public void addHeader(String name, String value)
HttpServletResponse
addHeader
in interface HttpServletResponse
name
- the name of the headervalue
- 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)
public void setIntHeader(String name, int value)
HttpServletResponse
containsHeader
method can be used to test for the presence of a header before
setting its value.
setIntHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the assigned integer valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addIntHeader(java.lang.String, int)
public void addIntHeader(String name, int value)
HttpServletResponse
addIntHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)
public void setStatus(int sc)
HttpServletResponse
sendError
method should be used
instead.
The container clears the buffer and sets the Location header, preserving cookies and other headers.
setStatus
in interface HttpServletResponse
sc
- the status codeHttpServletResponse.sendError(int, java.lang.String)
public void setStatus(int sc, String sm)
setStatus
in interface HttpServletResponse
sc
- the status codesm
- the status message
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |