WinstoneResponse (Winstone 0.9.10-jenkins-47 API)

java.lang.Object
- winstone.WinstoneResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse
```
public class WinstoneResponse
extends 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

Constructors
Constructor and Description

WinstoneResponse()
Constructor

Constructors
Constructor and Description
`WinstoneResponse()` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie(Cookie cookie)`
`void`	`addDateHeader(String name, long date)`
`void`	`addHeader(String name, String value)`
`void`	`addIntHeader(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(String name)`
`String`	`encodeRedirectUrl(String url)` Deprecated.
`String`	`encodeRedirectURL(String url)`
`String`	`encodeUrl(String url)` Deprecated.
`String`	`encodeURL(String url)`
`void`	`extractRequestKeepAliveHeader(WinstoneRequest req)`
`void`	`finishIncludeBuffer()`
`void`	`flushBuffer()`
`int`	`getBufferSize()`
`String`	`getCharacterEncoding()`
`protected static String`	`getCharsetFromContentTypeHeader(String type, StringBuffer remainder)`
`String`	`getContentType()`
`List`	`getCookies()`
`Integer`	`getErrorStatusCode()`
`String`	`getHeader(String name)`
`List<String>`	`getHeaders()`
`Locale`	`getLocale()`
`ServletOutputStream`	`getOutputStream()`
`String`	`getProtocol()`
`WinstoneRequest`	`getRequest()`
`int`	`getStatus()`
`WinstoneOutputStream`	`getWinstoneOutputStream()`
`PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`protected static void`	`quote(String value, StringBuffer out)` Quotes the necessary strings in a cookie header.
`void`	`reset()`
`void`	`resetBuffer()`
`void`	`sendError(int sc)`
`void`	`sendError(int sc, String msg)`
`void`	`sendRedirect(String location)`
`void`	`setBufferSize(int size)`
`void`	`setCharacterEncoding(String encoding)`
`void`	`setContentLength(int len)`
`void`	`setContentType(String type)`
`void`	`setDateHeader(String name, long date)`
`void`	`setErrorStatusCode(int statusCode)`
`void`	`setHeader(String name, String value)`
`void`	`setIntHeader(String name, int value)`
`void`	`setLocale(Locale loc)`
`void`	`setOutputStream(WinstoneOutputStream outData)`
`void`	`setProtocol(String protocol)`
`void`	`setRequest(WinstoneRequest req)`
`void`	`setStatus(int sc)`
`void`	`setStatus(int sc, String sm)` Deprecated.
`void`	`setWebAppConfig(WebAppConfiguration webAppConfig)`
`void`	`startIncludeBuffer()`
`void`	`validateHeaders()` This ensures the bare minimum correct http headers are present
`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 String getProtocol()
```
  - setProtocol
```
public void setProtocol(String protocol)
```
  - extractRequestKeepAliveHeader
```
public void extractRequestKeepAliveHeader(WinstoneRequest req)
```
  - getHeaders
```
public List<String> getHeaders()
```
  - getCookies
```
public List getCookies()
```
  - getRequest
```
public WinstoneRequest getRequest()
```
  - setRequest
```
public void setRequest(WinstoneRequest req)
```
  - startIncludeBuffer
```
public void startIncludeBuffer()
```
  - finishIncludeBuffer
```
public void finishIncludeBuffer()
                         throws IOException
```
    Throws:
    
    IOException
  - clearIncludeStackForForward
```
public void clearIncludeStackForForward()
                                 throws IOException
```
    Throws:
    
    IOException
  - getCharsetFromContentTypeHeader
```
protected static String getCharsetFromContentTypeHeader(String type,
                                     StringBuffer remainder)
