Package javax.servlet
Class ServletResponseWrapper
- java.lang.Object
- 
- javax.servlet.ServletResponseWrapper
 
- 
- All Implemented Interfaces:
- ServletResponse
 - Direct Known Subclasses:
- HttpServletResponseWrapper
 
 public class ServletResponseWrapper extends java.lang.Object implements ServletResponse Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.- Since:
- Servlet 2.3
- See Also:
- ServletResponse
 
- 
- 
Constructor SummaryConstructors Constructor Description ServletResponseWrapper(ServletResponse response)Creates a ServletResponse adaptor wrapping the given response object.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidflushBuffer()The default behavior of this method is to call flushBuffer() on the wrapped response object.intgetBufferSize()The default behavior of this method is to return getBufferSize() on the wrapped response object.java.lang.StringgetCharacterEncoding()The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.java.lang.StringgetContentType()The default behavior of this method is to return getContentType() on the wrapped response object.java.util.LocalegetLocale()The default behavior of this method is to return getLocale() on the wrapped response object.ServletOutputStreamgetOutputStream()The default behavior of this method is to return getOutputStream() on the wrapped response object.ServletResponsegetResponse()Return the wrapped ServletResponse object.java.io.PrintWritergetWriter()The default behavior of this method is to return getWriter() on the wrapped response object.booleanisCommitted()The default behavior of this method is to return isCommitted() on the wrapped response object.booleanisWrapperFor(java.lang.Class<?> wrappedType)TODO SERVLET3 - Add commentsbooleanisWrapperFor(ServletResponse wrapped)TODO SERVLET3 - Add commentsvoidreset()The default behavior of this method is to call reset() on the wrapped response object.voidresetBuffer()The default behavior of this method is to call resetBuffer() on the wrapped response object.voidsetBufferSize(int size)The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.voidsetCharacterEncoding(java.lang.String charset)The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.voidsetContentLength(int len)The default behavior of this method is to call setContentLength(int len) on the wrapped response object.voidsetContentLengthLong(long length)The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.voidsetContentType(java.lang.String type)The default behavior of this method is to call setContentType(String type) on the wrapped response object.voidsetLocale(java.util.Locale loc)The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.voidsetResponse(ServletResponse response)Sets the response being wrapped.
 
- 
- 
- 
Constructor Detail- 
ServletResponseWrapperpublic ServletResponseWrapper(ServletResponse response) Creates a ServletResponse adaptor wrapping the given response object.- Parameters:
- response- The response to wrap
- Throws:
- java.lang.IllegalArgumentException- if the response is null.
 
 
- 
 - 
Method Detail- 
getResponsepublic ServletResponse getResponse() Return the wrapped ServletResponse object.- Returns:
- The wrapped ServletResponse object.
 
 - 
setResponsepublic void setResponse(ServletResponse response) Sets the response being wrapped.- Parameters:
- response- The new response to wrap
- Throws:
- java.lang.IllegalArgumentException- if the response is null.
 
 - 
setCharacterEncodingpublic void setCharacterEncoding(java.lang.String charset) The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.- Specified by:
- setCharacterEncodingin interface- ServletResponse
- Parameters:
- charset- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
- Since:
- Servlet 2.4
- See Also:
- #setLocale
 
 - 
getCharacterEncodingpublic java.lang.String getCharacterEncoding() The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.- Specified by:
- getCharacterEncodingin interface- ServletResponse
- Returns:
- a Stringspecifying the name of the character encoding, for example,UTF-8
 
 - 
getOutputStreampublic ServletOutputStream getOutputStream() throws java.io.IOException The default behavior of this method is to return getOutputStream() on the wrapped response object.- Specified by:
- getOutputStreamin interface- ServletResponse
- Returns:
- a ServletOutputStreamfor writing binary data
- Throws:
- java.io.IOException- if an input or output exception occurred
- See Also:
- ServletResponse.getWriter()
 
 - 
getWriterpublic java.io.PrintWriter getWriter() throws java.io.IOExceptionThe default behavior of this method is to return getWriter() on the wrapped response object.- Specified by:
- getWriterin interface- ServletResponse
- Returns:
- a PrintWriterobject that can return character data to the client
- Throws:
- java.io.UnsupportedEncodingException- if the character encoding returned by- getCharacterEncodingcannot be used
- java.io.IOException- if an input or output exception occurred
- See Also:
- ServletResponse.getOutputStream(),- ServletResponse.setCharacterEncoding(java.lang.String)
 
 - 
setContentLengthpublic void setContentLength(int len) The default behavior of this method is to call setContentLength(int len) on the wrapped response object.- Specified by:
- setContentLengthin interface- ServletResponse
- Parameters:
- len- an integer specifying the length of the content being returned to the client; sets the Content-Length header
 
 - 
