winstone
Class WinstoneResponse

java.lang.Object
  winstone.WinstoneResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class WinstoneResponse
extends java.lang.Object
implements HttpServletResponse

Response for servlet

Version:

$Id: WinstoneResponse.java,v 1.28 2005/04/19 07:33:41 rickknowles Exp $

Author:

Rick Knowles

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

WinstoneResponse()
Constructor

Method Summary

void	addCookie(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	cleanUp() Resets the request to be reused
void	clearIncludeStackForForward()
boolean	closeAfterRequest() Based on request/response headers and the protocol, determine whether or not this connection should operate in keep-alive mode.
boolean	containsHeader(java.lang.String name)
java.lang.String	encodeRedirectUrl(java.lang.String url) Deprecated.
java.lang.String	encodeRedirectURL(java.lang.String url)
java.lang.String	encodeUrl(java.lang.String url) Deprecated.
java.lang.String	encodeURL(java.lang.String url)
void	extractRequestKeepAliveHeader(WinstoneRequest req)
void	finishIncludeBuffer()
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding()
protected static java.lang.String	getCharsetFromContentTypeHeader(java.lang.String type, java.lang.StringBuffer remainder)
java.lang.String	getContentType()
java.util.List	getCookies()
java.lang.Integer	getErrorStatusCode()
java.lang.String	getHeader(java.lang.String name)
java.util.List	getHeaders()
java.util.Locale	getLocale()
ServletOutputStream	getOutputStream()
java.lang.String	getProtocol()
WinstoneRequest	getRequest()
int	getStatus()
WinstoneOutputStream	getWinstoneOutputStream()
java.io.PrintWriter	getWriter()
boolean	isCommitted()
protected static void	quote(java.lang.String value, java.lang.StringBuffer out) Quotes the necessary strings in a cookie header.
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, java.lang.String msg)
void	sendRedirect(java.lang.String location)
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 date)
void	setErrorStatusCode(int statusCode)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale loc)
void	setOutputStream(WinstoneOutputStream outData)
void	setProtocol(java.lang.String protocol)
void	setRequest(WinstoneRequest req)
void	setStatus(int sc)
void	setStatus(int sc, java.lang.String sm) Deprecated.
void	setWebAppConfig(WebAppConfiguration webAppConfig)
void	startIncludeBuffer()
void	validateHeaders() This ensures the bare minimum correct http headers are present
java.lang.String	writeCookie(Cookie cookie) Writes out the http header for a single cookie

Methods inherited from class java.lang.Object

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

Constructor Detail

WinstoneResponse

public WinstoneResponse()

Constructor

Method Detail

cleanUp

public void cleanUp()

Resets the request to be reused

setErrorStatusCode

public void setErrorStatusCode(int statusCode)

getWinstoneOutputStream

public WinstoneOutputStream getWinstoneOutputStream()

setOutputStream

public void setOutputStream(WinstoneOutputStream outData)

setWebAppConfig

public void setWebAppConfig(WebAppConfiguration webAppConfig)

getProtocol

public java.lang.String getProtocol()

setProtocol

public void setProtocol(java.lang.String protocol)

extractRequestKeepAliveHeader

public void extractRequestKeepAliveHeader(WinstoneRequest req)

getHeaders

public java.util.List getHeaders()

getCookies

public java.util.List getCookies()

getRequest

public WinstoneRequest getRequest()

setRequest

public void setRequest(WinstoneRequest req)

startIncludeBuffer

public void startIncludeBuffer()

finishIncludeBuffer

public void finishIncludeBuffer()
                         throws java.io.IOException

Throws:

java.io.IOException

clearIncludeStackForForward

public void clearIncludeStackForForward()
                                 throws java.io.IOException

Throws:

java.io.IOException

getCharsetFromContentTypeHeader

protected static java.lang.String getCharsetFromContentTypeHeader(java.lang.String type,
                                                                  java.lang.StringBuffer remainder)

validateHeaders

public void validateHeaders()

This ensures the bare minimum correct http headers are present

writeCookie

public java.lang.String writeCookie(Cookie cookie)
                             throws java.io.IOException

Writes out the http header for a single cookie

Throws:

java.io.IOException

quote

protected static void quote(java.lang.String value,
                            java.lang.StringBuffer out)

Quotes the necessary strings in a cookie header. The quoting is only applied if the string contains special characters.

closeAfterRequest

public boolean closeAfterRequest()

Based on request/response headers and the protocol, determine whether or not this connection should operate in keep-alive mode.

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface ServletResponse

Throws:

java.io.IOException

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encoding)

Specified by:

setCharacterEncoding in interface ServletResponse

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface ServletResponse

setContentType

public void setContentType(java.lang.String type)

Specified by:

setContentType in interface ServletResponse

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface ServletResponse

setLocale

public void setLocale(java.util.Locale loc)

Specified by:

setLocale in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Specified by:

getOutputStream in interface ServletResponse

Throws:

java.io.IOException

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Specified by:

getWriter in interface ServletResponse

Throws:

java.io.IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface ServletResponse

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

containsHeader

public boolean containsHeader(java.lang.String name)

Specified by:

containsHeader in interface HttpServletResponse

addDateHeader

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

Specified by:

addDateHeader in interface HttpServletResponse

addIntHeader

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

Specified by:

addIntHeader in interface HttpServletResponse

addHeader

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

Specified by:

addHeader in interface HttpServletResponse

setDateHeader

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

Specified by:

setDateHeader in interface HttpServletResponse

setIntHeader

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

Specified by:

setIntHeader in interface HttpServletResponse

setHeader

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

Specified by:

setHeader in interface HttpServletResponse

getHeader

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

encodeRedirectURL

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

Specified by:

encodeRedirectURL in interface HttpServletResponse

encodeURL

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

Specified by:

encodeURL in interface HttpServletResponse

getStatus

public int getStatus()

getErrorStatusCode

public java.lang.Integer getErrorStatusCode()

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface HttpServletResponse

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

java.io.IOException

sendError

public void sendError(int sc)
               throws java.io.IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

java.io.IOException

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

java.io.IOException

encodeRedirectUrl

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

Deprecated.

Specified by:

encodeRedirectUrl in interface HttpServletResponse

encodeUrl

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

Deprecated.

Specified by:

encodeUrl in interface HttpServletResponse

setStatus

public void setStatus(int sc,
                      java.lang.String sm)

Deprecated.

Specified by:

setStatus in interface HttpServletResponse