```
  - validateHeaders
```
public void validateHeaders()
```
    This ensures the bare minimum correct http headers are present
  - writeCookie
```
public String writeCookie(Cookie cookie)
```
    Writes out the http header for a single cookie
  - quote
```
protected static void quote(String value,
         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 IOException
```
    Specified by:
    
    flushBuffer in interface ServletResponse
    
    Throws:
    
    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 String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface ServletResponse
  - setCharacterEncoding
```
public void setCharacterEncoding(String encoding)
```
    Specified by:
    
    setCharacterEncoding in interface ServletResponse
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface ServletResponse
  - setContentType
```
public void setContentType(String type)
```
    Specified by:
    
    setContentType in interface ServletResponse
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface ServletResponse
  - setLocale
```
public void setLocale(Locale loc)
```
    Specified by:
    
    setLocale in interface ServletResponse
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws IOException
```
    Specified by:
    
    getOutputStream in interface ServletResponse
    
    Throws:
    
    IOException
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Specified by:
    
    getWriter in interface ServletResponse
    
    Throws:
    
    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(String name)
```
    Specified by:
    
    containsHeader in interface HttpServletResponse
  - addDateHeader
```
public void addDateHeader(String name,
                 long date)
```
    Specified by:
    
    addDateHeader in interface HttpServletResponse
  - addIntHeader
```
public void addIntHeader(String name,
                int value)
```
    Specified by:
    
    addIntHeader in interface HttpServletResponse
  - addHeader
```
public void addHeader(String name,
             String value)
```
    Specified by:
    
    addHeader in interface HttpServletResponse
  - setDateHeader
```
public void setDateHeader(String name,
                 long date)
```
    Specified by:
    
    setDateHeader in interface HttpServletResponse
  - setIntHeader
```
public void setIntHeader(String name,
                int value)
```
    Specified by:
    
    setIntHeader in interface HttpServletResponse
  - setHeader
```
public void setHeader(String name,
             String value)
```
    Specified by:
    
    setHeader in interface HttpServletResponse
  - getHeader
```
public String getHeader(String name)
```
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    Specified by:
    
    encodeRedirectURL in interface HttpServletResponse
  - encodeURL
```
public String encodeURL(String url)
```
    Specified by:
    
    encodeURL in interface HttpServletResponse
  - getStatus
```
public int getStatus()
```
  - getErrorStatusCode
```
public Integer getErrorStatusCode()
```
  - setStatus
```
public void setStatus(int sc)
```
    Specified by:
    
    setStatus in interface HttpServletResponse
  - sendRedirect
```
public void sendRedirect(String location)
                  throws IOException
```
    Specified by:
    
    sendRedirect in interface HttpServletResponse
    
    Throws:
    
    IOException
  - sendError
```
public void sendError(int sc)
               throws IOException
```
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Throws:
    
    IOException
  - sendError
```
public void sendError(int sc,
             String msg)
               throws IOException
```
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Throws:
    
    IOException
  - encodeRedirectUrl
```
public String encodeRedirectUrl(String url)
```
    Deprecated.
    
    Specified by:
    
    encodeRedirectUrl in interface HttpServletResponse
  - encodeUrl
```
public String encodeUrl(String url)
```
    Deprecated.
    
    Specified by:
    
    encodeUrl in interface HttpServletResponse
  - setStatus
```
public void setStatus(int sc,
             String sm)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface HttpServletResponse

Class WinstoneResponse

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WinstoneResponse

Method Detail

cleanUp

setErrorStatusCode

getWinstoneOutputStream

setOutputStream

setWebAppConfig

getProtocol

setProtocol

extractRequestKeepAliveHeader

getHeaders

getCookies

getRequest

setRequest

startIncludeBuffer

finishIncludeBuffer

clearIncludeStackForForward

getCharsetFromContentTypeHeader

validateHeaders

writeCookie

quote

closeAfterRequest

flushBuffer

setBufferSize

getBufferSize

getCharacterEncoding

setCharacterEncoding

getContentType

setContentType

getLocale

setLocale

getOutputStream

getWriter

isCommitted

reset

resetBuffer

setContentLength

addCookie

containsHeader

addDateHeader

addIntHeader

addHeader

setDateHeader

setIntHeader

setHeader

getHeader

encodeRedirectURL

encodeURL

getStatus

getErrorStatusCode

setStatus

sendRedirect

sendError

sendError

encodeRedirectUrl

encodeUrl

setStatus