setContentLengthLongpublic void setContentLengthLong(long length) The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.- Specified by:
- setContentLengthLongin interface- ServletResponse
- Parameters:
- length- an integer specifying the length of the content being returned to the client; sets the Content-Length header
- Since:
- Servlet 3.1
 
 - 
setContentTypepublic void setContentType(java.lang.String type) The default behavior of this method is to call setContentType(String type) on the wrapped response object.- Specified by:
- setContentTypein interface- ServletResponse
- Parameters:
- type- a- Stringspecifying the MIME type of the content
- See Also:
- ServletResponse.setLocale(java.util.Locale),- ServletResponse.setCharacterEncoding(java.lang.String),- ServletResponse.getOutputStream(),- ServletResponse.getWriter()
 
 - 
getContentTypepublic java.lang.String getContentType() The default behavior of this method is to return getContentType() on the wrapped response object.- Specified by:
- getContentTypein interface- ServletResponse
- Returns:
- a Stringspecifying the content type, for example,text/html; charset=UTF-8, or null
- Since:
- Servlet 2.4
 
 - 
setBufferSizepublic void setBufferSize(int size) The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.- Specified by:
- setBufferSizein interface- ServletResponse
- Parameters:
- size- the preferred buffer size
- See Also:
- ServletResponse.getBufferSize(),- ServletResponse.flushBuffer(),- ServletResponse.isCommitted(),- ServletResponse.reset()
 
 - 
getBufferSizepublic int getBufferSize() The default behavior of this method is to return getBufferSize() on the wrapped response object.- Specified by:
- getBufferSizein interface- ServletResponse
- Returns:
- the actual buffer size used
- See Also:
- ServletResponse.setBufferSize(int),- ServletResponse.flushBuffer(),- ServletResponse.isCommitted(),- ServletResponse.reset()
 
 - 
flushBufferpublic void flushBuffer() throws java.io.IOExceptionThe default behavior of this method is to call flushBuffer() on the wrapped response object.- Specified by:
- flushBufferin interface- ServletResponse
- Throws:
- java.io.IOException- if an I/O occurs during the flushing of the response
- See Also:
- ServletResponse.setBufferSize(int),- ServletResponse.getBufferSize(),- ServletResponse.isCommitted(),- ServletResponse.reset()
 
 - 
isCommittedpublic boolean isCommitted() The default behavior of this method is to return isCommitted() on the wrapped response object.- Specified by:
- isCommittedin interface- ServletResponse
- Returns:
- a boolean indicating if the response has been committed
- See Also:
- ServletResponse.setBufferSize(int),- ServletResponse.getBufferSize(),- ServletResponse.flushBuffer(),- ServletResponse.reset()
 
 - 
resetpublic void reset() The default behavior of this method is to call reset() on the wrapped response object.- Specified by:
- resetin interface- ServletResponse
- See Also:
- ServletResponse.setBufferSize(int),- ServletResponse.getBufferSize(),- ServletResponse.flushBuffer(),- ServletResponse.isCommitted()
 
 - 
resetBufferpublic void resetBuffer() The default behavior of this method is to call resetBuffer() on the wrapped response object.- Specified by:
- resetBufferin interface- ServletResponse
- See Also:
- ServletResponse.setBufferSize(int),- ServletResponse.getBufferSize(),- ServletResponse.isCommitted(),- ServletResponse.reset()
 
 - 
setLocalepublic void setLocale(java.util.Locale loc) The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.- Specified by:
- setLocalein interface- ServletResponse
- Parameters:
- loc- the locale of the response
- See Also:
- ServletResponse.getLocale(),- ServletResponse.setContentType(java.lang.String),- ServletResponse.setCharacterEncoding(java.lang.String)
 
 - 
getLocalepublic java.util.Locale getLocale() The default behavior of this method is to return getLocale() on the wrapped response object.- Specified by:
- getLocalein interface- ServletResponse
- Returns:
- The locale specified for this response using the
          ServletResponse.setLocale(java.util.Locale)method. If no locale has been specified, the container's default locale is returned.
- See Also:
- ServletResponse.setLocale(java.util.Locale)
 
 - 
isWrapperForpublic boolean isWrapperFor(ServletResponse wrapped) TODO SERVLET3 - Add comments- Parameters:
- wrapped- The response to compare to the wrapped response
- Returns:
- trueif the response wrapped by this wrapper (or series of wrappers) is the same as the supplied response, otherwise- false
- Since:
- Servlet 3.0
 
 - 
isWrapperForpublic boolean isWrapperFor(java.lang.Class<?> wrappedType) TODO SERVLET3 - Add comments- Parameters:
- wrappedType- The class to compare to the class of the wrapped response
- Returns:
- trueif the response wrapped by this wrapper (or series of wrappers) is the same type as the supplied type, otherwise- false
- Since:
- Servlet 3.0
 
 
- 
 
-