public class ResponseFacade extends Object implements HttpServletResponse
| Modifier and Type | Field and Description | 
|---|---|
| protected Response | responseThe wrapped response. | 
| protected static StringManager | smThe string manager for this package. | 
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 | 
|---|
| ResponseFacade(Response response)Construct a wrapper for the specified response. | 
| Modifier and Type | Method and Description | 
|---|---|
| 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. | 
| void | clear()Clear facade. | 
| protected Object | clone()Prevent cloning the facade. | 
| 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  sendRedirectmethod
 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 | finish() | 
| 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. | 
| String | getCharacterEncoding()Returns the name of the character encoding (MIME charset) used for the
 body sent in this response. | 
| String | getContentType()Returns the content type used for the MIME body sent in this response. | 
| long | getContentWritten() | 
| String | getHeader(String name)Return the value for the specified header, or  nullif this
 header has not been set. | 
| Collection<String> | getHeaderNames()Get the header names set for this HTTP response. | 
| Collection<String> | getHeaders(String name)Return a Collection of all the header values associated with the
 specified header name. | 
| Locale | getLocale()Returns the locale specified for this response using the
  ServletResponse.setLocale(java.util.Locale)method. | 
| ServletOutputStream | getOutputStream()Returns a  ServletOutputStreamsuitable for writing binary data in
 the response. | 
| int | getStatus()Get the HTTP status code for this Response. | 
| PrintWriter | getWriter()Returns a  PrintWriterobject that can send character text to
 the client. | 
| boolean | isCommitted()Returns a boolean indicating if the response has been committed. | 
| boolean | isFinished() | 
| void | reset()Clears any data that exists in the buffer as well as the status code and
 headers. | 
| void | resetBuffer()Clears the content of the underlying buffer in the response without
 clearing headers or status code. | 
| void | sendError(int sc)Sends an error response to the client using the specified status code and
 clears the buffer. | 
| void | sendError(int sc,
         String msg)Sends an error response to the client using the specified status code and
 clears the output buffer. | 
| void | sendRedirect(String location)Sends a temporary redirect response to the client using the specified
 redirect location URL. | 
| void | setBufferSize(int size)Sets the preferred buffer size for the body of the response. | 
| void | setCharacterEncoding(String arg0)Sets the character encoding (MIME charset) of the response being sent to
 the client, for example, to UTF-8. | 
| void | setContentLength(int len)Sets the length of the content body in the response In HTTP servlets,
 this method sets the HTTP Content-Length header. | 
| void | setContentType(String type)Sets the content type of the response being sent to the client, if the
 response has not been committed yet. | 
| 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 | setLocale(Locale loc)Sets the locale of the response, if the response has not been committed
 yet. | 
| void | setStatus(int sc)Sets the status code for this response. | 
| void | setStatus(int sc,
         String sm)Sets the status code and message for this response. | 
protected static final StringManager sm
protected Response response
public ResponseFacade(Response response)
response - The response to be wrappedpublic void clear()
protected Object clone() throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionpublic void finish()
public boolean isFinished()
public long getContentWritten()
public String getCharacterEncoding()
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 ServletResponseString specifying the name of the character
         encoding, for example, UTF-8public ServletOutputStream getOutputStream() throws IOException
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 ServletResponseServletOutputStream for writing binary dataIOException - if an input or output exception occurredServletResponse.getWriter()public PrintWriter getWriter() throws IOException
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 ServletResponsePrintWriter object that can return character data
         to the clientUnsupportedEncodingException - if the character encoding returned by
                getCharacterEncoding cannot be usedIOException - if an input or output exception occurredServletResponse.getOutputStream(), 
