Class StoredResponse
- java.lang.Object
- 
- javax.servlet.ServletResponseWrapper
- 
- javax.servlet.http.HttpServletResponseWrapper
- 
- com.ibm.websphere.servlet.response.StoredResponse
 
 
 
- 
- All Implemented Interfaces:
- StoredResponseCompat<CollectionEnumerationHybrid<java.lang.String>>,- IExtendedResponse,- ServletResponseExtended,- com.ibm.wsspi.webcontainer.util.IOutputStreamObserver,- com.ibm.wsspi.webcontainer.util.IResponseOutput,- java.io.Serializable,- javax.servlet.http.HttpServletResponse,- javax.servlet.ServletResponse
 - Direct Known Subclasses:
- ChainedResponse
 
 public class StoredResponse extends javax.servlet.http.HttpServletResponseWrapper implements StoredResponseCompat<CollectionEnumerationHybrid<java.lang.String>>, javax.servlet.http.HttpServletResponse, java.io.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:
- Serialized Form
 
- 
- 
Field Summary- 
Fields inherited from interface javax.servlet.http.HttpServletResponseSC_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 SummaryConstructors Constructor Description StoredResponse()StoredResponse(boolean isInclude)StoredResponse(ServletResponseExtended extResponse, boolean isInclude)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCookie(javax.servlet.http.Cookie cookie)voidaddDateHeader(java.lang.String name, long date)voidaddHeader(java.lang.String name, java.lang.String value)voidaddIntHeader(java.lang.String name, int value)voidaddSessionCookie(javax.servlet.http.Cookie cookie)voidalertClose()voidalertException()voidalertFirstFlush()voidalertFirstWrite()voidbuildResponseData(ServletResponseExtended response)voidbuildWriterData(ServletResponseExtended response)voidclose()voidcloseResponseOutput(boolean b)booleancontainsError()Returns true if sendError() was called on this response.booleancontainsHeader(java.lang.String name)voiddestroy()java.lang.StringencodeRedirectUrl(java.lang.String url)java.lang.StringencodeRedirectURL(java.lang.String url)java.lang.StringencodeUrl(java.lang.String url)java.lang.StringencodeURL(java.lang.String url)voidfinish()voidfireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos)voidfireWriterRetrievedEvent(java.io.PrintWriter pw)voidflushBuffer()voidflushBuffer(boolean flushToWire)java.util.EnumerationgetAddedHeaderNames()Retrieve only the headers set in the includeintgetBufferSize()java.util.List<com.ibm.wsspi.bytebuffer.WsByteBuffer>getByteBufferList()java.lang.StringgetCharacterEncoding()Return the character encoding as specified in the charset flag of the content-type.java.lang.StringgetContentType()javax.servlet.http.Cookie[]getCookies()Return the cookies that were set using the addCookie() method.longgetDateHeader(java.lang.String name)Retrieve a response header as a date.com.ibm.websphere.servlet.error.ServletErrorReportgetError()java.lang.StringgetErrorMessage()Returns the error message as reported by the sendError() method.intgetErrorStatusCode()Returns the status code as reported by the sendError() method.java.lang.StringgetHeader(java.lang.String name)Retrieve a response header field by name.CollectionEnumerationHybrid<java.lang.String>getHeaderNames()Retrieve the names of the header fields that have been set on this response.java.util.Vector[]getHeaderTable()intgetIntHeader(java.lang.String name)Retrieve a response header as an int.IResponsegetIResponse()longgetLastModified()Returns the date that the data was last modifed in this response or -1 if unknown.java.util.LocalegetLocale()byte[]getOutputBuffer()java.lang.StringgetOutputBufferAsString()Get the output from the response outputstream as a String.javax.servlet.ServletOutputStreamgetOutputStream()java.lang.StringgetRedirectURI()Returns the target URI of the redirect as specified by the sendRedirect() method.intgetStatusCode()Returns the status code as specifed by the setStatus() method.java.lang.StringgetStatusMessage()Returns the status message as reported by the setStatus() method.java.io.PrintWritergetWriter()voidinitForNextResponse(IResponse res)booleanisCommitted()booleanisExpired()Return true if the data in this response has expired.booleanisOutputWritten()booleanisRedirected()Returns true if sendRedirect() was called.booleanoutputStreamObtained()voidregisterOutputMethodListener(IOutputMethodListener listener)voidremoveCookie(java.lang.String cookieName)voidreset()voidresetBuffer()Clears the content of the underlying buffer in the response without clearing headers or status code.voidsendError(int sc)voidsendError(int sc, java.lang.String message)voidsendRedirect(java.lang.String uri)voidsendRedirect303(java.lang.String uri)voidsetBufferSize(int size)voidsetCharacterEncoding(java.lang.String encoding)voidsetContentLength(int len)voidsetContentType(java.lang.String type)voidsetDateHeader(java.lang.String name, long value)voidsetHeader(java.lang.String name, java.lang.String value)voidsetHeader(java.lang.String name, java.lang.String value, boolean checkInclude)voidsetInclude(boolean isInclude)voidsetInternalHeader(java.lang.String name, java.lang.String value)voidsetInternalHeaderSettable(boolean internalHeaderSettable)voidsetIntHeader(java.lang.String name, int value)voidsetLocale(java.util.Locale loc)voidsetStatus(int sc)voidsetStatus(int sc, java.lang.String message)voidstart()voidtransferResponse(javax.servlet.http.HttpServletResponse target)Copy the contents of this response to another HttpServletResponse.booleanwriterObtained()- 
Methods inherited from class javax.servlet.ServletResponseWrappergetResponse, isWrapperFor, isWrapperFor, setResponse
 
