Package com.ibm.websphere.servlet.response

Class StoredResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.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, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

Direct Known Subclasses:

ChainedResponse

public class StoredResponse
extends javax.servlet.http.HttpServletResponseWrapper
implements StoredResponseCompat<CollectionEnumerationHybrid<String>>, javax.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:

• Serialized Form

Field Summary

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
StoredResponse()
StoredResponse(boolean isInclude)
StoredResponse(ServletResponseExtended extResponse, boolean isInclude)

Method Summary

Modifier and Type	Method	Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
void	addSessionCookie(javax.servlet.http.Cookie cookie)
void	alertClose()
void	alertException()
void	alertFirstFlush()
void	alertFirstWrite()
void	buildResponseData(ServletResponseExtended response)
void	buildWriterData(ServletResponseExtended response)
void	close()
void	closeResponseOutput(boolean b)
boolean	containsError()	Returns true if sendError() was called on this response.
boolean	containsHeader(String name)
void	destroy()
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url)
String	encodeUrl(String url)
String	encodeURL(String url)
void	finish()
void	fireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos)
void	fireWriterRetrievedEvent(PrintWriter pw)
void	flushBuffer()
void	flushBuffer(boolean flushToWire)
Enumeration	getAddedHeaderNames()	Retrieve only the headers set in the include
int	getBufferSize()
List<com.ibm.wsspi.bytebuffer.WsByteBuffer>	getByteBufferList()
String	getCharacterEncoding()	Return the character encoding as specified in the charset flag of the content-type.
String	getContentType()
javax.servlet.http.Cookie[]	getCookies()	Return the cookies that were set using the addCookie() method.
long	getDateHeader(String name)	Retrieve a response header as a date.
com.ibm.websphere.servlet.error.ServletErrorReport	getError()
String	getErrorMessage()	Returns the error message as reported by the sendError() method.
int	getErrorStatusCode()	Returns the status code as reported by the sendError() method.
String	getHeader(String name)	Retrieve a response header field by name.
CollectionEnumerationHybrid<String>	getHeaderNames()	Retrieve the names of the header fields that have been set on this response.
Vector[]	getHeaderTable()
int	getIntHeader(String name)	Retrieve a response header as an int.
IResponse	getIResponse()
long	getLastModified()	Returns the date that the data was last modifed in this response or -1 if unknown.
Locale	getLocale()
byte[]	getOutputBuffer()
String	getOutputBufferAsString()	Get the output from the response outputstream as a String.
javax.servlet.ServletOutputStream	getOutputStream()
String	getRedirectURI()	Returns the target URI of the redirect as specified by the sendRedirect() method.
int	getStatusCode()	Returns the status code as specifed by the setStatus() method.
String	getStatusMessage()	Returns the status message as reported by the setStatus() method.
PrintWriter	getWriter()
void	initForNextResponse(IResponse res)
boolean	isCommitted()
boolean	isExpired()	Return true if the data in this response has expired.
boolean	isOutputWritten()
boolean	isRedirected()	Returns true if sendRedirect() was called.
boolean	outputStreamObtained()
void	registerOutputMethodListener(IOutputMethodListener listener)
void	removeCookie(String cookieName)
void	reset()
void	resetBuffer()	Clears the content of the underlying buffer in the response without clearing headers or status code.
void	sendError(int sc)
void	sendError(int sc, String message)
void	sendRedirect(String uri)
void	sendRedirect303(String uri)
void	setBufferSize(int size)
void	setCharacterEncoding(String encoding)
void	setContentLength(int len)
void	setContentType(String type)
void	setDateHeader(String name, long value)
void	setHeader(String name, String value)
void	setHeader(String name, String value, boolean checkInclude)
void	setInclude(boolean isInclude)
void	setInternalHeader(String name, String value)
void	setInternalHeaderSettable(boolean internalHeaderSettable)
void	setIntHeader(String name, int value)
void	setLocale(Locale loc)
void	setStatus(int sc)
void	setStatus(int sc, String message)
void	start()
void	transferResponse(javax.servlet.http.HttpServletResponse target)	Copy the contents of this response to another HttpServletResponse.
boolean	writerObtained()

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

getHeaders, getStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

getResponse, isWrapperFor, isWrapperFor, setResponse

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.http.HttpServletResponse

getHeaders, getStatus

Constructor Details

StoredResponse

public StoredResponse()

StoredResponse

public StoredResponse(boolean isInclude)

StoredResponse

public StoredResponse(ServletResponseExtended extResponse,
 boolean isInclude)

Method Details

writerObtained

public boolean writerObtained()

Specified by:

writerObtained in interface com.ibm.wsspi.webcontainer.util.IResponseOutput

outputStreamObtained

public boolean outputStreamObtained()

Specified by:

outputStreamObtained in interface com.ibm.wsspi.webcontainer.util.IResponseOutput

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

getIResponse

public IResponse getIResponse()

Specified by:

getIResponse in interface IExtendedResponse

Specified by:

getIResponse in interface ServletResponseExtended

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IllegalStateException,
IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

IllegalStateException

IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

setBufferSize

public void setBufferSize(int size)
                   throws IllegalStateException

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

Overrides:

setBufferSize in class javax.servlet.ServletResponseWrapper

Throws:

IllegalStateException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

Overrides:

getBufferSize in class javax.servlet.ServletResponseWrapper

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

IOException

flushBuffer

public void flushBuffer(boolean flushToWire)
                 throws IOException

Specified by:

flushBuffer in interface com.ibm.wsspi.webcontainer.util.IResponseOutput

Throws:

IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface com.ibm.wsspi.webcontainer.util.IResponseOutput

Specified by:

isCommitted in interface javax.servlet.ServletResponse

Overrides:

isCommitted in class javax.servlet.ServletResponseWrapper

reset

public void reset()
           throws IllegalStateException

Specified by:

reset in interface com.ibm.wsspi.webcontainer.util.IResponseOutput

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class javax.servlet.ServletResponseWrapper

Throws:

IllegalStateException

getHeaderTable

public Vector[] getHeaderTable()

Specified by:

getHeaderTable in interface IExtendedResponse

Specified by:

getHeaderTable in interface ServletResponseExtended

addSessionCookie

public void addSessionCookie(javax.servlet.http.Cookie cookie)

Specified by:

addSessionCookie in interface IExtendedResponse

Specified by:

addSessionCookie in interface ServletResponseExtended

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface javax.servlet.ServletResponse

Overrides:

setLocale in class javax.servlet.ServletResponseWrapper

setCharacterEncoding

public void setCharacterEncoding(String encoding)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

setCharacterEncoding in class javax.servlet.ServletResponseWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

Overrides:

getLocale in class javax.servlet.ServletResponseWrapper

addDateHeader

public void addDateHeader(String name,
 long date)

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

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

setInternalHeader

public void setInternalHeader(String name,
 String value)

Specified by:

setInternalHeader in interface IExtendedResponse

setHeader

public void setHeader(String name,
 String value,
 boolean checkInclude)

Specified by:

setHeader in interface IExtendedResponse

Specified by:

setHeader in interface ServletResponseExtended

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

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

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

containsHeader in class javax.servlet.http.HttpServletResponseWrapper

getWriter

public PrintWriter getWriter()
                      throws IOException,
IllegalStateException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

IOException

IllegalStateException

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int sc,
 String message)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

sendError

public void sendError(int sc)
               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 sc,
 String message)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeURL in class javax.servlet.http.HttpServletResponseWrapper

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeUrl in class javax.servlet.http.HttpServletResponseWrapper

sendRedirect

public void sendRedirect(String uri)
                  throws IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendRedirect303

public void sendRedirect303(String uri)
                     throws IOException

Specified by:

sendRedirect303 in interface IExtendedResponse

Throws:

IOException

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectURL in class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectUrl in class javax.servlet.http.HttpServletResponseWrapper

finish

public void finish()
            throws IOException

Specified by:

finish in interface IExtendedResponse

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

getOutputBuffer

public byte[] getOutputBuffer()
                       throws IOException

Throws:

IOException

getByteBufferList

public List<com.ibm.wsspi.bytebuffer.WsByteBuffer> getByteBufferList()
                                                              throws IOException

Throws:

IOException

getOutputBufferAsString

public String getOutputBufferAsString()
                               throws IOException

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

public CollectionEnumerationHybrid<String> getHeaderNames()

Retrieve the names of the header fields that have been set on this response.

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletResponse

Specified by:

getHeaderNames in interface StoredResponseCompat<CollectionEnumerationHybrid<String>>

Overrides:

getHeaderNames in class javax.servlet.http.HttpServletResponseWrapper

getAddedHeaderNames

public Enumeration getAddedHeaderNames()

Retrieve only the headers set in the include

getHeader

public String getHeader(String name)

Retrieve a response header field by name.

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

getHeader in class javax.servlet.http.HttpServletResponseWrapper

getIntHeader

public int getIntHeader(String name)

Retrieve a response header as an int.

getDateHeader

public long getDateHeader(String name)

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

public String 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:

getStatusCode in interface IExtendedResponse

Specified by:

getStatusCode in interface ServletResponseExtended

getStatusMessage

public String getStatusMessage()

Returns the status message as reported by the setStatus() method.

getRedirectURI

public String 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

public String getCharacterEncoding()

Return the character encoding as specified in the charset flag of the content-type.

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

getCookies

public javax.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

public void transferResponse(javax.servlet.http.HttpServletResponse target)
                      throws IOException

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:

resetBuffer in interface javax.servlet.ServletResponse

Overrides:

resetBuffer in class javax.servlet.ServletResponseWrapper

Since:

2.3

fireOutputStreamRetrievedEvent

public void fireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos)

Specified by:

fireOutputStreamRetrievedEvent in interface IExtendedResponse

fireWriterRetrievedEvent

public void fireWriterRetrievedEvent(PrintWriter pw)

Specified by:

fireWriterRetrievedEvent in interface IExtendedResponse

registerOutputMethodListener

public void registerOutputMethodListener(IOutputMethodListener listener)

Specified by:

registerOutputMethodListener in interface IExtendedResponse

destroy

public void destroy()

Specified by:

destroy in interface IExtendedResponse

initForNextResponse

public void initForNextResponse(IResponse res)

Specified by:

initForNextResponse in interface IExtendedResponse

start

public void start()

Specified by:

start in interface IExtendedResponse

setInclude

public void setInclude(boolean isInclude)

setInternalHeaderSettable

public void setInternalHeaderSettable(boolean internalHeaderSettable)

buildResponseData

public void buildResponseData(ServletResponseExtended response)

buildWriterData

public void buildWriterData(ServletResponseExtended response)

alertClose

public void alertClose()

Specified by:

alertClose in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver

alertException

public void alertException()

Specified by:

alertException in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver

alertFirstFlush

public void alertFirstFlush()

Specified by:

alertFirstFlush in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver

alertFirstWrite

public void alertFirstWrite()

Specified by:

alertFirstWrite in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver

closeResponseOutput

public void closeResponseOutput(boolean b)

Specified by:

closeResponseOutput in interface IExtendedResponse

removeCookie

public void removeCookie(String cookieName)

Specified by:

removeCookie in interface IExtendedResponse

isOutputWritten

public boolean isOutputWritten()

Specified by:

isOutputWritten in interface IExtendedResponse