Class StoredResponse
java.lang.Object
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
com.ibm.websphere.servlet.response.StoredResponse
- All Implemented Interfaces:
StoredResponseCompat<CollectionEnumerationHybrid<String>>,IExtendedResponse,ServletResponseExtended,com.ibm.wsspi.webcontainer.util.IOutputStreamObserver,com.ibm.wsspi.webcontainer.util.IResponseOutput,Serializable,jakarta.servlet.http.HttpServletResponse,jakarta.servlet.ServletResponse
- Direct Known Subclasses:
ChainedResponse
public class StoredResponse
extends jakarta.servlet.http.HttpServletResponseWrapper
implements StoredResponseCompat<CollectionEnumerationHybrid<String>>, jakarta.servlet.http.HttpServletResponse, Serializable, com.ibm.wsspi.webcontainer.util.IResponseOutput, IExtendedResponse, com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
StoredResponse is a response object that can be instantiated
by any servlet and used/passed as a standard HttpResponse. The
data that is written to this response will be stored for later use.
- See Also:
-
Field Summary
Fields inherited from interface jakarta.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
ConstructorsConstructorDescriptionStoredResponse(boolean isInclude) StoredResponse(ServletResponseExtended extResponse, boolean isInclude) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCookie(jakarta.servlet.http.Cookie cookie) voidaddDateHeader(String name, long date) voidvoidaddIntHeader(String name, int value) voidaddSessionCookie(jakarta.servlet.http.Cookie cookie) voidvoidvoidvoidvoidbuildResponseData(ServletResponseExtended response) voidbuildWriterData(ServletResponseExtended response) voidclose()voidcloseResponseOutput(boolean b) booleanReturns true if sendError() was called on this response.booleancontainsHeader(String name) voiddestroy()encodeRedirectUrl(String url) encodeRedirectURL(String url) voidfinish()voidfireOutputStreamRetrievedEvent(jakarta.servlet.ServletOutputStream sos) voidvoidvoidflushBuffer(boolean flushToWire) Retrieve only the headers set in the includeintList<com.ibm.wsspi.bytebuffer.WsByteBuffer>Return the character encoding as specified in the charset flag of the content-type.jakarta.servlet.http.Cookie[]Return the cookies that were set using the addCookie() method.longgetDateHeader(String name) Retrieve a response header as a date.com.ibm.websphere.servlet.error.ServletErrorReportgetError()Returns the error message as reported by the sendError() method.intReturns the status code as reported by the sendError() method.Retrieve a response header field by name.Retrieve the names of the header fields that have been set on this response.Vector[]intgetIntHeader(String name) Retrieve a response header as an int.longReturns the date that the data was last modifed in this response or -1 if unknown.byte[]Get the output from the response outputstream as a String.jakarta.servlet.ServletOutputStreamReturns the target URI of the redirect as specified by the sendRedirect() method.intReturns the status code as specifed by the setStatus() method.Returns the status message as reported by the setStatus() method.voidbooleanbooleanReturn true if the data in this response has expired.booleanbooleanReturns true if sendRedirect() was called.booleanvoidvoidremoveCookie(String cookieName) voidreset()voidClears the content of the underlying buffer in the response without clearing headers or status code.voidsendError(int sc) voidvoidsendRedirect(String uri) voidsendRedirect303(String uri) voidsetBufferSize(int size) voidsetCharacterEncoding(String encoding) voidsetContentLength(int len) voidsetContentType(String type) voidsetDateHeader(String name, long value) voidvoidvoidsetInclude(boolean isInclude) voidsetInternalHeader(String name, String value) voidsetInternalHeaderSettable(boolean internalHeaderSettable) voidsetIntHeader(String name, int value) voidvoidsetStatus(int sc) voidvoidstart()voidtransferResponse(jakarta.servlet.http.HttpServletResponse target) Copy the contents of this response to another HttpServletResponse.booleanMethods inherited from class jakarta.servlet.http.HttpServletResponseWrapper
getHeaders, getStatusMethods inherited from class jakarta.servlet.ServletResponseWrapper
getResponse, isWrapperFor, isWrapperFor, setResponseMethods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.servlet.http.HttpServletResponse
getHeaders, getStatus
-
Constructor Details
-
StoredResponse
public StoredResponse() -
StoredResponse
public StoredResponse(boolean isInclude) -
StoredResponse
-
-
Method Details
-
writerObtained
public boolean writerObtained()- Specified by:
writerObtainedin interfacecom.ibm.wsspi.webcontainer.util.IResponseOutput
-
outputStreamObtained
public boolean outputStreamObtained()- Specified by:
outputStreamObtainedin interfacecom.ibm.wsspi.webcontainer.util.IResponseOutput
-
addCookie
public void addCookie(jakarta.servlet.http.Cookie cookie) - Specified by:
addCookiein interfacejakarta.servlet.http.HttpServletResponse- Overrides:
addCookiein classjakarta.servlet.http.HttpServletResponseWrapper
-
getIResponse
- Specified by:
getIResponsein interfaceIExtendedResponse- Specified by:
getIResponsein interfaceServletResponseExtended
-
getOutputStream
public jakarta.servlet.ServletOutputStream getOutputStream() throws IllegalStateException, IOException- Specified by:
getOutputStreamin interfacejakarta.servlet.ServletResponse- Overrides:
getOutputStreamin classjakarta.servlet.ServletResponseWrapper- Throws:
IllegalStateExceptionIOException
-
setContentLength
public void setContentLength(int len) - Specified by:
setContentLengthin interfacejakarta.servlet.ServletResponse- Overrides:
setContentLengthin classjakarta.servlet.ServletResponseWrapper
-
setContentType
- Specified by:
setContentTypein interfacejakarta.servlet.ServletResponse- Overrides:
setContentTypein classjakarta.servlet.ServletResponseWrapper
-
setBufferSize
- Specified by:
setBufferSizein interfacejakarta.servlet.ServletResponse- Overrides:
setBufferSizein classjakarta.servlet.ServletResponseWrapper- Throws:
IllegalStateException
-
getBufferSize
public int getBufferSize()- Specified by:
getBufferSizein interfacejakarta.servlet.ServletResponse- Overrides:
getBufferSizein classjakarta.servlet.ServletResponseWrapper
-
flushBuffer
- Specified by:
flushBufferin interfacejakarta.servlet.ServletResponse- Overrides:
flushBufferin classjakarta.servlet.ServletResponseWrapper- Throws:
IOException
-
flushBuffer
- Specified by:
flushBufferin interfacecom.ibm.wsspi.webcontainer.util.IResponseOutput- Throws:
IOException
-
isCommitted
public boolean isCommitted()- Specified by:
isCommittedin interfacecom.ibm.wsspi.webcontainer.util.IResponseOutput- Specified by:
isCommittedin interfacejakarta.servlet.ServletResponse- Overrides:
isCommittedin classjakarta.servlet.ServletResponseWrapper
-
reset
- Specified by:
resetin interfacecom.ibm.wsspi.webcontainer.util.IResponseOutput- Specified by:
resetin interfacejakarta.servlet.ServletResponse- Overrides:
resetin classjakarta.servlet.ServletResponseWrapper- Throws:
IllegalStateException
-
getHeaderTable
- Specified by:
getHeaderTablein interfaceIExtendedResponse- Specified by:
getHeaderTablein interfaceServletResponseExtended
-
addSessionCookie
public void addSessionCookie(jakarta.servlet.http.Cookie cookie) - Specified by:
addSessionCookiein interfaceIExtendedResponse- Specified by:
addSessionCookiein interfaceServletResponseExtended
-
setLocale
- Specified by:
setLocalein interfacejakarta.servlet.ServletResponse- Overrides:
setLocalein classjakarta.servlet.ServletResponseWrapper
-
setCharacterEncoding
- Specified by:
setCharacterEncodingin interfacejakarta.servlet.ServletResponse- Overrides:
setCharacterEncodingin classjakarta.servlet.ServletResponseWrapper
-
getLocale
- Specified by:
getLocalein interfacejakarta.servlet.ServletResponse- Overrides:
getLocalein classjakarta.servlet.ServletResponseWrapper
-
addDateHeader
- Specified by:
addDateHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
addDateHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
addHeader
- Specified by:
addHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
addHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
addIntHeader
- Specified by:
addIntHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
addIntHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
setHeader
- Specified by:
setHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
setHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
setInternalHeader
- Specified by:
setInternalHeaderin interfaceIExtendedResponse
-
setHeader
- Specified by:
setHeaderin interfaceIExtendedResponse- Specified by:
setHeaderin interfaceServletResponseExtended
-
setIntHeader
- Specified by:
setIntHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
setIntHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
setDateHeader
- Specified by:
setDateHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
setDateHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
containsHeader
- Specified by:
containsHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
containsHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
getWriter
- Specified by:
getWriterin interfacejakarta.servlet.ServletResponse- Overrides:
getWriterin classjakarta.servlet.ServletResponseWrapper- Throws:
IOExceptionIllegalStateException
-
setStatus
public void setStatus(int sc) - Specified by:
setStatusin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
setStatusin classjakarta.servlet.http.HttpServletResponseWrapper
-
setStatus
- Specified by:
setStatusin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
setStatusin classjakarta.servlet.http.HttpServletResponseWrapper
-
sendError
- Specified by:
sendErrorin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
sendErrorin classjakarta.servlet.http.HttpServletResponseWrapper- Throws:
IOException
-
sendError
- Specified by:
sendErrorin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
sendErrorin classjakarta.servlet.http.HttpServletResponseWrapper- Throws:
IOException
-
encodeURL
- Specified by:
encodeURLin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
encodeURLin classjakarta.servlet.http.HttpServletResponseWrapper
-
encodeUrl
- Specified by:
encodeUrlin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
encodeUrlin classjakarta.servlet.http.HttpServletResponseWrapper
-
sendRedirect
- Specified by:
sendRedirectin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
sendRedirectin classjakarta.servlet.http.HttpServletResponseWrapper- Throws:
IOException
-
sendRedirect303
- Specified by:
sendRedirect303in interfaceIExtendedResponse- Throws:
IOException
-
encodeRedirectURL
- Specified by:
encodeRedirectURLin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
encodeRedirectURLin classjakarta.servlet.http.HttpServletResponseWrapper
-
encodeRedirectUrl
- Specified by:
encodeRedirectUrlin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
encodeRedirectUrlin classjakarta.servlet.http.HttpServletResponseWrapper
-
finish
- Specified by:
finishin interfaceIExtendedResponse- Throws:
IOException
-
close
- Throws:
IOException
-
getOutputBuffer
- Throws:
IOException
-
getByteBufferList
- Throws:
IOException
-
getOutputBufferAsString
Get the output from the response outputstream as a String. This method should only be used to retrieve content that is known to be text based. Using this method to retrieve binary data will corrupt the response data.- Throws:
IOException
-
getHeaderNames
Retrieve the names of the header fields that have been set on this response.- Specified by:
getHeaderNamesin interfacejakarta.servlet.http.HttpServletResponse- Specified by:
getHeaderNamesin interfaceStoredResponseCompat<CollectionEnumerationHybrid<String>>- Overrides:
getHeaderNamesin classjakarta.servlet.http.HttpServletResponseWrapper
-
getAddedHeaderNames
Retrieve only the headers set in the include -
getHeader
Retrieve a response header field by name.- Specified by:
getHeaderin interfacejakarta.servlet.http.HttpServletResponse- Overrides:
getHeaderin classjakarta.servlet.http.HttpServletResponseWrapper
-
getIntHeader
Retrieve a response header as an int. -
getDateHeader
Retrieve a response header as a date. -
containsError
public boolean containsError()Returns true if sendError() was called on this response. -
getError
public com.ibm.websphere.servlet.error.ServletErrorReport getError() -
getErrorMessage
Returns the error message as reported by the sendError() method. -
getErrorStatusCode
public int getErrorStatusCode()Returns the status code as reported by the sendError() method. -
getStatusCode
public int getStatusCode()Returns the status code as specifed by the setStatus() method.- Specified by:
getStatusCodein interfaceIExtendedResponse- Specified by:
getStatusCodein interfaceServletResponseExtended
-
getStatusMessage
Returns the status message as reported by the setStatus() method. -
getRedirectURI
Returns the target URI of the redirect as specified by the sendRedirect() method. -
isRedirected
public boolean isRedirected()Returns true if sendRedirect() was called. -
getCharacterEncoding
Return the character encoding as specified in the charset flag of the content-type.- Specified by:
getCharacterEncodingin interfacejakarta.servlet.ServletResponse- Overrides:
getCharacterEncodingin classjakarta.servlet.ServletResponseWrapper
-
getContentType
- Specified by:
getContentTypein interfacejakarta.servlet.ServletResponse- Overrides:
getContentTypein classjakarta.servlet.ServletResponseWrapper
-
getCookies
public jakarta.servlet.http.Cookie[] getCookies()Return the cookies that were set using the addCookie() method. -
getLastModified
public long getLastModified()Returns the date that the data was last modifed in this response or -1 if unknown. This method returns the date value specified in the last-modified header. -
isExpired
public boolean isExpired()Return true if the data in this response has expired. This method is useful for caches to determine if the response is up-to-date or if if it should be cleared from the cache. This method returns false by default, subclasses should overload this method to provide their own expiration policies. -
transferResponse
Copy the contents of this response to another HttpServletResponse. This method is optimized to quickly transfer the contents of this response into another response. This method is useful when this response is cached to generate the same response later.- Throws:
IOException
-
resetBuffer
public void resetBuffer()Clears the content of the underlying buffer in the response without clearing headers or status code.- Specified by:
resetBufferin interfacejakarta.servlet.ServletResponse- Overrides:
resetBufferin classjakarta.servlet.ServletResponseWrapper- Since:
- 2.3
-
fireOutputStreamRetrievedEvent
public void fireOutputStreamRetrievedEvent(jakarta.servlet.ServletOutputStream sos) - Specified by:
fireOutputStreamRetrievedEventin interfaceIExtendedResponse
-
fireWriterRetrievedEvent
- Specified by:
fireWriterRetrievedEventin interfaceIExtendedResponse
-
registerOutputMethodListener
- Specified by:
registerOutputMethodListenerin interfaceIExtendedResponse
-
destroy
public void destroy()- Specified by:
destroyin interfaceIExtendedResponse
-
initForNextResponse
- Specified by:
initForNextResponsein interfaceIExtendedResponse
-
start
public void start()- Specified by:
startin interfaceIExtendedResponse
-
setInclude
public void setInclude(boolean isInclude) -
setInternalHeaderSettable
public void setInternalHeaderSettable(boolean internalHeaderSettable) -
buildResponseData
-
buildWriterData
-
alertClose
public void alertClose()- Specified by:
alertClosein interfacecom.ibm.wsspi.webcontainer.util.IOutputStreamObserver
-
alertException
public void alertException()- Specified by:
alertExceptionin interfacecom.ibm.wsspi.webcontainer.util.IOutputStreamObserver
-
alertFirstFlush
public void alertFirstFlush()- Specified by:
alertFirstFlushin interfacecom.ibm.wsspi.webcontainer.util.IOutputStreamObserver
-
alertFirstWrite
public void alertFirstWrite()- Specified by:
alertFirstWritein interfacecom.ibm.wsspi.webcontainer.util.IOutputStreamObserver
-
closeResponseOutput
public void closeResponseOutput(boolean b) - Specified by:
closeResponseOutputin interfaceIExtendedResponse
-
removeCookie
- Specified by:
removeCookiein interfaceIExtendedResponse
-
isOutputWritten
public boolean isOutputWritten()- Specified by:
isOutputWrittenin interfaceIExtendedResponse
-