- 
 
- 
- 
- 
Constructor Detail- 
StoredResponsepublic StoredResponse() 
 - 
StoredResponsepublic StoredResponse(boolean isInclude) 
 - 
StoredResponsepublic StoredResponse(ServletResponseExtended extResponse, boolean isInclude) 
 
- 
 - 
Method Detail- 
writerObtainedpublic boolean writerObtained() - Specified by:
- writerObtainedin interface- com.ibm.wsspi.webcontainer.util.IResponseOutput
 
 - 
outputStreamObtainedpublic boolean outputStreamObtained() - Specified by:
- outputStreamObtainedin interface- com.ibm.wsspi.webcontainer.util.IResponseOutput
 
 - 
addCookiepublic void addCookie(javax.servlet.http.Cookie cookie) - Specified by:
- addCookiein interface- javax.servlet.http.HttpServletResponse
- Overrides:
- addCookiein class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
getIResponsepublic IResponse getIResponse() - Specified by:
- getIResponsein interface- IExtendedResponse
- Specified by:
- getIResponsein interface- ServletResponseExtended
 
 - 
getOutputStreampublic javax.servlet.ServletOutputStream getOutputStream() throws java.lang.IllegalStateException, java.io.IOException- Specified by:
- getOutputStreamin interface- javax.servlet.ServletResponse
- Overrides:
- getOutputStreamin class- javax.servlet.ServletResponseWrapper
- Throws:
- java.lang.IllegalStateException
- java.io.IOException
 
 - 
setContentLengthpublic void setContentLength(int len) - Specified by:
- setContentLengthin interface- javax.servlet.ServletResponse
- Overrides:
- setContentLengthin class- javax.servlet.ServletResponseWrapper
 
 - 
setContentTypepublic void setContentType(java.lang.String type) - Specified by:
- setContentTypein interface- javax.servlet.ServletResponse
- Overrides:
- setContentTypein class- javax.servlet.ServletResponseWrapper
 
 - 
setBufferSizepublic void setBufferSize(int size) throws java.lang.IllegalStateException- Specified by:
- setBufferSizein interface- javax.servlet.ServletResponse
- Overrides:
- setBufferSizein class- javax.servlet.ServletResponseWrapper
- Throws:
- java.lang.IllegalStateException
 
 - 
getBufferSizepublic int getBufferSize() - Specified by:
- getBufferSizein interface- javax.servlet.ServletResponse
- Overrides:
- getBufferSizein class- javax.servlet.ServletResponseWrapper
 
 - 
