public class StoredResponse
extends javax.servlet.http.HttpServletResponseWrapper
implements com.ibm.websphere.servlet.response.StoredResponseCompat, javax.servlet.http.HttpServletResponse, java.io.Serializable, com.ibm.wsspi.webcontainer.util.IResponseOutput, com.ibm.wsspi.webcontainer.servlet.IExtendedResponse, com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
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 and Description |
|---|
StoredResponse() |
StoredResponse(boolean isInclude) |
StoredResponse(com.ibm.wsspi.webcontainer.servlet.IExtendedResponse extResponse,
boolean isInclude) |
| Modifier and Type | Method and Description |
|---|---|
void |
addCookie(javax.servlet.http.Cookie cookie) |
void |
addDateHeader(java.lang.String name,
long date) |
void |
addHeader(java.lang.String name,
java.lang.String value) |
void |
addIntHeader(java.lang.String name,
int value) |
void |
addSessionCookie(javax.servlet.http.Cookie cookie) |
void |
alertClose() |
void |
alertException() |
void |
alertFirstFlush() |
void |
alertFirstWrite() |
void |
buildResponseData(com.ibm.wsspi.webcontainer.servlet.IExtendedResponse response) |
void |
buildWriterData(com.ibm.wsspi.webcontainer.servlet.IExtendedResponse response) |
void |
close() |
void |
closeResponseOutput(boolean b) |
boolean |
containsError()
Returns true if sendError() was called on this response.
|
boolean |
containsHeader(java.lang.String name) |
void |
destroy() |
java.lang.String |
encodeRedirectUrl(java.lang.String url) |
java.lang.String |
encodeRedirectURL(java.lang.String url) |
java.lang.String |
encodeUrl(java.lang.String url) |
java.lang.String |
encodeURL(java.lang.String url) |
void |
finish() |
void |
fireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos) |
void |
fireWriterRetrievedEvent(java.io.PrintWriter pw) |
void |
flushBuffer() |
void |
flushBuffer(boolean flushToWire) |
java.util.Enumeration |
getAddedHeaderNames()
Retrieve only the headers set in the include
|
int |
getBufferSize() |
java.util.List<com.ibm.wsspi.bytebuffer.WsByteBuffer> |
getByteBufferList() |
java.lang.String |
getCharacterEncoding()
Return the character encoding as specified in the charset flag of the
content-type.
|
java.lang.String |
getContentType() |
javax.servlet.http.Cookie[] |
getCookies()
Return the cookies that were set using the addCookie() method.
|
long |
getDateHeader(java.lang.String name)
Retrieve a response header as a date.
|
com.ibm.websphere.servlet.error.ServletErrorReport |
getError() |
java.lang.String |
getErrorMessage()
Returns the error message as reported by the sendError() method.
|
int |
getErrorStatusCode()
Returns the status code as reported by the sendError() method.
|
java.lang.String |
getHeader(java.lang.String name)
Retrieve a response header field by name.
|
com.ibm.websphere.servlet.response.CollectionEnumerationHybrid<java.lang.String> |
getHeaderNames()
Retrieve the names of the header fields that have been set on this
response.
|
java.util.Vector[] |
getHeaderTable() |
int |
getIntHeader(java.lang.String name)
Retrieve a response header as an int.
|
com.ibm.websphere.servlet.response.IResponse |
getIResponse() |
long |
getLastModified()
Returns the date that the data was last modifed in this response or -1 if
unknown.
|
java.util.Locale |
getLocale() |
byte[] |
getOutputBuffer() |
java.lang.String |
getOutputBufferAsString()
Get the output from the response outputstream as a String.
|
javax.servlet.ServletOutputStream |
getOutputStream() |
java.lang.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.
|
java.lang.String |
getStatusMessage()
Returns the status message as reported by the setStatus() method.
|
java.io.PrintWriter |
getWriter() |
void |
initForNextResponse(com.ibm.websphere.servlet.response.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(com.ibm.wsspi.webcontainer.servlet.IOutputMethodListener listener) |
void |
removeCookie(java.lang.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,
java.lang.String message) |
void |
sendRedirect(java.lang.String uri) |
void |
sendRedirect303(java.lang.String uri) |
void |
setBufferSize(int size) |
void |
setCharacterEncoding(java.lang.String encoding) |
void |
setContentLength(int len) |
void |
setContentType(java.lang.String type) |
void |
setDateHeader(java.lang.String name,
long value) |
void |
setHeader(java.lang.String name,
java.lang.String value) |
void |
setHeader(java.lang.String name,
java.lang.String value,
boolean checkInclude) |
void |
setInclude(boolean isInclude) |
void |
setInternalHeader(java.lang.String name,
java.lang.String value) |
void |
setInternalHeaderSettable(boolean internalHeaderSettable) |
void |
setIntHeader(java.lang.String name,
int value) |
void |
setLocale(java.util.Locale loc) |
void |
setStatus(int sc) |
void |
setStatus(int sc,
java.lang.String message) |
void |
start() |
void |
transferResponse(javax.servlet.http.HttpServletResponse target)
Copy the contents of this response to another HttpServletResponse.
|
boolean |
writerObtained() |
getResponse, isWrapperFor, isWrapperFor, setResponsepublic StoredResponse()
public StoredResponse(boolean isInclude)
public StoredResponse(com.ibm.wsspi.webcontainer.servlet.IExtendedResponse extResponse,
boolean isInclude)
public boolean writerObtained()
writerObtained in interface com.ibm.wsspi.webcontainer.util.IResponseOutputpublic boolean outputStreamObtained()
outputStreamObtained in interface com.ibm.wsspi.webcontainer.util.IResponseOutputpublic void addCookie(javax.servlet.http.Cookie cookie)
addCookie in interface javax.servlet.http.HttpServletResponseaddCookie in class javax.servlet.http.HttpServletResponseWrapperpublic com.ibm.websphere.servlet.response.IResponse getIResponse()
getIResponse in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic javax.servlet.ServletOutputStream getOutputStream()
throws java.lang.IllegalStateException,
java.io.IOException
getOutputStream in interface javax.servlet.ServletResponsegetOutputStream in class javax.servlet.ServletResponseWrapperjava.lang.IllegalStateExceptionjava.io.IOExceptionpublic void setContentLength(int len)
setContentLength in interface javax.servlet.ServletResponsesetContentLength in class javax.servlet.ServletResponseWrapperpublic void setContentType(java.lang.String type)
setContentType in interface javax.servlet.ServletResponsesetContentType in class javax.servlet.ServletResponseWrapperpublic void setBufferSize(int size)
throws java.lang.IllegalStateException
setBufferSize in interface javax.servlet.ServletResponsesetBufferSize in class javax.servlet.ServletResponseWrapperjava.lang.IllegalStateExceptionpublic int getBufferSize()
getBufferSize in interface javax.servlet.ServletResponsegetBufferSize in class javax.servlet.ServletResponseWrapperpublic void flushBuffer()
throws java.io.IOException
flushBuffer in interface javax.servlet.ServletResponseflushBuffer in class javax.servlet.ServletResponseWrapperjava.io.IOExceptionpublic void flushBuffer(boolean flushToWire)
throws java.io.IOException
flushBuffer in interface com.ibm.wsspi.webcontainer.util.IResponseOutputjava.io.IOExceptionpublic boolean isCommitted()
isCommitted in interface com.ibm.wsspi.webcontainer.util.IResponseOutputisCommitted in interface javax.servlet.ServletResponseisCommitted in class javax.servlet.ServletResponseWrapperpublic void reset()
throws java.lang.IllegalStateException
reset in interface com.ibm.wsspi.webcontainer.util.IResponseOutputreset in interface javax.servlet.ServletResponsereset in class javax.servlet.ServletResponseWrapperjava.lang.IllegalStateExceptionpublic java.util.Vector[] getHeaderTable()
getHeaderTable in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void addSessionCookie(javax.servlet.http.Cookie cookie)
addSessionCookie in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void setLocale(java.util.Locale loc)
setLocale in interface javax.servlet.ServletResponsesetLocale in class javax.servlet.ServletResponseWrapperpublic void setCharacterEncoding(java.lang.String encoding)
setCharacterEncoding in interface javax.servlet.ServletResponsesetCharacterEncoding in class javax.servlet.ServletResponseWrapperpublic java.util.Locale getLocale()
getLocale in interface javax.servlet.ServletResponsegetLocale in class javax.servlet.ServletResponseWrapperpublic void addDateHeader(java.lang.String name,
long date)
addDateHeader in interface javax.servlet.http.HttpServletResponseaddDateHeader in class javax.servlet.http.HttpServletResponseWrapperpublic void addHeader(java.lang.String name,
java.lang.String value)
addHeader in interface javax.servlet.http.HttpServletResponseaddHeader in class javax.servlet.http.HttpServletResponseWrapperpublic void addIntHeader(java.lang.String name,
int value)
addIntHeader in interface javax.servlet.http.HttpServletResponseaddIntHeader in class javax.servlet.http.HttpServletResponseWrapperpublic void setHeader(java.lang.String name,
java.lang.String value)
setHeader in interface javax.servlet.http.HttpServletResponsesetHeader in class javax.servlet.http.HttpServletResponseWrapperpublic void setInternalHeader(java.lang.String name,
java.lang.String value)
setInternalHeader in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void setHeader(java.lang.String name,
java.lang.String value,
boolean checkInclude)
setHeader in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void setIntHeader(java.lang.String name,
int value)
setIntHeader in interface javax.servlet.http.HttpServletResponsesetIntHeader in class javax.servlet.http.HttpServletResponseWrapperpublic void setDateHeader(java.lang.String name,
long value)
setDateHeader in interface javax.servlet.http.HttpServletResponsesetDateHeader in class javax.servlet.http.HttpServletResponseWrapperpublic boolean containsHeader(java.lang.String name)
containsHeader in interface javax.servlet.http.HttpServletResponsecontainsHeader in class javax.servlet.http.HttpServletResponseWrapperpublic java.io.PrintWriter getWriter()
throws java.io.IOException,
java.lang.IllegalStateException
getWriter in interface javax.servlet.ServletResponsegetWriter in class javax.servlet.ServletResponseWrapperjava.io.IOExceptionjava.lang.IllegalStateExceptionpublic void setStatus(int sc)
setStatus in interface javax.servlet.http.HttpServletResponsesetStatus in class javax.servlet.http.HttpServletResponseWrapperpublic void setStatus(int sc,
java.lang.String message)
setStatus in interface javax.servlet.http.HttpServletResponsesetStatus in class javax.servlet.http.HttpServletResponseWrapperpublic void sendError(int sc)
throws java.io.IOException
sendError in interface javax.servlet.http.HttpServletResponsesendError in class javax.servlet.http.HttpServletResponseWrapperjava.io.IOExceptionpublic void sendError(int sc,
java.lang.String message)
throws java.io.IOException
sendError in interface javax.servlet.http.HttpServletResponsesendError in class javax.servlet.http.HttpServletResponseWrapperjava.io.IOExceptionpublic java.lang.String encodeURL(java.lang.String url)
encodeURL in interface javax.servlet.http.HttpServletResponseencodeURL in class javax.servlet.http.HttpServletResponseWrapperpublic java.lang.String encodeUrl(java.lang.String url)
encodeUrl in interface javax.servlet.http.HttpServletResponseencodeUrl in class javax.servlet.http.HttpServletResponseWrapperpublic void sendRedirect(java.lang.String uri)
throws java.io.IOException
sendRedirect in interface javax.servlet.http.HttpServletResponsesendRedirect in class javax.servlet.http.HttpServletResponseWrapperjava.io.IOExceptionpublic void sendRedirect303(java.lang.String uri)
throws java.io.IOException
sendRedirect303 in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsejava.io.IOExceptionpublic java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL in interface javax.servlet.http.HttpServletResponseencodeRedirectURL in class javax.servlet.http.HttpServletResponseWrapperpublic java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponseencodeRedirectUrl in class javax.servlet.http.HttpServletResponseWrapperpublic void finish()
throws java.io.IOException
finish in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsejava.io.IOExceptionpublic void close()
throws java.io.IOException
java.io.IOExceptionpublic byte[] getOutputBuffer()
throws java.io.IOException
java.io.IOExceptionpublic java.util.List<com.ibm.wsspi.bytebuffer.WsByteBuffer> getByteBufferList()
throws java.io.IOException
java.io.IOExceptionpublic java.lang.String getOutputBufferAsString()
throws java.io.IOException
java.io.IOExceptionpublic com.ibm.websphere.servlet.response.CollectionEnumerationHybrid<java.lang.String> getHeaderNames()
getHeaderNames in interface com.ibm.websphere.servlet.response.StoredResponseCompatgetHeaderNames in interface javax.servlet.http.HttpServletResponsegetHeaderNames in class javax.servlet.http.HttpServletResponseWrapperpublic java.util.Enumeration getAddedHeaderNames()
public java.lang.String getHeader(java.lang.String name)
getHeader in interface javax.servlet.http.HttpServletResponsegetHeader in class javax.servlet.http.HttpServletResponseWrapperpublic int getIntHeader(java.lang.String name)
public long getDateHeader(java.lang.String name)
public boolean containsError()
public com.ibm.websphere.servlet.error.ServletErrorReport getError()
public java.lang.String getErrorMessage()
public int getErrorStatusCode()
public int getStatusCode()
getStatusCode in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic java.lang.String getStatusMessage()
public java.lang.String getRedirectURI()
public boolean isRedirected()
public java.lang.String getCharacterEncoding()
getCharacterEncoding in interface javax.servlet.ServletResponsegetCharacterEncoding in class javax.servlet.ServletResponseWrapperpublic java.lang.String getContentType()
getContentType in interface javax.servlet.ServletResponsegetContentType in class javax.servlet.ServletResponseWrapperpublic javax.servlet.http.Cookie[] getCookies()
public long getLastModified()
public boolean isExpired()
public void transferResponse(javax.servlet.http.HttpServletResponse target)
throws java.io.IOException
java.io.IOExceptionpublic void resetBuffer()
resetBuffer in interface javax.servlet.ServletResponseresetBuffer in class javax.servlet.ServletResponseWrapperpublic void fireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos)
fireOutputStreamRetrievedEvent in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void fireWriterRetrievedEvent(java.io.PrintWriter pw)
fireWriterRetrievedEvent in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void registerOutputMethodListener(com.ibm.wsspi.webcontainer.servlet.IOutputMethodListener listener)
registerOutputMethodListener in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void destroy()
destroy in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void initForNextResponse(com.ibm.websphere.servlet.response.IResponse res)
initForNextResponse in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void start()
start in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void setInclude(boolean isInclude)
public void setInternalHeaderSettable(boolean internalHeaderSettable)
public void buildResponseData(com.ibm.wsspi.webcontainer.servlet.IExtendedResponse response)
public void buildWriterData(com.ibm.wsspi.webcontainer.servlet.IExtendedResponse response)
public void alertClose()
alertClose in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserverpublic void alertException()
alertException in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserverpublic void alertFirstFlush()
alertFirstFlush in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserverpublic void alertFirstWrite()
alertFirstWrite in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserverpublic void closeResponseOutput(boolean b)
closeResponseOutput in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic void removeCookie(java.lang.String cookieName)
removeCookie in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponsepublic boolean isOutputWritten()
isOutputWritten in interface com.ibm.wsspi.webcontainer.servlet.IExtendedResponse