com.liferay.portal.kernel.servlet
Class MetaInfoCacheServletResponse
java.lang.Object
javax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
com.liferay.portal.kernel.servlet.MetaInfoCacheServletResponse
- All Implemented Interfaces:
- javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
- Direct Known Subclasses:
- BufferCacheServletResponse, GZipResponse, RestrictedByteBufferCacheServletResponse
public class MetaInfoCacheServletResponse
- extends javax.servlet.http.HttpServletResponseWrapper
Fields inherited from interface 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 |
Method Summary |
void |
addCookie(javax.servlet.http.Cookie cookie)
|
void |
addDateHeader(String name,
long value)
|
void |
addHeader(String name,
String value)
|
void |
addIntHeader(String name,
int value)
|
boolean |
containsHeader(String name)
|
void |
finishResponse()
Deprecated. As of 7.0.0, replaced by finishResponse(boolean) } |
void |
finishResponse(boolean reapplyMetaData)
|
static void |
finishResponse(MetaInfoCacheServletResponse.MetaData metaInfoDataBag,
javax.servlet.http.HttpServletResponse response)
|
void |
flushBuffer()
|
int |
getBufferSize()
|
String |
getCharacterEncoding()
|
String |
getContentType()
|
String |
getHeader(String name)
When the header for this given name is "Cookie", the return value cannot
be used for the "Set-Cookie" header. |
Collection<String> |
getHeaderNames()
|
Map<String,Set<Header>> |
getHeaders()
|
Collection<String> |
getHeaders(String name)
When the header for this given name is "Cookie", the return value cannot
be used for the "Set-Cookie" header. |
Locale |
getLocale()
|
MetaInfoCacheServletResponse.MetaData |
getMetaData()
|
javax.servlet.ServletOutputStream |
getOutputStream()
|
int |
getStatus()
|
PrintWriter |
getWriter()
|
boolean |
isCommitted()
|
void |
reset()
|
void |
resetBuffer()
|
protected void |
resetBuffer(boolean nullOutReferences)
Stub method for subclass to provide buffer resetting logic. |
protected static void |
resetThrough(javax.servlet.http.HttpServletResponse response)
|
void |
sendError(int status)
|
void |
sendError(int status,
String errorMessage)
|
void |
sendRedirect(String location)
|
void |
setBufferSize(int bufferSize)
|
void |
setCharacterEncoding(String charsetName)
|
void |
setContentLength(int contentLength)
|
void |
setContentType(String contentType)
|
void |
setDateHeader(String name,
long value)
|
void |
setHeader(String name,
String value)
|
void |
setIntHeader(String name,
int value)
|
void |
setLocale(Locale locale)
|
void |
setStatus(int status)
|
void |
setStatus(int status,
String statusMessage)
|
String |
toString()
|
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper |
encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL |
Methods inherited from class javax.servlet.ServletResponseWrapper |
getResponse, isWrapperFor, isWrapperFor, setResponse |
calledGetOutputStream
protected boolean calledGetOutputStream
calledGetWriter
protected boolean calledGetWriter
MetaInfoCacheServletResponse
public MetaInfoCacheServletResponse(javax.servlet.http.HttpServletResponse response)
finishResponse
public static void finishResponse(MetaInfoCacheServletResponse.MetaData metaInfoDataBag,
javax.servlet.http.HttpServletResponse response)
throws IOException
- Throws:
IOException
addCookie
public void addCookie(javax.servlet.http.Cookie cookie)
- Specified by:
addCookie
in interface javax.servlet.http.HttpServletResponse
- Overrides:
addCookie
in class javax.servlet.http.HttpServletResponseWrapper
addDateHeader
public void addDateHeader(String name,
long value)
- Specified by:
addDateHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
addDateHeader
in class javax.servlet.http.HttpServletResponseWrapper
addHeader
public void addHeader(String name,
String value)
- Specified by:
addHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
addHeader
in class javax.servlet.http.HttpServletResponseWrapper
addIntHeader
public void addIntHeader(String name,
int value)
- Specified by:
addIntHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
addIntHeader
in class javax.servlet.http.HttpServletResponseWrapper
containsHeader
public boolean containsHeader(String name)
- Specified by:
containsHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
containsHeader
in class javax.servlet.http.HttpServletResponseWrapper
finishResponse
@Deprecated
public void finishResponse()
throws IOException
- Deprecated. As of 7.0.0, replaced by
finishResponse(boolean)
}
- Throws:
IOException
finishResponse
public void finishResponse(boolean reapplyMetaData)
throws IOException
- Throws:
IOException
flushBuffer
public void flushBuffer()
throws IOException
- Specified by:
flushBuffer
in interface javax.servlet.ServletResponse
- Overrides:
flushBuffer
in class javax.servlet.ServletResponseWrapper
- Throws:
IOException
getBufferSize
public int getBufferSize()
- Specified by:
getBufferSize
in interface javax.servlet.ServletResponse
- Overrides:
getBufferSize
in class javax.servlet.ServletResponseWrapper
getCharacterEncoding
public String getCharacterEncoding()
- Specified by:
getCharacterEncoding
in interface javax.servlet.ServletResponse
- Overrides:
getCharacterEncoding
in class javax.servlet.ServletResponseWrapper
getContentType
public String getContentType()
- Specified by:
getContentType
in interface javax.servlet.ServletResponse
- Overrides:
getContentType
in class javax.servlet.ServletResponseWrapper
getHeader
public String getHeader(String name)
- When the header for this given name is "Cookie", the return value cannot
be used for the "Set-Cookie" header. The string representation for
"Cookie" is application server specific. The only safe way to add the
header is to call
HttpServletResponse.addCookie(Cookie)
.
- Specified by:
getHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
getHeader
in class javax.servlet.http.HttpServletResponseWrapper
getHeaderNames
public Collection<String> getHeaderNames()
- Specified by:
getHeaderNames
in interface javax.servlet.http.HttpServletResponse
- Overrides:
getHeaderNames
in class javax.servlet.http.HttpServletResponseWrapper
getHeaders
public Map<String,Set<Header>> getHeaders()
getHeaders
public Collection<String> getHeaders(String name)
- When the header for this given name is "Cookie", the return value cannot
be used for the "Set-Cookie" header. The string representation for
"Cookie" is application server specific. The only safe way to add the
header is to call
HttpServletResponse.addCookie(Cookie)
.
- Specified by:
getHeaders
in interface javax.servlet.http.HttpServletResponse
- Overrides:
getHeaders
in class javax.servlet.http.HttpServletResponseWrapper
getLocale
public Locale getLocale()
- Specified by:
getLocale
in interface javax.servlet.ServletResponse
- Overrides:
getLocale
in class javax.servlet.ServletResponseWrapper
getMetaData
public MetaInfoCacheServletResponse.MetaData getMetaData()
getOutputStream
public javax.servlet.ServletOutputStream getOutputStream()
throws IOException
- Specified by:
getOutputStream
in interface javax.servlet.ServletResponse
- Overrides:
getOutputStream
in class javax.servlet.ServletResponseWrapper
- Throws:
IOException
getStatus
public int getStatus()
- Specified by:
getStatus
in interface javax.servlet.http.HttpServletResponse
- Overrides:
getStatus
in class javax.servlet.http.HttpServletResponseWrapper
getWriter
public PrintWriter getWriter()
throws IOException
- Specified by:
getWriter
in interface javax.servlet.ServletResponse
- Overrides:
getWriter
in class javax.servlet.ServletResponseWrapper
- Throws:
IOException
isCommitted
public boolean isCommitted()
- Specified by:
isCommitted
in interface javax.servlet.ServletResponse
- Overrides:
isCommitted
in class javax.servlet.ServletResponseWrapper
reset
public void reset()
- Specified by:
reset
in interface javax.servlet.ServletResponse
- Overrides:
reset
in class javax.servlet.ServletResponseWrapper
resetBuffer
public void resetBuffer()
- Specified by:
resetBuffer
in interface javax.servlet.ServletResponse
- Overrides:
resetBuffer
in class javax.servlet.ServletResponseWrapper
sendError
public void sendError(int status)
throws IOException
- Specified by:
sendError
in interface javax.servlet.http.HttpServletResponse
- Overrides:
sendError
in class javax.servlet.http.HttpServletResponseWrapper
- Throws:
IOException
sendError
public void sendError(int status,
String errorMessage)
throws IOException
- Specified by:
sendError
in interface javax.servlet.http.HttpServletResponse
- Overrides:
sendError
in class javax.servlet.http.HttpServletResponseWrapper
- Throws:
IOException
sendRedirect
public void sendRedirect(String location)
throws IOException
- Specified by:
sendRedirect
in interface javax.servlet.http.HttpServletResponse
- Overrides:
sendRedirect
in class javax.servlet.http.HttpServletResponseWrapper
- Throws:
IOException
setBufferSize
public void setBufferSize(int bufferSize)
- Specified by:
setBufferSize
in interface javax.servlet.ServletResponse
- Overrides:
setBufferSize
in class javax.servlet.ServletResponseWrapper
setCharacterEncoding
public void setCharacterEncoding(String charsetName)
- Specified by:
setCharacterEncoding
in interface javax.servlet.ServletResponse
- Overrides:
setCharacterEncoding
in class javax.servlet.ServletResponseWrapper
setContentLength
public void setContentLength(int contentLength)
- Specified by:
setContentLength
in interface javax.servlet.ServletResponse
- Overrides:
setContentLength
in class javax.servlet.ServletResponseWrapper
setContentType
public void setContentType(String contentType)
- Specified by:
setContentType
in interface javax.servlet.ServletResponse
- Overrides:
setContentType
in class javax.servlet.ServletResponseWrapper
setDateHeader
public void setDateHeader(String name,
long value)
- Specified by:
setDateHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
setDateHeader
in class javax.servlet.http.HttpServletResponseWrapper
setHeader
public void setHeader(String name,
String value)
- Specified by:
setHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
setHeader
in class javax.servlet.http.HttpServletResponseWrapper
setIntHeader
public void setIntHeader(String name,
int value)
- Specified by:
setIntHeader
in interface javax.servlet.http.HttpServletResponse
- Overrides:
setIntHeader
in class javax.servlet.http.HttpServletResponseWrapper
setLocale
public void setLocale(Locale locale)
- Specified by:
setLocale
in interface javax.servlet.ServletResponse
- Overrides:
setLocale
in class javax.servlet.ServletResponseWrapper
setStatus
public void setStatus(int status)
- Specified by:
setStatus
in interface javax.servlet.http.HttpServletResponse
- Overrides:
setStatus
in class javax.servlet.http.HttpServletResponseWrapper
setStatus
public void setStatus(int status,
String statusMessage)
- Specified by:
setStatus
in interface javax.servlet.http.HttpServletResponse
- Overrides:
setStatus
in class javax.servlet.http.HttpServletResponseWrapper
toString
public String toString()
- Overrides:
toString
in class Object
resetThrough
protected static void resetThrough(javax.servlet.http.HttpServletResponse response)
resetBuffer
protected void resetBuffer(boolean nullOutReferences)
- Stub method for subclass to provide buffer resetting logic.
- Parameters:
nullOutReferences
- whether to reset flags. It is not directly used
by this class. Subclasses with an actual buffer may behave
differently depending on the value of this parameter.