flushBufferpublic void flushBuffer() throws java.io.IOException- Specified by:
- flushBufferin interface- javax.servlet.ServletResponse
- Overrides:
- flushBufferin class- javax.servlet.ServletResponseWrapper
- Throws:
- java.io.IOException
 
 - 
flushBufferpublic void flushBuffer(boolean flushToWire) throws java.io.IOException- Specified by:
- flushBufferin interface- com.ibm.wsspi.webcontainer.util.IResponseOutput
- Throws:
- java.io.IOException
 
 - 
isCommittedpublic boolean isCommitted() - Specified by:
- isCommittedin interface- com.ibm.wsspi.webcontainer.util.IResponseOutput
- Specified by:
- isCommittedin interface- javax.servlet.ServletResponse
- Overrides:
- isCommittedin class- javax.servlet.ServletResponseWrapper
 
 - 
resetpublic void reset() throws java.lang.IllegalStateException- Specified by:
- resetin interface- com.ibm.wsspi.webcontainer.util.IResponseOutput
- Specified by:
- resetin interface- javax.servlet.ServletResponse
- Overrides:
- resetin class- javax.servlet.ServletResponseWrapper
- Throws:
- java.lang.IllegalStateException
 
 - 
getHeaderTablepublic java.util.Vector[] getHeaderTable() - Specified by:
- getHeaderTablein interface- IExtendedResponse
- Specified by:
- getHeaderTablein interface- ServletResponseExtended
 
 - 
addSessionCookiepublic void addSessionCookie(javax.servlet.http.Cookie cookie) - Specified by:
- addSessionCookiein interface- IExtendedResponse
- Specified by:
- addSessionCookiein interface- ServletResponseExtended
 
 - 
setLocalepublic void setLocale(java.util.Locale loc) - Specified by:
- setLocalein interface- javax.servlet.ServletResponse
- Overrides:
- setLocalein class- javax.servlet.ServletResponseWrapper
 
 - 
setCharacterEncodingpublic void setCharacterEncoding(java.lang.String encoding) - Specified by:
- setCharacterEncodingin interface- javax.servlet.ServletResponse
- Overrides:
- setCharacterEncodingin class- javax.servlet.ServletResponseWrapper
 
 - 
getLocalepublic java.util.Locale getLocale() - Specified by:
- getLocalein interface- javax.servlet.ServletResponse
- Overrides:
- getLocalein class- javax.servlet.ServletResponseWrapper
 
 - 
addDateHeaderpublic void addDateHeader(java.lang.String name, long date)- Specified by:
- addDateHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- addDateHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
addHeaderpublic void addHeader(java.lang.String name, java.lang.String value)- Specified by:
- addHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- addHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
addIntHeaderpublic void addIntHeader(java.lang.String name, int value)- Specified by:
- addIntHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- addIntHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
setHeaderpublic void setHeader(java.lang.String name, java.lang.String value)- Specified by:
- setHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- setHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
setInternalHeaderpublic void setInternalHeader(java.lang.String name, java.lang.String value)- Specified by:
- setInternalHeaderin interface- IExtendedResponse
 
 - 
setHeaderpublic void setHeader(java.lang.String name, java.lang.String value, boolean checkInclude)- Specified by:
- setHeaderin interface- IExtendedResponse
- Specified by:
- setHeaderin interface- ServletResponseExtended
 
 - 
setIntHeaderpublic void setIntHeader(java.lang.String name, int value)- Specified by:
- setIntHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- setIntHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
setDateHeaderpublic void setDateHeader(java.lang.String name, long value)- Specified by:
- setDateHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- setDateHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
containsHeaderpublic boolean containsHeader(java.lang.String name) - Specified by:
- containsHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- containsHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
getWriterpublic java.io.PrintWriter getWriter() throws java.io.IOException, java.lang.IllegalStateException- Specified by:
- getWriterin interface- javax.servlet.ServletResponse
- Overrides:
- getWriterin class- javax.servlet.ServletResponseWrapper
- Throws:
- java.io.IOException
- java.lang.IllegalStateException
 
 - 
