org.directwebremoting.util
Class SwallowingHttpServletResponse

java.lang.Object
  org.directwebremoting.util.SwallowingHttpServletResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public final class SwallowingHttpServletResponse
extends java.lang.Object
implements javax.servlet.http.HttpServletResponse

Used by ExecutionContext to forward results back via javascript.

We could like to implement HttpServletResponse, but there is a bug in WebLogic where it casts to a HttpServletResponseWrapper so we need to extend that.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

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

SwallowingHttpServletResponse(javax.servlet.http.HttpServletResponse response, java.io.Writer sout, java.lang.String characterEncoding)
Create a new HttpServletResponse that allows you to catch the body

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie)
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)
boolean	containsHeader(java.lang.String name)
java.lang.String	encodeRedirectUrl(java.lang.String paramString)
java.lang.String	encodeRedirectURL(java.lang.String paramString)
java.lang.String	encodeUrl(java.lang.String paramString)
java.lang.String	encodeURL(java.lang.String paramString)
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
java.lang.String	getErrorMessage() Accessor for any error messages set using sendError(int) or sendError(int, String)
java.lang.String	getHeader(java.lang.String paramString)
java.util.Collection<java.lang.String>	getHeaderNames()
java.util.Collection<java.lang.String>	getHeaders(java.lang.String paramString)
java.util.Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
java.lang.String	getRedirectedUrl() Accessor for the redirect URL set using sendRedirect(String)
int	getStatus() What HTTP status code should be returned?
java.io.PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int newStatus)
void	sendError(int newStatus, java.lang.String newErrorMessage)
void	sendRedirect(java.lang.String location)
void	setBufferSize(int bufferSize)
void	setCharacterEncoding(java.lang.String characterEncoding)
void	setContentLength(int i)
void	setContentType(java.lang.String contentType)
void	setDateHeader(java.lang.String name, long value)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale locale)
void	setStatus(int status)
void	setStatus(int newStatus, java.lang.String newErrorMessage) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwallowingHttpServletResponse

public SwallowingHttpServletResponse(javax.servlet.http.HttpServletResponse response,
                                     java.io.Writer sout,
                                     java.lang.String characterEncoding)

Create a new HttpServletResponse that allows you to catch the body

Parameters:

response - The original HttpServletResponse

sout - The place we copy responses to

characterEncoding - The output encoding

Method Detail

addCookie

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

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(java.lang.String name,
                          long value)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(java.lang.String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Returns:

The MIME type of the content

See Also:

ServletResponse.setContentType(String)

getErrorMessage

public java.lang.String getErrorMessage()

Accessor for any error messages set using sendError(int) or sendError(int, String)

Returns:

The current error message

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

getRedirectedUrl

public java.lang.String getRedirectedUrl()

Accessor for the redirect URL set using sendRedirect(String)

Returns:

The redirect URL

getStatus

public int getStatus()

What HTTP status code should be returned?

Specified by:

getStatus in interface javax.servlet.http.HttpServletResponse

Returns:

The current http status code

getWriter

public java.io.PrintWriter getWriter()

Specified by:

getWriter in interface javax.servlet.ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

sendError

public void sendError(int newStatus)

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

sendError

public void sendError(int newStatus,
                      java.lang.String newErrorMessage)

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

sendRedirect

public void sendRedirect(java.lang.String location)

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

setBufferSize

public void setBufferSize(int bufferSize)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(java.lang.String characterEncoding)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Parameters:

characterEncoding - The new encoding to use for response strings

See Also:

ServletResponseWrapper.getCharacterEncoding()

setContentLength

public void setContentLength(int i)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface javax.servlet.ServletResponse

setDateHeader

public void setDateHeader(java.lang.String name,
                          long value)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

setLocale

public void setLocale(java.util.Locale locale)

Specified by:

setLocale in interface javax.servlet.ServletResponse

setStatus

public void setStatus(int status)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

@Deprecated
public void setStatus(int newStatus,
                                 java.lang.String newErrorMessage)

Deprecated.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

See Also:

HttpServletResponse.setStatus(int, java.lang.String)

encodeURL

public java.lang.String encodeURL(java.lang.String paramString)

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String paramString)

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

encodeUrl

public java.lang.String encodeUrl(java.lang.String paramString)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String paramString)

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

getHeader

public java.lang.String getHeader(java.lang.String paramString)

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

getHeaders

public java.util.Collection<java.lang.String> getHeaders(java.lang.String paramString)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletResponse

getHeaderNames

public java.util.Collection<java.lang.String> getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletResponse