HttpResponseImpl

java.lang.Object
- org.apache.openejb.server.httpd.HttpResponseImpl

All Implemented Interfaces:

java.io.Serializable, HttpResponse
```
public class HttpResponseImpl
extends java.lang.Object
implements HttpResponse
```
This class takes care of HTTP Responses. It sends data back to the browser.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CRLF` a line feed character
`static java.lang.String`	`CSP` a colon and space
`static java.lang.String`	`HTTP_VERSION` the HTTP version
`static java.lang.String`	`server` the server to send data from
`static java.lang.String`	`SP` a space character

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`HttpResponseImpl()` creates a new instance of HttpResponseImpl with default values
`protected`	`HttpResponseImpl(int code, java.lang.String responseString, java.lang.String contentType)` Creates a new HttpResponseImpl with user provided parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCookie(Cookie cookie)`
`void`	`addDateHeader(java.lang.String s, long l)`
`void`	`addHeader(java.lang.String s, java.lang.String s1)`
`void`	`addIntHeader(java.lang.String s, int i)`
`boolean`	`containsHeader(java.lang.String s)`
`protected static HttpResponseImpl`	`createError(java.lang.String message)` This could be improved at some day in the future to also include a stack trace of the exceptions
`protected static HttpResponseImpl`	`createError(java.lang.String message, java.lang.Throwable t)` creates an error with user defined variables
`protected static HttpResponseImpl`	`createForbidden(java.lang.String ip)` Creates a forbidden response to be sent to the browser using IP authentication
`java.lang.String`	`encodeRedirectURL(java.lang.String s)`
`java.lang.String`	`encodeURL(java.lang.String s)`
`void`	`flushBuffer()` Flushes the output buffer to the client.
`int`	`getBufferSize()`
`java.lang.String`	`getCharacterEncoding()`
`int`	`getCode()` gets the HTTP response code
`java.lang.String`	`getContentType()` gets the content type that will be sent to the browser
`java.lang.String`	`getHeader(java.lang.String name)` Gets a header based on the name passed in
`java.util.Collection<java.lang.String>`	`getHeaderNames()`
`java.util.Collection<java.lang.String>`	`getHeaders(java.lang.String s)`
`java.util.Locale`	`getLocale()`
`ServletOutputStream`	`getOutputStream()` gets the OutputStream to send data to the browser
`java.lang.String`	`getServerName()` gets the name of the server being used
`int`	`getStatus()`
`java.io.PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`void`	`reset()` resets the data to be sent to the browser
`void`	`reset(int code, java.lang.String responseString)` resets the data to be sent to the browser with the response code and response string
`void`	`resetBuffer()`
`void`	`sendError(int i)`
`void`	`sendError(int i, java.lang.String s)`
`void`	`sendRedirect(java.lang.String path)`
`void`	`setBufferSize(int i)`
`void`	`setCharacterEncoding(java.lang.String s)`
`void`	`setCode(int code)` sets the HTTP response code to be sent to the browser.
`void`	`setContent(java.net.URLConnection content)`
`void`	`setContentLength(int i)`
`void`	`setContentLengthLong(long length)`
`void`	`setContentType(java.lang.String type)` sets the content type to be sent back to the browser
`void`	`setDateHeader(java.lang.String s, long l)`
`void`	`setHeader(java.lang.String name, java.lang.String value)` sets a header to be sent back to the browser
`void`	`setIntHeader(java.lang.String s, int i)`
`void`	`setLocale(java.util.Locale loc)`
`protected void`	`setRequest(HttpRequestImpl request)`
`void`	`setResponseString(java.lang.String responseString)` Sets the response string to be sent to the browser
`void`	`setStatus(int i)`
`void`	`setStatusMessage(java.lang.String responseString)` Sets the response string to be sent to the browser
`java.lang.String`	`toString()` Creates a string version of the response similar to: HTTP/1.1 200 OK
`protected void`	`writeMessage(java.io.OutputStream output, boolean indent)` Takes care of sending the response line, headers and body HTTP/1.1 200 OK Server: Netscape-Enterprise/3.6 SP3 Date: Thu, 07 Jun 2001 17:30:42 GMT Content-Type: text/html Connection: close

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HTTP_VERSION
```
public static final java.lang.String HTTP_VERSION
```
    the HTTP version
    
    See Also:
    
    Constant Field Values
  - CRLF
```
public static final java.lang.String CRLF
```
    a line feed character
    
    See Also:
    
    Constant Field Values
  - SP
```
public static final java.lang.String SP
```
    a space character
    
    See Also:
    
    Constant Field Values
  - CSP
```
public static final java.lang.String CSP
```
    a colon and space
    
    See Also:
    
    Constant Field Values
  - server
```
public static java.lang.String server
```
    the server to send data from
- Constructor Detail
  - HttpResponseImpl
```
protected HttpResponseImpl()
```
    creates a new instance of HttpResponseImpl with default values
  - HttpResponseImpl
```
protected HttpResponseImpl(int code,
                           java.lang.String responseString,
                           java.lang.String contentType)
```
    Creates a new HttpResponseImpl with user provided parameters
    
    Parameters:
    
    code - the HTTP Response code, see http://www.ietf.org/rfc/rfc2616.txt for these codes
    
    responseString - the response string to be sent back
    
    contentType - the content type to be sent back
- Method Detail
  - setRequest
```
protected void setRequest(HttpRequestImpl request)
```
  - setHeader
```
public void setHeader(java.lang.String name,
                      java.lang.String value)
```
    sets a header to be sent back to the browser
    
    Parameters:
    
    name - the name of the header
    
    value - the value of the header
  - setIntHeader
```
public void setIntHeader(java.lang.String s,
                         int i)
```
  - setStatus
```
public void setStatus(int i)
```
  - addCookie
```
public void addCookie(Cookie cookie)
```
  - addDateHeader
```
public void addDateHeader(java.lang.String s,
                          long l)
```
  - addHeader
```
public void addHeader(java.lang.String s,
                      java.lang.String s1)
```
  - addIntHeader
```
public void addIntHeader(java.lang.String s,
                         int i)
```
  - containsHeader
```
public boolean containsHeader(java.lang.String s)
```
  - encodeURL
```
public java.lang.String encodeURL(java.lang.String s)
```
  - encodeRedirectURL
```
public java.lang.String encodeRedirectURL(java.lang.String s)
```
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Gets a header based on the name passed in
    
    Parameters:
    
    name - The name of the header
    
    Returns:
    
    the value of the header
  - getHeaderNames
```
public java.util.Collection<java.lang.String> getHeaderNames()
```
  - getHeaders
```
public java.util.Collection<java.lang.String> getHeaders(java.lang.String s)
```
  - getStatus
```
public int getStatus()
```
  - sendError
```
public void sendError(int i)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - sendError
```
public void sendError(int i,
                      java.lang.String s)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - sendRedirect
```
public void sendRedirect(java.lang.String path)
                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - setDateHeader
```
public void setDateHeader(java.lang.String s,
                          long l)
```
  - getOutputStream
```
public ServletOutputStream getOutputStream()
```
    gets the OutputStream to send data to the browser
    
    Returns:
    
    the OutputStream to send data to the browser
  - getWriter
```
public java.io.PrintWriter getWriter()
                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isCommitted
```
public boolean isCommitted()
```
  - flushBuffer
```
public void flushBuffer()
                 throws java.io.IOException
```
    Description copied from interface: HttpResponse
    
    Flushes the output buffer to the client.
    
    Specified by:
    
    flushBuffer in interface HttpResponse
    
    Throws:
    
    java.io.IOException
  - getBufferSize
```
public int getBufferSize()
```
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
  - setCode
```
public void setCode(int code)
```
    sets the HTTP response code to be sent to the browser. These codes are: OPTIONS = 0 GET = 1 HEAD = 2 POST = 3 PUT = 4 DELETE = 5 TRACE = 6 CONNECT = 7 UNSUPPORTED = 8
    
    Parameters:
    
    code - the code to be sent to the browser
  - getCode
```
public int getCode()
```
    gets the HTTP response code
    
    Returns:
    
    the HTTP response code
  - setContentType
```
public void setContentType(java.lang.String type)
```
    sets the content type to be sent back to the browser
    
    Specified by:
    
    setContentType in interface HttpResponse
    
    Parameters:
    
    type - the type to be sent to the browser (i.e. "text/html")
  - setLocale
```
public void setLocale(java.util.Locale loc)
```
  - getContentType
```
public java.lang.String getContentType()
```
    gets the content type that will be sent to the browser
    
    Specified by:
    
    getContentType in interface HttpResponse
    
    Returns:
    
    the content type (i.e. "text/html")
  - getLocale
```
public java.util.Locale getLocale()
```
  - setResponseString
```
public void setResponseString(java.lang.String responseString)
```
    Sets the response string to be sent to the browser
    
    Parameters:
    
    responseString - the response string
  - reset
```
public void reset()
```
    resets the data to be sent to the browser
  - resetBuffer
```
public void resetBuffer()
```
  - setBufferSize
```
public void setBufferSize(int i)
```
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String s)
```
  - setContentLength