setStatuspublic void setStatus(int sc) - Specified by:
- setStatusin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- setStatusin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
setStatuspublic void setStatus(int sc, java.lang.String message)- Specified by:
- setStatusin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- setStatusin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
sendErrorpublic void sendError(int sc) throws java.io.IOException- Specified by:
- sendErrorin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- sendErrorin class- javax.servlet.http.HttpServletResponseWrapper
- Throws:
- java.io.IOException
 
 - 
sendErrorpublic void sendError(int sc, java.lang.String message) throws java.io.IOException- Specified by:
- sendErrorin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- sendErrorin class- javax.servlet.http.HttpServletResponseWrapper
- Throws:
- java.io.IOException
 
 - 
encodeURLpublic java.lang.String encodeURL(java.lang.String url) - Specified by:
- encodeURLin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- encodeURLin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
encodeUrlpublic java.lang.String encodeUrl(java.lang.String url) - Specified by:
- encodeUrlin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- encodeUrlin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
sendRedirectpublic void sendRedirect(java.lang.String uri) throws java.io.IOException- Specified by:
- sendRedirectin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- sendRedirectin class- javax.servlet.http.HttpServletResponseWrapper
- Throws:
- java.io.IOException
 
 - 
sendRedirect303public void sendRedirect303(java.lang.String uri) throws java.io.IOException- Specified by:
- sendRedirect303in interface- IExtendedResponse
- Throws:
- java.io.IOException
 
 - 
encodeRedirectURLpublic java.lang.String encodeRedirectURL(java.lang.String url) - Specified by:
- encodeRedirectURLin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- encodeRedirectURLin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
encodeRedirectUrlpublic java.lang.String encodeRedirectUrl(java.lang.String url) - Specified by:
- encodeRedirectUrlin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- encodeRedirectUrlin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
finishpublic void finish() throws java.io.IOException- Specified by:
- finishin interface- IExtendedResponse
- Throws:
- java.io.IOException
 
 - 
closepublic void close() throws java.io.IOException- Throws:
- java.io.IOException
 
 - 
getOutputBufferpublic byte[] getOutputBuffer() throws java.io.IOException- Throws:
- java.io.IOException
 
 - 
getByteBufferListpublic java.util.List<com.ibm.wsspi.bytebuffer.WsByteBuffer> getByteBufferList() throws java.io.IOException- Throws:
- java.io.IOException
 
 - 
getOutputBufferAsStringpublic java.lang.String getOutputBufferAsString() throws java.io.IOExceptionGet 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:
- java.io.IOException
 
 - 
getHeaderNamespublic CollectionEnumerationHybrid<java.lang.String> getHeaderNames() Retrieve the names of the header fields that have been set on this response.- Specified by:
- getHeaderNamesin interface- javax.servlet.http.HttpServletResponse
- Specified by:
- getHeaderNamesin interface- StoredResponseCompat<CollectionEnumerationHybrid<java.lang.String>>
- Overrides:
- getHeaderNamesin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
getAddedHeaderNamespublic java.util.Enumeration getAddedHeaderNames() Retrieve only the headers set in the include
 - 
getHeaderpublic java.lang.String getHeader(java.lang.String name) Retrieve a response header field by name.- Specified by:
- getHeaderin interface- javax.servlet.http.HttpServletResponse
- Overrides:
- getHeaderin class- javax.servlet.http.HttpServletResponseWrapper
 
 - 
getIntHeaderpublic int getIntHeader(java.lang.String name) Retrieve a response header as an int.
 - 
getDateHeaderpublic long getDateHeader(java.lang.String name) Retrieve a response header as a date.
 - 
containsErrorpublic boolean containsError() Returns true if sendError() was called on this response.
 - 
getErrorpublic com.ibm.websphere.servlet.error.ServletErrorReport getError() 
 - 
getErrorMessagepublic java.lang.String getErrorMessage() Returns the error message as reported by the sendError() method.
 - 
getErrorStatusCodepublic int getErrorStatusCode() Returns the status code as reported by the sendError() method.
 - 
