org.apache.catalina.core
public class DummyResponse extends java.lang.Object implements 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| Constructor and Description |
|---|
DummyResponse() |
| Modifier and Type | Method and Description |
|---|---|
void |
addCookie(javax.servlet.http.Cookie cookie)
Adds the specified cookie to the response.
|
void |
addDateHeader(java.lang.String name,
long value)
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.
|
javax.servlet.ServletOutputStream |
createOutputStream() |
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.
|
void |
finishResponse() |
void |
flushBuffer()
Forces any content in the buffer to be written 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.
|
Connector |
getConnector() |
int |
getContentCount() |
int |
getContentLength() |
java.lang.String |
getContentType()
Returns the content type used for the MIME body
sent in this response.
|
Context |
getContext() |
javax.servlet.http.Cookie[] |
getCookies() |
java.lang.String |
getHeader(java.lang.String name) |
java.lang.String[] |
getHeaderNames() |
java.lang.String[] |
getHeaderValues(java.lang.String name) |
boolean |
getIncluded() |
java.lang.String |
getInfo() |
java.util.Locale |
getLocale()
Returns the locale specified for this response
using the
ServletResponse.setLocale(java.util.Locale) method. |
java.lang.String |
getMessage() |
javax.servlet.ServletOutputStream |
getOutputStream()
Returns a
ServletOutputStream suitable for writing binary
data in the response. |
java.io.PrintWriter |
getReporter() |
Request |
getRequest() |
javax.servlet.ServletResponse |
getResponse() |
int |
getStatus() |
java.io.OutputStream |
getStream() |
java.io.PrintWriter |
getWriter()
Returns a
PrintWriter object that
can send character text to the client. |
boolean |
isAppCommitted() |
boolean |
isCommitted()
Returns a boolean indicating if the response has been
committed.
|
boolean |
isError() |
boolean |
isSuspended() |
void |
recycle() |
void |
reset()
Clears any data that exists in the buffer as well as the status code and
headers.
|
void |
reset(int status,
java.lang.String message) |
void |
resetBuffer()
Clears the content of the underlying buffer in the response without
clearing headers or status code.
|
void |
sendAcknowledgement() |
void |
sendError(int status)
Sends an error response to the client using the specified status
code and clearing the buffer.
|
void |
sendError(int status,
java.lang.String message)
Sends an error response to the client using the specified
status.
|
void |
sendRedirect(java.lang.String location)
Sends a temporary redirect response to the client using the
specified redirect location URL.
|
void |
setAppCommitted(boolean appCommitted) |
void |
setBufferSize(int size)
Sets the preferred buffer size for the body of the response.
|
void |
setCharacterEncoding(java.lang.String charEncoding)
Sets the character encoding (MIME charset) of the response
being sent to the client, for example, to UTF-8.
|
void |
setConnector(Connector connector) |
void |
setContentLength(int 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 of the response being sent to
the client, if the response has not been committed yet.
|
void |
setContext(Context context) |
void |
setDateHeader(java.lang.String name,
long value)
Sets a response header with the given name and
date-value.
|
void |
setError() |
void |
setHeader(java.lang.String name,
java.lang.String value)
Sets a response header with the given name and value.
|
void |
setIncluded(boolean included) |
void |
setIntHeader(java.lang.String name,
int value)
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 |
setRequest(Request request) |
void |
setStatus(int status)
Sets the status code for this response.
|
void |
setStatus(int status,
java.lang.String message) |
void |
setStream(java.io.OutputStream stream) |
void |
setSuspended(boolean suspended) |
void |
write(byte[] b) |
void |
write(byte[] b,
int off,
int len) |
void |
write(int b) |
public void setAppCommitted(boolean appCommitted)
public boolean isAppCommitted()
public Connector getConnector()
public void setConnector(Connector connector)
public int getContentCount()
public Context getContext()
public void setContext(Context context)
public boolean getIncluded()
public void setIncluded(boolean included)
public java.lang.String getInfo()
public Request getRequest()
public void setRequest(Request request)
public javax.servlet.ServletResponse getResponse()
public java.io.OutputStream getStream()
public void setStream(java.io.OutputStream stream)
public void setSuspended(boolean suspended)
public boolean isSuspended()
public void setError()
public boolean isError()
public javax.servlet.ServletOutputStream createOutputStream()
throws java.io.IOException
java.io.IOExceptionpublic void finishResponse()
throws java.io.IOException
java.io.IOExceptionpublic int getContentLength()
public java.lang.String getContentType()
javax.servlet.ServletResponseServletResponse.setContentType(java.lang.String)
before the response is committed. If no content type
has been specified, this method returns null.
If a content type has been specified and a
character encoding has been explicitly or implicitly
specified as described in ServletResponse.getCharacterEncoding(),
the charset parameter is included in the string returned.
If no character encoding has been specified, the
charset parameter is omitted.getContentType in interface javax.servlet.ServletResponseString specifying the
content type, for example,
text/html; charset=UTF-8,
or nullpublic java.io.PrintWriter getReporter()
public void recycle()
public void write(int b)
throws java.io.IOException
java.io.IOExceptionpublic void write(byte[] b)
throws java.io.IOException
java.io.IOExceptionpublic void write(byte[] b,
int off,
int len)
throws java.io.IOException
java.io.IOExceptionpublic void flushBuffer()
throws java.io.IOException
javax.servlet.ServletResponseflushBuffer in interface javax.servlet.ServletResponsejava.io.IOExceptionServletResponse.setBufferSize(int),
ServletResponse.getBufferSize(),
ServletResponse.isCommitted(),
ServletResponse.reset()public int getBufferSize()
javax.servlet.ServletResponsegetBufferSize in interface javax.servlet.ServletResponseServletResponse.setBufferSize(int),
ServletResponse.flushBuffer(),
ServletResponse.isCommitted(),
ServletResponse.reset()public java.lang.String getCharacterEncoding()
javax.servlet.ServletResponseServletResponse.setCharacterEncoding(java.lang.String) or
ServletResponse.setContentType(java.lang.String) methods, or implicitly using the
ServletResponse.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 javax.servlet.ServletResponseString specifying the
name of the character encoding, for
example, UTF-8public void setCharacterEncoding(java.lang.String charEncoding)
javax.servlet.ServletResponseServletResponse.setContentType(java.lang.String) or ServletResponse.setLocale(java.util.Locale),
this method overrides it.
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 javax.servlet.ServletResponsecharEncoding - a String specifying only the character set
defined by IANA Character Sets
(http://www.iana.org/assignments/character-sets)#setLocalepublic javax.servlet.ServletOutputStream getOutputStream()
throws java.io.IOException
javax.servlet.ServletResponseServletOutputStream 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.
getOutputStream in interface javax.servlet.ServletResponseServletOutputStream for writing binary datajava.io.IOException - if an input or output exception occurredServletResponse.getWriter()public java.util.Locale getLocale()
javax.servlet.ServletResponseServletResponse.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 javax.servlet.ServletResponseServletResponse.setLocale(java.util.Locale)public java.io.PrintWriter getWriter()
throws java.io.IOException
javax.servlet.ServletResponsePrintWriter 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.
getWriter in interface javax.servlet.ServletResponsePrintWriter object that
can return character data to the clientjava.io.IOException - if an input or output exception occurredServletResponse.getOutputStream(),
ServletResponse.setCharacterEncoding(java.lang.String)public boolean isCommitted()
javax.servlet.ServletResponseisCommitted in interface javax.servlet.ServletResponseServletResponse.setBufferSize(int),
ServletResponse.getBufferSize(),
ServletResponse.flushBuffer(),
ServletResponse.reset()public void reset()
javax.servlet.ServletResponseIllegalStateException.reset in interface javax.servlet.ServletResponseServletResponse.setBufferSize(int),
ServletResponse.getBufferSize(),
ServletResponse.flushBuffer(),
ServletResponse.isCommitted()public void resetBuffer()
javax.servlet.ServletResponseIllegalStateException.resetBuffer in interface javax.servlet.ServletResponseServletResponse.setBufferSize(int),
ServletResponse.getBufferSize(),
ServletResponse.isCommitted(),
ServletResponse.reset()public void setBufferSize(int size)
javax.servlet.ServletResponsegetBufferSize.
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 javax.servlet.ServletResponsesize - the preferred buffer sizeServletResponse.getBufferSize(),
ServletResponse.flushBuffer(),
ServletResponse.isCommitted(),
ServletResponse.reset()public void setContentLength(int length)
javax.servlet.ServletResponsesetContentLength in interface javax.servlet.ServletResponselength - an integer specifying the length of the
content being returned to the client; sets
the Content-Length headerpublic void setContentType(java.lang.String type)
javax.servlet.ServletResponsetext/html;charset=UTF-8.
The response's character encoding is only set from the given
content type if this method is called before getWriter
is called.
This method may be called repeatedly to change content type and
character encoding.
This 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 getWriter
has been called or after the response has been committed.
Containers must communicate the content type 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 Content-Type header is used.
setContentType in interface javax.servlet.ServletResponsetype - a String specifying the MIME
type of the contentServletResponse.setLocale(java.util.Locale),
ServletResponse.setCharacterEncoding(java.lang.String),
ServletResponse.getOutputStream(),
ServletResponse.getWriter()public void setLocale(java.util.Locale locale)
javax.servlet.ServletResponseServletResponse.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 javax.servlet.ServletResponselocale - the locale of the responseServletResponse.getLocale(),
ServletResponse.setContentType(java.lang.String),
ServletResponse.setCharacterEncoding(java.lang.String)public javax.servlet.http.Cookie[] getCookies()
public java.lang.String getHeader(java.lang.String name)
public java.lang.String[] getHeaderNames()
public java.lang.String[] getHeaderValues(java.lang.String name)
public java.lang.String getMessage()
public int getStatus()
public void reset(int status,
java.lang.String message)
public void addCookie(javax.servlet.http.Cookie cookie)
javax.servlet.http.HttpServletResponseaddCookie in interface javax.servlet.http.HttpServletResponsecookie - the Cookie to return to the clientpublic void addDateHeader(java.lang.String name,
long value)
javax.servlet.http.HttpServletResponseaddDateHeader in interface javax.servlet.http.HttpServletResponsename - the name of the header to setvalue - the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)public void addHeader(java.lang.String name,
java.lang.String value)
javax.servlet.http.HttpServletResponseaddHeader in interface javax.servlet.http.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 addIntHeader(java.lang.String name,
int value)
javax.servlet.http.HttpServletResponseaddIntHeader in interface javax.servlet.http.HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)public boolean containsHeader(java.lang.String name)
javax.servlet.http.HttpServletResponsecontainsHeader in interface javax.servlet.http.HttpServletResponsename - the header nametrue if the named response header
has already been set;
false otherwisepublic java.lang.String encodeRedirectURL(java.lang.String url)
javax.servlet.http.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 javax.servlet.http.HttpServletResponseurl - the url to be encoded.HttpServletResponse.sendRedirect(java.lang.String),
HttpServletResponse.encodeUrl(java.lang.String)public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponseurl - the url to be encoded.public java.lang.String encodeURL(java.lang.String url)
javax.servlet.http.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 javax.servlet.http.HttpServletResponseurl - the url to be encoded.public java.lang.String encodeUrl(java.lang.String url)
encodeUrl in interface javax.servlet.http.HttpServletResponseurl - the url to be encoded.public void sendAcknowledgement()
throws java.io.IOException
java.io.IOExceptionpublic void sendError(int status)
throws java.io.IOException
javax.servlet.http.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 javax.servlet.http.HttpServletResponsestatus - the error status codejava.io.IOException - If an input or output exception occurspublic void sendError(int status,
java.lang.String message)
throws java.io.IOException
javax.servlet.http.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 javax.servlet.http.HttpServletResponsestatus - the error status codemessage - the descriptive messagejava.io.IOException - If an input or output exception occurspublic void sendRedirect(java.lang.String location)
throws java.io.IOException
javax.servlet.http.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.
sendRedirect in interface javax.servlet.http.HttpServletResponselocation - the redirect location URLjava.io.IOException - If an input or output exception occurspublic void setDateHeader(java.lang.String name,
long value)
javax.servlet.http.HttpServletResponsecontainsHeader method can be used to test for the
presence of a header before setting its value.setDateHeader in interface javax.servlet.http.HttpServletResponsename - the name of the header to setvalue - the assigned date valueHttpServletResponse.containsHeader(java.lang.String),
HttpServletResponse.addDateHeader(java.lang.String, long)public void setHeader(java.lang.String name,
java.lang.String value)
javax.servlet.http.HttpServletResponsecontainsHeader method can be
used to test for the presence of a header before setting its
value.setHeader in interface javax.servlet.http.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 setIntHeader(java.lang.String name,
int value)
javax.servlet.http.HttpServletResponsecontainsHeader
method can be used to test for the presence of a header before
setting its value.setIntHeader in interface javax.servlet.http.HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.containsHeader(java.lang.String),
HttpServletResponse.addIntHeader(java.lang.String, int)public void setStatus(int status)
javax.servlet.http.HttpServletResponsesendError method should be used
instead.
The container clears the buffer and sets the Location header, preserving cookies and other headers.
setStatus in interface javax.servlet.http.HttpServletResponsestatus - the status codeHttpServletResponse.sendError(int, java.lang.String)public void setStatus(int status,
java.lang.String message)
setStatus in interface javax.servlet.http.HttpServletResponsestatus - the status codemessage - the status messageCopyright © 2000-2013 Apache Software Foundation. All Rights Reserved.