public class ServletResponseAdapter extends java.lang.Object implements HttpResponse
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
Constructor and Description |
---|
ServletResponseAdapter(HttpServletResponse response) |
Modifier and Type | Method and Description |
---|---|
void |
addCookie(Cookie cookie)
Adds the specified cookie to the response.
|
void |
addDateHeader(java.lang.String s,
long l)
Adds a response header with the given name and
date-value.
|
void |
addHeader(java.lang.String s,
java.lang.String s1)
Adds a response header with the given name and value.
|
void |
addIntHeader(java.lang.String s,
int i)
Adds a response header with the given name and
integer value.
|
boolean |
containsHeader(java.lang.String s)
Returns a boolean indicating whether the named response header
has already been set.
|
java.lang.String |
encodeRedirectUrl(java.lang.String s) |
java.lang.String |
encodeRedirectURL(java.lang.String s)
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 s) |
java.lang.String |
encodeURL(java.lang.String s)
Encodes the specified URL by including the session ID,
or, if encoding is not needed, returns the URL unchanged.
|
void |
flushBuffer()
Flushes the output buffer to the client.
|
int |
getBufferSize()
Returns the actual buffer size used for the response.
|
java.lang.String |
getCharacterEncoding()
Returns the name of the character encoding (MIME charset)
used for the body sent in this response.
|
java.lang.String |
getContentType()
Gets the content type that will be sent to the browser.
|
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 s)
Gets the values of the response header with the given name.
|
java.util.Locale |
getLocale()
Returns the locale specified for this response
using the
ServletResponse.setLocale(java.util.Locale) method. |
ServletOutputStream |
getOutputStream()
Returns a
ServletOutputStream suitable for writing binary
data in the response. |
int |
getStatus()
Gets the current status code of this response.
|
java.io.PrintWriter |
getWriter()
Returns a
PrintWriter object that
can send character text to the client. |
boolean |
isCommitted()
Returns a boolean indicating if the response has been
committed.
|
void |
reset()
Clears any data that exists in the buffer as well as the status code,
headers.
|
void |
resetBuffer()
Clears the content of the underlying buffer in the response without
clearing headers or status code.
|
void |
sendError(int i)
Sends an error response to the client using the specified status
code and clears the buffer.
|
void |
sendError(int i,
java.lang.String s)
Sends an error response to the client using the specified
status and clears the buffer.
|
void |
sendRedirect(java.lang.String s)
Sends a temporary redirect response to the client using the
specified redirect location URL and clears the buffer.
|
void |
setBufferSize(int i)
Sets the preferred buffer size for the body of the response.
|
void |
setCharacterEncoding(java.lang.String s)
Sets the character encoding (MIME charset) of the response
being sent to the client, for example, to UTF-8.
|
void |
setContentLength(int i)
Sets the length of the content body in the response
In HTTP servlets, this method sets the HTTP Content-Length header.
|
void |
setContentLengthLong(long length)
Sets the length of the content body in the response
In HTTP servlets, this method sets the HTTP Content-Length header.
|
void |
setContentType(java.lang.String type)
Sets the content type to be sent back to the browser.
|
void |
setDateHeader(java.lang.String s,
long l)
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 s,
int i)
Sets a response header with the given name and
integer value.
|
void |
setLocale(java.util.Locale locale)
Sets the locale of the response, if the response has not been
committed yet.
|
void |
setStatus(int i)
Sets the status code for this response.
|
void |
setStatus(int i,
java.lang.String s) |
void |
setStatusMessage(java.lang.String responseString)
Sets the response string to be sent to the browser
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getTrailerFields, setTrailerFields
public ServletResponseAdapter(HttpServletResponse response)
public void setHeader(java.lang.String name, java.lang.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 setIntHeader(java.lang.String s, int i)
HttpServletResponse
containsHeader
method can be used to test for the presence of a header before
setting its value.setIntHeader
in interface HttpServletResponse
s
- the name of the headeri
- the assigned integer valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addIntHeader(java.lang.String, int)
public void setStatus(int i)
HttpServletResponse
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.
setStatus
in interface HttpServletResponse
i
- the status codeHttpServletResponse.sendError(int, java.lang.String)
public void setStatus(int i, java.lang.String s)
setStatus
in interface HttpServletResponse
i
- the status codes
- the status messagepublic void addCookie(Cookie cookie)
HttpServletResponse
addCookie
in interface HttpServletResponse
cookie
- the Cookie to return to the clientpublic void addDateHeader(java.lang.String s, long l)
HttpServletResponse
addDateHeader
in interface HttpServletResponse
s
- the name of the header to setl
- the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)
public void addHeader(java.lang.String s, java.lang.String s1)
HttpServletResponse
addHeader
in interface HttpServletResponse
s
- the name of the headers1
- 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 addIntHeader(java.lang.String s, int i)
HttpServletResponse
addIntHeader
in interface HttpServletResponse
s
- the name of the headeri
- the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)
public boolean containsHeader(java.lang.String s)
HttpServletResponse
containsHeader
in interface HttpServletResponse
s
- the header nametrue
if the named response header
has already been set;
false
otherwisepublic java.lang.String encodeURL(java.lang.String s)
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.
If the URL is relative, it is always relative to the current HttpServletRequest.
encodeURL
in interface HttpServletResponse
s
- the url to be encoded.public java.lang.String encodeRedirectURL(java.lang.String s)
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. For example, if the browser supports
cookies, or session tracking is turned off, URL encoding is
unnecessary. 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.
If the URL is relative, it is always relative to the current HttpServletRequest.
encodeRedirectURL
in interface HttpServletResponse
s
- the url to be encoded.HttpServletResponse.sendRedirect(java.lang.String)
,
HttpServletResponse.encodeUrl(java.lang.String)
public java.lang.String encodeUrl(java.lang.String s)
encodeUrl
in interface HttpServletResponse
s
- the url to be encoded.public java.lang.String encodeRedirectUrl(java.lang.String s)
encodeRedirectUrl
in interface HttpServletResponse
s
- the url to be encoded.public java.lang.String getHeader(java.lang.String name)
HttpServletResponse
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.
getHeader
in interface HttpServletResponse
name
- the name of the response header whose value to returnpublic java.util.Collection<java.lang.String> getHeaderNames()
HttpServletResponse
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
.
getHeaderNames
in interface HttpServletResponse
Collection
of the names
of the headers of this responsepublic java.util.Collection<java.lang.String> getHeaders(java.lang.String s)
HttpServletResponse
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
.
getHeaders
in interface HttpServletResponse
s
- the name of the response header whose values to returnCollection
of the values
of the response header with the given namepublic int getStatus()
HttpServletResponse
getStatus
in interface HttpServletResponse
public void sendError(int i) throws java.io.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
i
- the error status codejava.io.IOException
- If an input or output exception occurspublic void sendError(int i, java.lang.String s) throws java.io.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 caller is not responsible for escaping or re-encoding the message to ensure it is safe with respect to the current response encoding and content type. This aspect of safety is the responsibility of the container, as it is generating the error page containing the message. 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.
sendError
in interface HttpServletResponse
i
- the error status codes
- the descriptive messagejava.io.IOException
- If an input or output exception occurspublic void sendRedirect(java.lang.String s) throws java.io.IOException
HttpServletResponse
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 location is relative with two leading '/' the container interprets
it as a network-path reference (see
RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, section 4.2
"Relative Reference").
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
s
- the redirect location URLjava.io.IOException
- If an input or output exception occurspublic void setDateHeader(java.lang.String s, long l)
HttpServletResponse
containsHeader
method can be used to test for the
presence of a header before setting its value.setDateHeader
in interface HttpServletResponse
s
- the name of the header to setl
- the assigned date valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addDateHeader(java.lang.String, long)
public ServletOutputStream getOutputStream()
ServletResponse
ServletOutputStream
suitable for writing binary
data in the response. The servlet container does not encode the
binary data.
Calling flush() on the ServletOutputStream commits the response.
Either this method or ServletResponse.getWriter()
may
be called to write the body, not both, except when ServletResponse.reset()
has been called.
getOutputStream
in interface ServletResponse
ServletOutputStream
for writing binary dataServletResponse.getWriter()
,
ServletResponse.reset()
public java.io.PrintWriter getWriter() throws java.io.IOException
ServletResponse
PrintWriter
object that
can send character text to the client.
The PrintWriter
uses the character
encoding returned by ServletResponse.getCharacterEncoding()
.
If the response's character encoding has not been
specified as described in getCharacterEncoding
(i.e., the method just returns the default value
ISO-8859-1
), getWriter
updates it to ISO-8859-1
.
Calling flush() on the PrintWriter
commits the response.
Either this method or ServletResponse.getOutputStream()
may be called
to write the body, not both, except when ServletResponse.reset()
has been called.
getWriter
in interface ServletResponse
PrintWriter
object that
can return character data to the clientjava.io.UnsupportedEncodingException
- if the character encoding returned
by getCharacterEncoding
cannot be usedjava.io.IOException
- if an input or output exception occurredServletResponse.getOutputStream()
,
ServletResponse.setCharacterEncoding(java.lang.String)
,
ServletResponse.reset()
public boolean isCommitted()
ServletResponse
isCommitted
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.flushBuffer()
,
ServletResponse.reset()
public void reset()
ServletResponse
ServletResponse.getWriter()
or
ServletResponse.getOutputStream()
is also cleared. It is legal, for instance,
to call ServletResponse.getWriter()
, ServletResponse.reset()
and then
ServletResponse.getOutputStream()
. If ServletResponse.getWriter()
or
ServletResponse.getOutputStream()
have been called before this method,
then the corrresponding returned Writer or OutputStream will be
staled and the behavior of using the stale object is undefined.
If the response has been committed, this method throws an
IllegalStateException
.reset
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.flushBuffer()
,
ServletResponse.isCommitted()
public void resetBuffer()
ServletResponse
IllegalStateException
.resetBuffer
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public void setBufferSize(int i)
ServletResponse
getBufferSize
.
A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.
This method must be called before any response body content is
written; if content has been written or the response object has
been committed, this method throws an
IllegalStateException
.
setBufferSize
in interface ServletResponse
i
- the preferred buffer sizeServletResponse.getBufferSize()
,
ServletResponse.flushBuffer()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public void setCharacterEncoding(java.lang.String s)
ServletResponse
ServletContext.setResponseCharacterEncoding(java.lang.String)
,
deployment descriptor, or using the setContentType() or setLocale()
methods, the value set in this method overrides any of those values.
Calling ServletResponse.setContentType(java.lang.String)
with the String
of text/html
and calling
this method with the String
of UTF-8
is equivalent with calling
setContentType
with the String
of
text/html; charset=UTF-8
.
This method can be called repeatedly to change the character
encoding.
This method has no effect if it is called after
getWriter
has been
called or after the response has been committed.
Containers must communicate the character encoding used for
the servlet response's writer to the client if the protocol
provides a way for doing so. In the case of HTTP, the character
encoding is communicated as part of the Content-Type
header for text media types. Note that the character encoding
cannot be communicated via HTTP headers if the servlet does not
specify a content type; however, it is still used to encode text
written via the servlet response's writer.
setCharacterEncoding
in interface ServletResponse
s
- a String specifying only the character set
defined by IANA Character Sets
(http://www.iana.org/assignments/character-sets)ServletResponse.setContentType(java.lang.String)
,
ServletResponse.setLocale(java.util.Locale)
public void setContentLength(int i)
ServletResponse
setContentLength
in interface ServletResponse
i
- an integer specifying the length of the
content being returned to the client; sets the Content-Length headerpublic void setContentLengthLong(long length)
ServletResponse
setContentLengthLong
in interface ServletResponse
length
- a long specifying the length of the
content being returned to the client; sets the Content-Length headerpublic void setContentType(java.lang.String type)
HttpResponse
setContentType
in interface ServletResponse
setContentType
in interface HttpResponse
type
- the type to be sent to the browser (i.e. "text/html")ServletResponse.setLocale(java.util.Locale)
,
ServletResponse.setCharacterEncoding(java.lang.String)
,
ServletResponse.getOutputStream()
,
ServletResponse.getWriter()
public void setLocale(java.util.Locale locale)
ServletResponse
ServletResponse.setContentType(java.lang.String)
or
ServletResponse.setCharacterEncoding(java.lang.String)
, getWriter
hasn't
been called yet, and the response hasn't been committed yet.
If the deployment descriptor contains a
locale-encoding-mapping-list
element, and that
element provides a mapping for the given locale, that mapping
is used. Otherwise, the mapping from locale to character
encoding is container dependent.
This method may be called repeatedly to change locale and
character encoding. The method has no effect if called after the
response has been committed. It does not set the response's
character encoding if it is called after ServletResponse.setContentType(java.lang.String)
has been called with a charset specification, after
ServletResponse.setCharacterEncoding(java.lang.String)
has been called, after
getWriter
has been called, or after the response
has been committed.
Containers must communicate the locale and the character encoding
used for the servlet response's writer to the client if the protocol
provides a way for doing so. In the case of HTTP, the locale is
communicated via the Content-Language
header,
the character encoding as part of the Content-Type
header for text media types. Note that the character encoding
cannot be communicated via HTTP headers if the servlet does not
specify a content type; however, it is still used to encode text
written via the servlet response's writer.
setLocale
in interface ServletResponse
locale
- the locale of the responseServletResponse.getLocale()
,
ServletResponse.setContentType(java.lang.String)
,
ServletResponse.setCharacterEncoding(java.lang.String)
public java.lang.String getContentType()
HttpResponse
getContentType
in interface ServletResponse
getContentType
in interface HttpResponse
public java.util.Locale getLocale()
ServletResponse
ServletResponse.setLocale(java.util.Locale)
method. Calls made to
setLocale
after the response is committed
have no effect. If no locale has been specified,
the container's default locale is returned.getLocale
in interface ServletResponse
ServletResponse.setLocale(java.util.Locale)
public void setStatusMessage(java.lang.String responseString)
HttpResponse
setStatusMessage
in interface HttpResponse
responseString
- the response stringpublic void flushBuffer() throws java.io.IOException
HttpResponse
flushBuffer
in interface ServletResponse
flushBuffer
in interface HttpResponse
java.io.IOException
- if the act of flushing the buffer cannot be
completed.ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public int getBufferSize()
ServletResponse
getBufferSize
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.flushBuffer()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public java.lang.String getCharacterEncoding()
ServletResponse
ServletContext.setResponseCharacterEncoding(java.lang.String)
, deployment
descriptor), and per container (for all web applications deployed in
that container, using vendor specific configuration).
The first one of these methods that yields a result is returned.
Per-request, the charset for the response can be specified explicitly
using the setCharacterEncoding
and setContentType
methods, or implicitly using the setLocale(java.util.Locale) method.
Explicit specifications take precedence over implicit specifications.
Calls made to these methods after getWriter
has been
called or after the response has been committed have no
effect on the character encoding. If no character encoding
has been specified, ISO-8859-1
is returned.
See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
getCharacterEncoding
in interface ServletResponse
String
specifying the name of
the character encoding, for example, UTF-8