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
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(ServletResponseExtended 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(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(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.
|
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.
|
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(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(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, setResponse
public StoredResponse()
public StoredResponse(boolean isInclude)
public StoredResponse(ServletResponseExtended extResponse, boolean isInclude)
public boolean writerObtained()
writerObtained
in interface com.ibm.wsspi.webcontainer.util.IResponseOutput
public boolean outputStreamObtained()
outputStreamObtained
in interface com.ibm.wsspi.webcontainer.util.IResponseOutput
public void addCookie(javax.servlet.http.Cookie cookie)
addCookie
in interface javax.servlet.http.HttpServletResponse
addCookie
in class javax.servlet.http.HttpServletResponseWrapper
public IResponse getIResponse()
getIResponse
in interface IExtendedResponse
getIResponse
in interface ServletResponseExtended
public javax.servlet.ServletOutputStream getOutputStream() throws java.lang.IllegalStateException, java.io.IOException
getOutputStream
in interface javax.servlet.ServletResponse
getOutputStream
in class javax.servlet.ServletResponseWrapper
java.lang.IllegalStateException
java.io.IOException
public void setContentLength(int len)
setContentLength
in interface javax.servlet.ServletResponse
setContentLength
in class javax.servlet.ServletResponseWrapper
public void setContentType(java.lang.String type)
setContentType
in interface javax.servlet.ServletResponse
setContentType
in class javax.servlet.ServletResponseWrapper
public void setBufferSize(int size) throws java.lang.IllegalStateException
setBufferSize
in interface javax.servlet.ServletResponse
setBufferSize
in class javax.servlet.ServletResponseWrapper
java.lang.IllegalStateException
public int getBufferSize()
getBufferSize
in interface javax.servlet.ServletResponse
getBufferSize
in class javax.servlet.ServletResponseWrapper
public void flushBuffer() throws java.io.IOException
flushBuffer
in interface javax.servlet.ServletResponse
flushBuffer
in class javax.servlet.ServletResponseWrapper
java.io.IOException
public void flushBuffer(boolean flushToWire) throws java.io.IOException
flushBuffer
in interface com.ibm.wsspi.webcontainer.util.IResponseOutput
java.io.IOException
public boolean isCommitted()
isCommitted
in interface com.ibm.wsspi.webcontainer.util.IResponseOutput
isCommitted
in interface javax.servlet.ServletResponse
isCommitted
in class javax.servlet.ServletResponseWrapper
public void reset() throws java.lang.IllegalStateException
reset
in interface com.ibm.wsspi.webcontainer.util.IResponseOutput
reset
in interface javax.servlet.ServletResponse
reset
in class javax.servlet.ServletResponseWrapper
java.lang.IllegalStateException
public java.util.Vector[] getHeaderTable()
getHeaderTable
in interface IExtendedResponse
getHeaderTable
in interface ServletResponseExtended
public void addSessionCookie(javax.servlet.http.Cookie cookie)
addSessionCookie
in interface IExtendedResponse
addSessionCookie
in interface ServletResponseExtended
public void setLocale(java.util.Locale loc)
setLocale
in interface javax.servlet.ServletResponse
setLocale
in class javax.servlet.ServletResponseWrapper
public void setCharacterEncoding(java.lang.String encoding)
setCharacterEncoding
in interface javax.servlet.ServletResponse
setCharacterEncoding
in class javax.servlet.ServletResponseWrapper
public java.util.Locale getLocale()
getLocale
in interface javax.servlet.ServletResponse
getLocale
in class javax.servlet.ServletResponseWrapper
public void addDateHeader(java.lang.String name, long date)
addDateHeader
in interface javax.servlet.http.HttpServletResponse
addDateHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface javax.servlet.http.HttpServletResponse
addHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void addIntHeader(java.lang.String name, int value)
addIntHeader
in interface javax.servlet.http.HttpServletResponse
addIntHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface javax.servlet.http.HttpServletResponse
setHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void setInternalHeader(java.lang.String name, java.lang.String value)
setInternalHeader
in interface IExtendedResponse
public void setHeader(java.lang.String name, java.lang.String value, boolean checkInclude)
setHeader
in interface IExtendedResponse
setHeader
in interface ServletResponseExtended
public void setIntHeader(java.lang.String name, int value)
setIntHeader
in interface javax.servlet.http.HttpServletResponse
setIntHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void setDateHeader(java.lang.String name, long value)
setDateHeader
in interface javax.servlet.http.HttpServletResponse
setDateHeader
in class javax.servlet.http.HttpServletResponseWrapper
public boolean containsHeader(java.lang.String name)
containsHeader
in interface javax.servlet.http.HttpServletResponse
containsHeader
in class javax.servlet.http.HttpServletResponseWrapper
public java.io.PrintWriter getWriter() throws java.io.IOException, java.lang.IllegalStateException
getWriter
in interface javax.servlet.ServletResponse
getWriter
in class javax.servlet.ServletResponseWrapper
java.io.IOException
java.lang.IllegalStateException
public void setStatus(int sc)
setStatus
in interface javax.servlet.http.HttpServletResponse
setStatus
in class javax.servlet.http.HttpServletResponseWrapper
public void setStatus(int sc, java.lang.String message)
setStatus
in interface javax.servlet.http.HttpServletResponse
setStatus
in class javax.servlet.http.HttpServletResponseWrapper
public void sendError(int sc) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
sendError
in class javax.servlet.http.HttpServletResponseWrapper
java.io.IOException
public void sendError(int sc, java.lang.String message) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
sendError
in class javax.servlet.http.HttpServletResponseWrapper
java.io.IOException
public java.lang.String encodeURL(java.lang.String url)
encodeURL
in interface javax.servlet.http.HttpServletResponse
encodeURL
in class javax.servlet.http.HttpServletResponseWrapper
public java.lang.String encodeUrl(java.lang.String url)
encodeUrl
in interface javax.servlet.http.HttpServletResponse
encodeUrl
in class javax.servlet.http.HttpServletResponseWrapper
public void sendRedirect(java.lang.String uri) throws java.io.IOException
sendRedirect
in interface javax.servlet.http.HttpServletResponse
sendRedirect
in class javax.servlet.http.HttpServletResponseWrapper
java.io.IOException
public void sendRedirect303(java.lang.String uri) throws java.io.IOException
sendRedirect303
in interface IExtendedResponse
java.io.IOException
public java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL
in interface javax.servlet.http.HttpServletResponse
encodeRedirectURL
in class javax.servlet.http.HttpServletResponseWrapper
public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl
in interface javax.servlet.http.HttpServletResponse
encodeRedirectUrl
in class javax.servlet.http.HttpServletResponseWrapper
public void finish() throws java.io.IOException
finish
in interface IExtendedResponse
java.io.IOException
public void close() throws java.io.IOException
java.io.IOException
public byte[] getOutputBuffer() throws java.io.IOException
java.io.IOException
public java.util.List<com.ibm.wsspi.bytebuffer.WsByteBuffer> getByteBufferList() throws java.io.IOException
java.io.IOException
public java.lang.String getOutputBufferAsString() throws java.io.IOException
java.io.IOException
public CollectionEnumerationHybrid<java.lang.String> getHeaderNames()
getHeaderNames
in interface StoredResponseCompat<CollectionEnumerationHybrid<java.lang.String>>
getHeaderNames
in interface javax.servlet.http.HttpServletResponse
getHeaderNames
in class javax.servlet.http.HttpServletResponseWrapper
public java.util.Enumeration getAddedHeaderNames()
public java.lang.String getHeader(java.lang.String name)
getHeader
in interface javax.servlet.http.HttpServletResponse
getHeader
in class javax.servlet.http.HttpServletResponseWrapper
public 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 IExtendedResponse
getStatusCode
in interface ServletResponseExtended
public java.lang.String getStatusMessage()
public java.lang.String getRedirectURI()
public boolean isRedirected()
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletResponse
getCharacterEncoding
in class javax.servlet.ServletResponseWrapper
public java.lang.String getContentType()
getContentType
in interface javax.servlet.ServletResponse
getContentType
in class javax.servlet.ServletResponseWrapper
public 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.IOException
public void resetBuffer()
resetBuffer
in interface javax.servlet.ServletResponse
resetBuffer
in class javax.servlet.ServletResponseWrapper
public void fireOutputStreamRetrievedEvent(javax.servlet.ServletOutputStream sos)
fireOutputStreamRetrievedEvent
in interface IExtendedResponse
public void fireWriterRetrievedEvent(java.io.PrintWriter pw)
fireWriterRetrievedEvent
in interface IExtendedResponse
public void registerOutputMethodListener(IOutputMethodListener listener)
registerOutputMethodListener
in interface IExtendedResponse
public void destroy()
destroy
in interface IExtendedResponse
public void initForNextResponse(IResponse res)
initForNextResponse
in interface IExtendedResponse
public void start()
start
in interface IExtendedResponse
public void setInclude(boolean isInclude)
public void setInternalHeaderSettable(boolean internalHeaderSettable)
public void buildResponseData(ServletResponseExtended response)
public void buildWriterData(ServletResponseExtended response)
public void alertClose()
alertClose
in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
public void alertException()
alertException
in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
public void alertFirstFlush()
alertFirstFlush
in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
public void alertFirstWrite()
alertFirstWrite
in interface com.ibm.wsspi.webcontainer.util.IOutputStreamObserver
public void closeResponseOutput(boolean b)
closeResponseOutput
in interface IExtendedResponse
public void removeCookie(java.lang.String cookieName)
removeCookie
in interface IExtendedResponse
public boolean isOutputWritten()
isOutputWritten
in interface IExtendedResponse