ServletResponse.setCharacterEncoding(java.lang.String)public void setContentLength(int len)
ServletResponsesetContentLength in interface ServletResponselen - an integer specifying the length of the content being returned
            to the client; sets the Content-Length headerpublic void setContentType(String type)
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 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 setBufferSize(int size)
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 ServletResponsesize - the preferred buffer sizeServletResponse.getBufferSize(), 
ServletResponse.flushBuffer(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public int getBufferSize()
ServletResponsegetBufferSize in interface ServletResponseServletResponse.setBufferSize(int), 
ServletResponse.flushBuffer(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public void flushBuffer()
                 throws IOException
ServletResponseflushBuffer in interface ServletResponseIOException - if an I/O occurs during the flushing of the responseServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public void resetBuffer()
ServletResponseIllegalStateException.resetBuffer in interface ServletResponseServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public boolean isCommitted()
ServletResponseisCommitted in interface ServletResponseServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.flushBuffer(), 
ServletResponse.reset()public void reset()
ServletResponseIllegalStateException.reset in interface ServletResponseServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.flushBuffer(), 
ServletResponse.isCommitted()public void setLocale(Locale loc)
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 ServletResponseloc - the locale of the responseServletResponse.getLocale(), 
ServletResponse.setContentType(java.lang.String), 
ServletResponse.setCharacterEncoding(java.lang.String)public Locale getLocale()
ServletResponseServletResponse.setLocale(java.util.Locale) method. Calls made to setLocale after the
 response is committed have no effect.getLocale in interface ServletResponseServletResponse.setLocale(java.util.Locale) method. If no locale has been specified, the
          container's default locale is returned.ServletResponse.setLocale(java.util.Locale)public void addCookie(Cookie cookie)
HttpServletResponseaddCookie in interface HttpServletResponsecookie - the Cookie to return to the clientpublic boolean containsHeader(String name)
HttpServletResponsecontainsHeader in interface HttpServletResponsename - the header nametrue if the named response header has already been
         set; false otherwisepublic String encodeURL(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 String encodeRedirectURL(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 String encodeUrl(String url)
encodeUrl in interface HttpServletResponseurl - the url to be encoded.public String encodeRedirectUrl(String url)
encodeRedirectUrl in interface HttpServletResponseurl - the url to be encoded.public void sendError(int sc,
             String msg)
               throws 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 messageIOException - If an input or output exception occurspublic void sendError(int sc)
               throws IOException
HttpServletResponseHttpServletResponse.sendError(int,
 String) with the same status code and null for the message.sendError in interface HttpServletResponsesc - the error status codeIOException - If an input or output exception occurspublic void sendRedirect(String location) throws 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.
sendRedirect in interface HttpServletResponselocation - the redirect location URLIOException - If an input or output exception occurspublic void setDateHeader(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(String name, long date)
HttpServletResponseaddDateHeader in interface HttpServletResponsename - the name of the header to setdate - the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)public void setHeader(String name, 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(String name, String value)
HttpServletResponseaddHeader 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(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(String name, int value)
HttpServletResponseaddIntHeader in interface HttpServletResponsename - the name of the headervalue - the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)public void setStatus(int sc)
HttpServletResponsesendError method should be used instead.
 The container clears the buffer and sets the Location header, preserving cookies and other headers.
setStatus in interface HttpServletResponsesc - the status codeHttpServletResponse.sendError(int, java.lang.String)public void setStatus(int sc,
             String sm)
HttpServletResponsesetStatus in interface HttpServletResponsesc - the status codesm - the status messagepublic String getContentType()
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 ServletResponseString specifying the content type, for example,
         text/html; charset=UTF-8, or nullpublic void setCharacterEncoding(String arg0)
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 ServletResponsearg0 - a String specifying only the character set defined by IANA
            Character Sets
            (http://www.iana.org/assignments/character-sets)#setLocalepublic int getStatus()
HttpServletResponsegetStatus in interface HttpServletResponsepublic String getHeader(String name)
HttpServletResponsenull if this
 header has not been set.  If more than one value was added for this
 name, only the first is returned; use HttpServletResponse.getHeaders(String) to
 retrieve all of them.getHeader in interface HttpServletResponsename - Header name to look uppublic Collection<String> getHeaderNames()
HttpServletResponsegetHeaderNames in interface HttpServletResponsepublic Collection<String> getHeaders(String name)
HttpServletResponsegetHeaders in interface HttpServletResponsename - Header name to look upCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.