Package org.opencms.staticexport
Class CmsStaticExportResponseWrapper
- java.lang.Object
-
- javax.servlet.ServletResponseWrapper
-
- javax.servlet.http.HttpServletResponseWrapper
-
- org.opencms.staticexport.CmsStaticExportResponseWrapper
-
- All Implemented Interfaces:
javax.servlet.http.HttpServletResponse
,javax.servlet.ServletResponse
public class CmsStaticExportResponseWrapper extends javax.servlet.http.HttpServletResponseWrapper
Response wrapper for static export requests, required to access the status code of the response.The
method is called by the static export manager. Many implementations set the http status codes for the response. This wrapper enables the export manager to return the status code set on the response inI_CmsResourceLoader.export(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, HttpServletResponse)
.CmsStaticExportManager.export(javax.servlet.http.HttpServletRequest, HttpServletResponse, org.opencms.file.CmsObject, CmsStaticExportData)
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description protected int
m_status
The status code.-
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
-
-
Constructor Summary
Constructors Constructor Description CmsStaticExportResponseWrapper(javax.servlet.http.HttpServletResponse res)
Creates a new export response wrapper.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getStatus()
Returns the status code of this export response, if no status code was set so far,-1
is returned.void
sendError(int status)
void
sendError(int status, java.lang.String message)
void
setStatus(int status)
void
setStatus(int status, java.lang.String message)
-
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, sendRedirect, setDateHeader, setHeader, setIntHeader
-
Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
-
-
-
-
Field Detail
-
m_status
protected int m_status
The status code.
-
-
Constructor Detail
-
CmsStaticExportResponseWrapper
public CmsStaticExportResponseWrapper(javax.servlet.http.HttpServletResponse res)
Creates a new export response wrapper.- Parameters:
res
- the original response to wrap
-
-
Method Detail
-
getStatus
public int getStatus()
Returns the status code of this export response, if no status code was set so far,-1
is returned.- Specified by:
getStatus
in interfacejavax.servlet.http.HttpServletResponse
- Overrides:
getStatus
in classjavax.servlet.http.HttpServletResponseWrapper
- Returns:
- the status code of this export response
-
sendError
public void sendError(int status) throws java.io.IOException
- Specified by:
sendError
in interfacejavax.servlet.http.HttpServletResponse
- Overrides:
sendError
in classjavax.servlet.http.HttpServletResponseWrapper
- Throws:
java.io.IOException
- See Also:
HttpServletResponse.sendError(int)
-
sendError
public void sendError(int status, java.lang.String message) throws java.io.IOException
- Specified by:
sendError
in interfacejavax.servlet.http.HttpServletResponse
- Overrides:
sendError
in classjavax.servlet.http.HttpServletResponseWrapper
- Throws:
java.io.IOException
- See Also:
HttpServletResponse.sendError(int, java.lang.String)
-
setStatus
public void setStatus(int status)
- Specified by:
setStatus
in interfacejavax.servlet.http.HttpServletResponse
- Overrides:
setStatus
in classjavax.servlet.http.HttpServletResponseWrapper
- See Also:
HttpServletResponseWrapper.setStatus(int)
-
setStatus
public void setStatus(int status, java.lang.String message)
- Specified by:
setStatus
in interfacejavax.servlet.http.HttpServletResponse
- Overrides:
setStatus
in classjavax.servlet.http.HttpServletResponseWrapper
- See Also:
HttpServletResponseWrapper.setStatus(int, java.lang.String)
-
-