public class ServletResponseWrapper extends Object implements ServletResponse
ServletResponse
Constructor and Description |
---|
ServletResponseWrapper(ServletResponse response)
Creates a ServletResponse adaptor wrapping the given response object.
|
Modifier and Type | Method and Description |
---|---|
void |
flushBuffer()
The default behavior of this method is to call flushBuffer() on the wrapped response object.
|
int |
getBufferSize()
The default behavior of this method is to return getBufferSize() on the wrapped response object.
|
String |
getCharacterEncoding()
The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
|
String |
getContentType()
The default behavior of this method is to return getContentType() on the wrapped response object.
|
Locale |
getLocale()
The default behavior of this method is to return getLocale() on the wrapped response object.
|
ServletOutputStream |
getOutputStream()
The default behavior of this method is to return getOutputStream() on the wrapped response object.
|
ServletResponse |
getResponse()
Return the wrapped ServletResponse object.
|
PrintWriter |
getWriter()
The default behavior of this method is to return getWriter() on the wrapped response object.
|
boolean |
isCommitted()
The default behavior of this method is to return isCommitted() on the wrapped response object.
|
boolean |
isWrapperFor(Class<?> wrappedType)
Checks (recursively) if this ServletResponseWrapper wraps a
ServletResponse of the given class type. |
boolean |
isWrapperFor(ServletResponse wrapped)
Checks (recursively) if this ServletResponseWrapper wraps the given
ServletResponse instance. |
void |
reset()
The default behavior of this method is to call reset() on the wrapped response object.
|
void |
resetBuffer()
The default behavior of this method is to call resetBuffer() on the wrapped response object.
|
void |
setBufferSize(int size)
The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
|
void |
setCharacterEncoding(String charset)
The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response
object.
|
void |
setContentLength(int len)
The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
|
void |
setContentLengthLong(long len)
The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
|
void |
setContentType(String type)
The default behavior of this method is to call setContentType(String type) on the wrapped response object.
|
void |
setLocale(Locale loc)
The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
|
void |
setResponse(ServletResponse response)
Sets the response being wrapped.
|
public ServletResponseWrapper(ServletResponse response)
response
- the ServletResponse
to be wrappedIllegalArgumentException
- if the response is null.public ServletResponse getResponse()
ServletResponse
public void setResponse(ServletResponse response)
response
- the ServletResponse
to be installedIllegalArgumentException
- if the response is null.public void setCharacterEncoding(String charset)
setCharacterEncoding
in interface ServletResponse
charset
- 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 String getCharacterEncoding()
getCharacterEncoding
in interface ServletResponse
String
specifying the name of the character encoding, for example, UTF-8
public ServletOutputStream getOutputStream() throws IOException
getOutputStream
in interface ServletResponse
ServletOutputStream
for writing binary dataIOException
- if an input or output exception occurredServletResponse.getWriter()
,
ServletResponse.reset()
public PrintWriter getWriter() throws IOException
getWriter
in interface ServletResponse
PrintWriter
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)
,
ServletResponse.reset()
public void setContentLength(int len)
setContentLength
in interface ServletResponse
len
- an integer specifying the length of the content being returned to the client; sets the Content-Length
headerpublic void setContentLengthLong(long len)
setContentLengthLong
in interface ServletResponse
len
- a long specifying the length of the content being returned to the client; sets the Content-Length
headerpublic void setContentType(String type)
setContentType
in interface ServletResponse
type
- a String
specifying the MIME type of the contentServletResponse.setLocale(java.util.Locale)
,
ServletResponse.setCharacterEncoding(java.lang.String)
,
ServletResponse.getOutputStream()
,
ServletResponse.getWriter()
public String getContentType()
getContentType
in interface ServletResponse
String
specifying the content type, for example, text/html; charset=UTF-8
, or
nullpublic void setBufferSize(int size)
setBufferSize
in interface ServletResponse
size
- the preferred buffer sizeServletResponse.getBufferSize()
,
ServletResponse.flushBuffer()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public int getBufferSize()
getBufferSize
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.flushBuffer()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public void flushBuffer() throws IOException
flushBuffer
in interface ServletResponse
IOException
- if the act of flushing the buffer cannot be completed.ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public boolean isCommitted()
isCommitted
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.flushBuffer()
,
ServletResponse.reset()
public void reset()
reset
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.flushBuffer()
,
ServletResponse.isCommitted()
public void resetBuffer()
resetBuffer
in interface ServletResponse
ServletResponse.setBufferSize(int)
,
ServletResponse.getBufferSize()
,
ServletResponse.isCommitted()
,
ServletResponse.reset()
public void setLocale(Locale loc)
setLocale
in interface ServletResponse
loc
- the locale of the responseServletResponse.getLocale()
,
ServletResponse.setContentType(java.lang.String)
,
ServletResponse.setCharacterEncoding(java.lang.String)
public Locale getLocale()
getLocale
in interface ServletResponse
ServletResponse.setLocale(java.util.Locale)
public boolean isWrapperFor(ServletResponse wrapped)
ServletResponse
instance.wrapped
- the ServletResponse instance to search forpublic boolean isWrapperFor(Class<?> wrappedType)
ServletResponse
of the given class type.wrappedType
- the ServletResponse class type to search forIllegalArgumentException
- if the given class does not implement ServletResponse
Copyright © 2021 JBoss by Red Hat. All rights reserved.