|
||||||||||
| 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(java.lang.String name,
long date)
Adds a response header with the given name and date-value. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Adds a response header with the given name and value. |
void |
addIntHeader(java.lang.String name,
int value)
Adds a response header with the given name and integer value. |
boolean |
containsHeader(java.lang.String name)
Returns a boolean indicating whether the named response header has already been set. |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
|
java.lang.String |
encodeRedirectURL(java.lang.String url)
Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed,
returns the URL unchanged. |
java.lang.String |
encodeUrl(java.lang.String url)
|
java.lang.String |
encodeURL(java.lang.String url)
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. |
java.lang.String |
getHeader(java.lang.String name)
Gets the value of the response header with the given name. |
java.util.Collection<java.lang.String> |
getHeaderNames()
Gets the names of the headers of this response. |
java.util.Collection<java.lang.String> |
getHeaders(java.lang.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,
java.lang.String msg)
Sends an error response to the client using the specified status and clears the buffer. |
void |
sendRedirect(java.lang.String location)
Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer. |
void |
setDateHeader(java.lang.String name,
long date)
Sets a response header with the given name and date-value. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Sets a response header with the given name and value. |
void |
setIntHeader(java.lang.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,
java.lang.String sm)
|
| 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, 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 HttpServletResponsecookie - the Cookie to return to the clientpublic boolean containsHeader(java.lang.String name)
HttpServletResponse
containsHeader in interface HttpServletResponsename - the header name
true if the named response header
has already been set;
false otherwisepublic java.lang.String encodeURL(java.lang.String url)
HttpServletResponseFor 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 HttpServletResponseurl - the url to be encoded.
public java.lang.String encodeRedirectURL(java.lang.String url)
HttpServletResponsesendRedirect 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 HttpServletResponseurl - the url to be encoded.
HttpServletResponse.sendRedirect(java.lang.String),
HttpServletResponse.encodeUrl(java.lang.String)public java.lang.String encodeUrl(java.lang.String url)
encodeUrl in interface HttpServletResponseurl - the url to be encoded.
public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl in interface HttpServletResponseurl - the url to be encoded.
public void sendError(int sc,
java.lang.String msg)
throws java.io.IOException
HttpServletResponseIf 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 HttpServletResponsesc - the error status codemsg - the descriptive message
java.io.IOException - If an input or output exception occurs
public void sendError(int sc)
throws java.io.IOException
HttpServletResponseIf 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 HttpServletResponsesc - the error status code
java.io.IOException - If an input or output exception occurs
public void sendRedirect(java.lang.String location)
throws java.io.IOException
HttpServletResponseHttpServletResponse.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.
sendRedirect in interface HttpServletResponselocation - the redirect location URL
java.io.IOException - If an input or output exception occurs
public void setDateHeader(java.lang.String name,
long date)
HttpServletResponsecontainsHeader method can be used to test for the
presence of a header before setting its value.
setDateHeader in interface HttpServletResponsename - the name of the header to setdate - the assigned date valueHttpServletResponse.containsHeader(java.lang.String),
HttpServletResponse.addDateHeader(java.lang.String, long)
public void addDateHeader(java.lang.String name,
long date)
HttpServletResponse
addDateHeader in interface HttpServletResponsename - the name of the header to setdate - the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)
public void setHeader(java.lang.String name,
java.lang.String value)
HttpServletResponsecontainsHeader method can be
used to test for the presence of a header before setting its
value.
setHeader in interface HttpServletResponsename - 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(java.lang.String name,
java.lang.String value)
HttpServletResponse
addHeader in interface HttpServletResponsename - 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(java.lang.String name,
int value)
HttpServletResponsecontainsHeader
method can be used to test for the presence of a header before
setting its value.
setIntHeader in interface HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.containsHeader(java.lang.String),
HttpServletResponse.addIntHeader(java.lang.String, int)
public void addIntHeader(java.lang.String name,
int value)
HttpServletResponse
addIntHeader in interface HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)public void setStatus(int sc)
HttpServletResponseThis 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.
setStatus in interface HttpServletResponsesc - the status codeHttpServletResponse.sendError(int, java.lang.String)
public void setStatus(int sc,
java.lang.String sm)
setStatus in interface HttpServletResponsesc - the status codesm - the status messagepublic java.lang.String getHeader(java.lang.String name)
HttpServletResponseIf 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.
getHeader in interface HttpServletResponsename - the name of the response header whose value to return
HttpServletResponse.getHeader(java.lang.String)public java.util.Collection<java.lang.String> getHeaderNames()
HttpServletResponseThis 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.
getHeaderNames in interface HttpServletResponseCollection of the names
of the headers of this responseHttpServletResponse.getHeaderNames()public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
HttpServletResponseThis 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.
getHeaders in interface HttpServletResponsename - the name of the response header whose values to return
Collection of the values
of the response header with the given nameHttpServletResponse.getHeaders(java.lang.String)public int getStatus()
HttpServletResponse
getStatus in interface HttpServletResponseHttpServletResponse.getStatus()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||