```
public void setContentLength(int i)
```
  - setContentLengthLong
```
public void setContentLengthLong(long length)
```
  - reset
```
public void reset(int code,
                  java.lang.String responseString)
```
    resets the data to be sent to the browser with the response code and response string
    
    Parameters:
    
    code - the code to be sent to the browser
    
    responseString - the response string to be sent to the browser
  - writeMessage
```
protected void writeMessage(java.io.OutputStream output,
                            boolean indent)
                     throws java.io.IOException
```
    Takes care of sending the response line, headers and body HTTP/1.1 200 OK Server: Netscape-Enterprise/3.6 SP3 Date: Thu, 07 Jun 2001 17:30:42 GMT Content-Type: text/html Connection: close
    
    Parameters:
    
    output - the output to send the response to
    
    Throws:
    
    java.io.IOException - if an exception is thrown
  - toString
```
public java.lang.String toString()
```
    Creates a string version of the response similar to: HTTP/1.1 200 OK
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string value of this HttpResponseImpl
  - getServerName
```
public java.lang.String getServerName()
```
    gets the name of the server being used
    
    Returns:
    
    the name of the server
  - createError
```
protected static HttpResponseImpl createError(java.lang.String message)
```
    This could be improved at some day in the future to also include a stack trace of the exceptions
    
    Parameters:
    
    message - the error message to be sent
    
    Returns:
    
    the HttpResponseImpl that this error belongs to
  - createError
```
protected static HttpResponseImpl createError(java.lang.String message,
                                              java.lang.Throwable t)
```
    creates an error with user defined variables
    
    Parameters:
    
    message - the message of the error
    
    t - a Throwable to print a stack trace to
    
    Returns:
    
    the HttpResponseImpl that this error belongs to
  - createForbidden
```
protected static HttpResponseImpl createForbidden(java.lang.String ip)
```
    Creates a forbidden response to be sent to the browser using IP authentication
    
    Parameters:
    
    ip - the ip that is forbidden
    
    Returns:
    
    the HttpResponseImpl that this error belongs to
  - setContent
```
public void setContent(java.net.URLConnection content)
```
    Parameters:
    
    content - The content to set.
  - setStatusMessage
```
public void setStatusMessage(java.lang.String responseString)
```
    Description copied from interface: HttpResponse
    
    Sets the response string to be sent to the browser
    
    Specified by:
    
    setStatusMessage in interface HttpResponse
    
    Parameters:
    
    responseString - the response string

Class HttpResponseImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTTP_VERSION

CRLF

SP

CSP

server

Constructor Detail

HttpResponseImpl

HttpResponseImpl

Method Detail

setRequest

setHeader

setIntHeader

setStatus

addCookie

addDateHeader

addHeader

addIntHeader

containsHeader

encodeURL

encodeRedirectURL

getHeader

getHeaderNames

getHeaders

getStatus

sendError

sendError

sendRedirect

setDateHeader

getOutputStream

getWriter

isCommitted

flushBuffer

getBufferSize

getCharacterEncoding

setCode

getCode

setContentType

setLocale

getContentType

getLocale

setResponseString

reset

resetBuffer

setBufferSize

setCharacterEncoding

setContentLength

setContentLengthLong

reset

writeMessage

toString

getServerName

createError

createError

createForbidden

setContent

setStatusMessage