getStatusCodepublic int getStatusCode() Returns the status code as specifed by the setStatus() method.- Specified by:
- getStatusCodein interface- IExtendedResponse
- Specified by:
- getStatusCodein interface- ServletResponseExtended
 
 - 
getStatusMessagepublic java.lang.String getStatusMessage() Returns the status message as reported by the setStatus() method.
 - 
getRedirectURIpublic java.lang.String getRedirectURI() Returns the target URI of the redirect as specified by the sendRedirect() method.
 - 
isRedirectedpublic boolean isRedirected() Returns true if sendRedirect() was called.
 - 
getCharacterEncodingpublic java.lang.String getCharacterEncoding() Return the character encoding as specified in the charset flag of the content-type.- Specified by:
- getCharacterEncodingin interface- javax.servlet.ServletResponse
- Overrides:
- getCharacterEncodingin class- javax.servlet.ServletResponseWrapper
 
 - 
getContentTypepublic java.lang.String getContentType() - Specified by:
- getContentTypein interface- javax.servlet.ServletResponse
- Overrides:
- getContentTypein class- javax.servlet.ServletResponseWrapper
 
 - 
getCookiespublic javax.servlet.http.Cookie[] getCookies() Return the cookies that were set using the addCookie() method.
 - 
getLastModifiedpublic 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.
 - 
isExpiredpublic 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.
 - 
transferResponsepublic void transferResponse(javax.servlet.http.HttpServletResponse target) throws java.io.IOExceptionCopy 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:
- java.io.IOException
 
 - 
resetBufferpublic void resetBuffer() Clears the content of the underlying buffer in the response without clearing headers or status code.- Specified by:
- resetBufferin interface- javax.servlet.ServletResponse
- Overrides:
- resetBufferin class- javax.servlet.ServletResponseWrapper
- Since:
- 2.3
 
 - 
fireOutputStreamRetrievedEventpublic void fireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos) - Specified by:
- fireOutputStreamRetrievedEventin interface- IExtendedResponse
 
 - 
fireWriterRetrievedEventpublic void fireWriterRetrievedEvent(java.io.PrintWriter pw) - Specified by:
- fireWriterRetrievedEventin interface- IExtendedResponse
 
 - 
registerOutputMethodListenerpublic void registerOutputMethodListener(IOutputMethodListener listener) - Specified by:
- registerOutputMethodListenerin interface- IExtendedResponse
 
 - 
destroypublic void destroy() - Specified by:
- destroyin interface- IExtendedResponse
 
 - 
initForNextResponsepublic void initForNextResponse(IResponse res) - Specified by:
- initForNextResponsein interface- IExtendedResponse
 
 - 
startpublic void start() - Specified by:
- startin interface- IExtendedResponse
 
 - 
setIncludepublic void setInclude(boolean isInclude) 
 - 
setInternalHeaderSettablepublic void setInternalHeaderSettable(boolean internalHeaderSettable) 
 - 
buildResponseDatapublic void buildResponseData(ServletResponseExtended response) 
 - 
buildWriterDatapublic void buildWriterData(ServletResponseExtended response) 
 - 
alertClosepublic void alertClose() - Specified by:
- alertClosein interface- com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
 
 - 
alertExceptionpublic void alertException() - Specified by:
- alertExceptionin interface- com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
 
 - 
alertFirstFlushpublic void alertFirstFlush() - Specified by:
- alertFirstFlushin interface- com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
 
 - 
alertFirstWritepublic void alertFirstWrite() - Specified by:
- alertFirstWritein interface- com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
 
 - 
closeResponseOutputpublic void closeResponseOutput(boolean b) - Specified by:
- closeResponseOutputin interface- IExtendedResponse
 
 - 
removeCookiepublic void removeCookie(java.lang.String cookieName) - Specified by:
- removeCookiein interface- IExtendedResponse
 
 - 
isOutputWrittenpublic boolean isOutputWritten() - Specified by:
- isOutputWrittenin interface- IExtendedResponse
 
 
- 
 
-