|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.servlet.filter.ResponseFilter | +--org.enhydra.servlet.debug.ResponseRecord
HttpServletResponse filter that generate a record of the response that was made. Once the transaction is complete, this object contains the information.
com.lutris.filter.ransactionFilter
,
ServletResponse
,
HttpServletResponse
Field Summary | |
protected java.lang.StringBuffer |
responseData
If we are to capture the data written to the socket, save it here. |
protected ServletTransactionRecord |
transactionRecord
Transaction record that this object is associated with. |
Fields inherited from class org.enhydra.servlet.filter.ResponseFilter |
myResponse |
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_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 | |
protected |
ResponseRecord(javax.servlet.http.HttpServletResponse originalResponse,
boolean saveResponseData)
Constructor. |
Method Summary | |
void |
addCookie(javax.servlet.http.Cookie cookie)
Adds the specified cookie to the response. |
void |
addDateHeader(java.lang.String name,
long value)
|
void |
addHeader(java.lang.String name,
java.lang.String value)
|
void |
addIntHeader(java.lang.String name,
int value)
|
protected void |
addTrace(java.lang.String str)
Add a string to the trace buffer. |
protected void |
completed()
Flag the response as completed. |
boolean |
containsHeader(java.lang.String name)
Record call and pass on to actual response object.. |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. |
java.lang.String |
encodeRedirectURL(java.lang.String url)
|
java.lang.String |
encodeUrl(java.lang.String url)
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. |
java.lang.String |
encodeURL(java.lang.String url)
|
void |
flushBuffer()
|
int |
getBufferSize()
|
java.lang.String |
getCharacterEncoding()
Returns the character set encoding for the input of this request. |
int |
getContentLength()
Returns the size of the response entity data, or -1 if not known. |
java.lang.String |
getContentType()
Returns the Internet Media Type of the response entity data, or null if not known. |
javax.servlet.http.Cookie[] |
getCookies()
Returns an array of cookies to be set by this response. |
java.lang.String |
getHeader(java.lang.String name)
Returns the values of the specified header for the response as an array of strings, or a 0 length array if the named header does not exist. |
java.util.Enumeration |
getHeaderNames()
Returns an array of strings representing the header names for this response. |
java.util.Locale |
getLocale()
|
javax.servlet.ServletOutputStream |
getOutputStream()
Returns a wrapper around the real output stream. |
java.lang.String |
getResponseData()
Returns the data written to the net, or null if this feature was not enabled (see the constructor). |
int |
getStatusCode()
Returns the status code for the response, or -1 if not set. |
java.lang.String |
getStatusMessage()
Returns the status message for the response. |
int |
getTotalBytes()
Returns the number of bytes associated with the response. |
java.io.PrintWriter |
getWriter()
Returns a wrapper around the real PrintWriter. |
boolean |
isCommitted()
|
void |
reset()
|
void |
sendError(int sc)
Record call and pass on to actual response object. |
void |
sendError(int sc,
java.lang.String msg)
Record call and pass on to actual response object. |
void |
sendRedirect(java.lang.String location)
Record call and pass on to actual response object. |
void |
setBufferSize(int size)
|
void |
setContentLength(int len)
Record call and pass on to actual response object.. |
void |
setContentType(java.lang.String type)
Record call and pass on to actual response object.. |
void |
setDateHeader(java.lang.String name,
long date)
Record call and pass on to actual response object. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Record call and pass on to actual response object. |
void |
setIntHeader(java.lang.String name,
int value)
Record call and pass on to actual response object. |
void |
setLocale(java.util.Locale locale)
|
void |
setStatus(int sc)
Record call and pass on to actual response object. |
void |
setStatus(int sc,
java.lang.String sm)
Record call and pass on to actual response object.. |
Methods inherited from class org.enhydra.servlet.filter.ResponseFilter |
addMimeHeaders, doWrite, endHeaders, endResponse, getServletOutputStream, recycle |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.StringBuffer responseData
protected ServletTransactionRecord transactionRecord
Constructor Detail |
protected ResponseRecord(javax.servlet.http.HttpServletResponse originalResponse, boolean saveResponseData)
originalResponse
- The real HttpServletResponse, which all calls
will be passed on to.ServletResponse
,
HttpServletResponse
Method Detail |
protected void completed()
protected void addTrace(java.lang.String str)
public void setContentLength(int len)
setContentLength
in interface javax.servlet.ServletResponse
setContentLength
in class ResponseFilter
ServletResponse.setContentLength(int)
public void setContentType(java.lang.String type)
setContentType
in interface javax.servlet.ServletResponse
setContentType
in class ResponseFilter
ServletResponse.setContentType(java.lang.String)
public javax.servlet.ServletOutputStream getOutputStream() throws java.io.IOException
print()
, println()
,
and write()
. Also, if saveResponseData
was true when passed to the
constructor, and setContentType()
has been called
with a mime type that starts with "text/", then a copy of the actuall
data written to the output stream will be saved in this object's
responseData StringBuffer. The decision of whether or not to
save a copy of the data is made the first time this function is
called.
getOutputStream
in interface javax.servlet.ServletResponse
getOutputStream
in class ResponseFilter
java.io.IOException
- See ServletResponse documentationServletResponse.getOutputStream()
,
OutputStreamRecord
public boolean containsHeader(java.lang.String name)
containsHeader
in interface javax.servlet.http.HttpServletResponse
containsHeader
in class ResponseFilter
HttpServletResponse.containsHeader(java.lang.String)
public void setStatus(int sc, java.lang.String sm)
setStatus
in interface javax.servlet.http.HttpServletResponse
setStatus
in class ResponseFilter
HttpServletResponse.setStatus(int)
public void setStatus(int sc)
setStatus
in interface javax.servlet.http.HttpServletResponse
setStatus
in class ResponseFilter
HttpServletResponse.setStatus(int)
public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface javax.servlet.http.HttpServletResponse
setHeader
in class ResponseFilter
HttpServletResponse.setHeader(java.lang.String, java.lang.String)
public void setIntHeader(java.lang.String name, int value)
setIntHeader
in interface javax.servlet.http.HttpServletResponse
setIntHeader
in class ResponseFilter
HttpServletResponse.setIntHeader(java.lang.String, int)
public void setDateHeader(java.lang.String name, long date)
setDateHeader
in interface javax.servlet.http.HttpServletResponse
setDateHeader
in class ResponseFilter
HttpServletResponse.setDateHeader(java.lang.String, long)
public void sendError(int sc, java.lang.String msg) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
sendError
in class ResponseFilter
java.io.IOException
- See HttpServletResponse documentationHttpServletResponse.sendError(int)
public void sendError(int sc) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
sendError
in class ResponseFilter
java.io.IOException
- See HttpServletResponse documentationHttpServletResponse.sendError(int)
public void sendRedirect(java.lang.String location) throws java.io.IOException
sendRedirect
in interface javax.servlet.http.HttpServletResponse
sendRedirect
in class ResponseFilter
java.io.IOException
- See HttpServletResponse documentationHttpServletResponse.sendRedirect(java.lang.String)
public void addCookie(javax.servlet.http.Cookie cookie)
addCookie
in interface javax.servlet.http.HttpServletResponse
addCookie
in class ResponseFilter
HttpServletResponse.addCookie(javax.servlet.http.Cookie)
public int getContentLength()
getContentLength
in interface DebugResponse
public java.lang.String getContentType()
getContentType
in interface DebugResponse
public int getStatusCode()
getStatusCode
in interface DebugResponse
public java.lang.String getStatusMessage()
getStatusMessage
in interface DebugResponse
public javax.servlet.http.Cookie[] getCookies()
getCookies
in interface DebugResponse
public java.lang.String getHeader(java.lang.String name)
getHeader
in interface DebugResponse
name
- the case-insensitive header field namepublic java.util.Enumeration getHeaderNames()
getHeaderNames
in interface DebugResponse
public int getTotalBytes()
getTotalBytes
in interface DebugResponse
public java.lang.String encodeUrl(java.lang.String url)
encodeUrl
in interface javax.servlet.http.HttpServletResponse
encodeUrl
in class ResponseFilter
url
- The url to be encoded.
HttpServletResponse.encodeUrl(java.lang.String)
public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl
in interface javax.servlet.http.HttpServletResponse
encodeRedirectUrl
in class ResponseFilter
url
- The url to be encoded.
HttpServletResponse.encodeRedirectUrl(java.lang.String)
public java.io.PrintWriter getWriter() throws java.io.IOException
saveResponseData
was true when passed to the
constructor, and setContentType()
has been called
with a mime type that starts with "text/", then a copy of the actual
data written to the PprintWriter will be saved in this object's
responseData StringBuffer. The decision of whether or not to
save a copy of the data is made the first time this function is
called.
getWriter
in interface javax.servlet.ServletResponse
getWriter
in class ResponseFilter
java.io.IOException
- See ServletResponse documentationjavax.servlet.ServletResponse#getPrintWriter
,
PrintWriterRecord
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletResponse
getCharacterEncoding
in class ResponseFilter
ServletRequest.getCharacterEncoding()
public java.lang.String getResponseData()
getResponseData
in interface DebugResponse
public java.util.Locale getLocale()
getLocale
in interface javax.servlet.ServletResponse
getLocale
in class ResponseFilter
public void flushBuffer() throws java.io.IOException
flushBuffer
in interface javax.servlet.ServletResponse
flushBuffer
in class ResponseFilter
java.io.IOException
public java.lang.String encodeURL(java.lang.String url)
encodeURL
in interface javax.servlet.http.HttpServletResponse
encodeURL
in class ResponseFilter
public boolean isCommitted()
isCommitted
in interface javax.servlet.ServletResponse
isCommitted
in class ResponseFilter
public int getBufferSize()
getBufferSize
in interface javax.servlet.ServletResponse
getBufferSize
in class ResponseFilter
public void reset()
reset
in interface javax.servlet.ServletResponse
reset
in class ResponseFilter
public java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL
in interface javax.servlet.http.HttpServletResponse
encodeRedirectURL
in class ResponseFilter
public void addIntHeader(java.lang.String name, int value)
addIntHeader
in interface javax.servlet.http.HttpServletResponse
addIntHeader
in class ResponseFilter
public void addDateHeader(java.lang.String name, long value)
addDateHeader
in interface javax.servlet.http.HttpServletResponse
addDateHeader
in class ResponseFilter
public void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface javax.servlet.http.HttpServletResponse
addHeader
in class ResponseFilter
public void setBufferSize(int size)
setBufferSize
in interface javax.servlet.ServletResponse
setBufferSize
in class ResponseFilter
public void setLocale(java.util.Locale locale)
setLocale
in interface javax.servlet.ServletResponse
setLocale
in class ResponseFilter
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |