IResponse (IBM WebSphere Application Server, Release 8.5)

```
public interface IResponse
```
Interface that the webcontainer expects the response objects to implement. The methods on this interface will be called by the webcontainer in the process of writing back the response.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie(javax.servlet.http.Cookie cookie)` Add a cookie to the response.
`void`	`addDateHeader(java.lang.String name, long t)` Add a header as a long value
`void`	`addHeader(byte[] name, byte[] value)` Add a header
`void`	`addHeader(java.lang.String name, java.lang.String value)` Add a header
`void`	`addIntHeader(java.lang.String name, int i)` Add a header as an int value
`void`	`clearHeaders()` Clears the headers datastructure
`boolean`	`containsHeader(byte[] name)` Returns true if the header with the supplied name is already present
`boolean`	`containsHeader(java.lang.String name)` Returns true is the header with the supplied name is already present
`void`	`flushBufferedContent()` Flushes the contents to wire
`javax.servlet.http.Cookie[]`	`getCookies()` Get all the cookies for the response
`boolean`	`getFlushMode()` Gets the flush mode.
`java.lang.String`	`getHeader(byte[] name)` Get a header
`java.lang.String`	`getHeader(java.lang.String name)` Get a header
`java.util.Enumeration`	`getHeaderNames()` Gets all the header names (keys)
`java.util.Enumeration`	`getHeaders(java.lang.String name)` Gets all the header values for a particular header name
`java.util.Vector[]`	`getHeaderTable()` Get the header table
`java.io.OutputStream`	`getOutputStream()` Get the OutputStream
`IRequest`	`getWCCRequest()` Get the webcontainer channel request object for this response
`boolean`	`isAllocateDirect()` Get whether to allocate direct or indirect byte buffers
`boolean`	`isCommitted()` Check if the response is committed yet
`void`	`prepareHeadersForWrite()` Prepare to write the headers
`void`	`releaseChannel()`
`void`	`removeCookie(java.lang.String cookieName)`
`void`	`removeHeader(byte[] name)` Removes the header with the given name
`void`	`removeHeader(java.lang.String name)` Removes the header with the given name
`void`	`setAllocateDirect(boolean allocateDirect)` Set whether to allocate direct or indirect byte buffers
`void`	`setContentLanguage(byte[] value)` Set the content language for the response
`void`	`setContentLanguage(java.lang.String value)` Set the content language for the response
`void`	`setContentType(byte[] value)` Set the content type for the response
`void`	`setContentType(java.lang.String value)` Set the content type for the response
`void`	`setDateHeader(java.lang.String name, long t)` Set date header as a long value
`void`	`setFlushMode(boolean flushToWire)` Sets the flush mode.
`void`	`setHeader(byte[] name, byte[] bs)`
`void`	`setHeader(java.lang.String name, java.lang.String s)`
`void`	`setIntHeader(java.lang.String name, int i)` Set a header as an int
`void`	`setLastBuffer(boolean writeLastBuffer)` Set the last buffer mode
`void`	`setReason(byte[] reason)` Sets the reason in the response.
`void`	`setReason(java.lang.String reason)` Sets the reason in the response.
`void`	`setStatusCode(int code)` Sets the HTTP status code
`void`	`writeHeaders()` Write the headers

- Method Detail
  - setStatusCode
```
void setStatusCode(int code)
```
    Sets the HTTP status code
    
    Parameters:
    code - the HTTP status code
  - getOutputStream
```
java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Get the OutputStream
    
    Returns:
    OutputStream the output stream
    
    Throws:
    
    java.io.IOException
  - isCommitted
```
boolean isCommitted()
```
    Check if the response is committed yet
    
    Returns:
    boolean whether or not the response is committed
  - addHeader
```
void addHeader(java.lang.String name,
             java.lang.String value)
```
    Add a header
    
    Parameters:
    name - the name of the header
    name - the value of the header
  - addHeader
```
void addHeader(byte[] name,
             byte[] value)
```
    Add a header
    
    Parameters:
    name - the name of the header
    value - the value of the header
  - addDateHeader
```
void addDateHeader(java.lang.String name,
                 long t)
```
    Add a header as a long value
    
    Parameters:
    name - the header name
    t - the header date value
  - addIntHeader
```
void addIntHeader(java.lang.String name,
                int i)
```
    Add a header as an int value
    
    Parameters:
    name - the header name
    i - the header int value
  - setDateHeader
```
void setDateHeader(java.lang.String name,
                 long t)
```
    Set date header as a long value
    
    Parameters:
    name - the header name
    t - the header date value
  - setIntHeader
```
void setIntHeader(java.lang.String name,
                int i)
```
    Set a header as an int
    
    Parameters:
    name - the header name
    i - the header int value
  - getHeaderNames
```
java.util.Enumeration getHeaderNames()
```
    Gets all the header names (keys)
    
    Returns:
    Collection of header names
  - getHeaders
```
java.util.Enumeration getHeaders(java.lang.String name)
```
    Gets all the header values for a particular header name
    
    Returns:
    Collection of header v
  - getHeader
```
java.lang.String getHeader(java.lang.String name)
```
    Get a header
    
    Parameters:
    name - the header name
    
    Returns:
    String the header value
  - getHeaderTable
```
java.util.Vector[] getHeaderTable()
```
    Get the header table
    
    Returns:
    Vector the header names
  - getHeader
```
java.lang.String getHeader(byte[] name)
```
    Get a header
    
    Parameters:
    name - the header name
    
    Returns:
    String the header value
  - containsHeader
```
boolean containsHeader(java.lang.String name)
```
    Returns true is the header with the supplied name is already present
    
    Parameters:
    name - the header name
    
    Returns:
    boolean whether the header is present
  - containsHeader
```
boolean containsHeader(byte[] name)
```
    Returns true if the header with the supplied name is already present
    
    Parameters:
    name - the header name
    
    Returns:
    boolean whether the header is present
  - removeHeader
```
void removeHeader(java.lang.String name)
```
    Removes the header with the given name
    
    Parameters:
    name - the header name
  - removeHeader
```
void removeHeader(byte[] name)
```
    Removes the header with the given name
    
    Parameters:
    name - the header name
  - clearHeaders
```
void clearHeaders()
```
    Clears the headers datastructure
  - getWCCRequest
```
IRequest getWCCRequest()
```
    Get the webcontainer channel request object for this response
    
    Returns:
    IWCCRequest the associated request for this response
  - setFlushMode
```
void setFlushMode(boolean flushToWire)
```
    Sets the flush mode. When set to true, the subsequent flush calls *must* write the contents to the wire. Otherwise, the contents written can be buffered by the underlying layer.
    
    Parameters:
    flushToWire -
  - getFlushMode
```
boolean getFlushMode()
```
    Gets the flush mode.
    
    Returns:
    flushToWire
  - flushBufferedContent
```
void flushBufferedContent()
```
    Flushes the contents to wire
  - setReason
```
void setReason(java.lang.String reason)
```
    Sets the reason in the response.
    
    Parameters:
    reason -
  - setReason
```
void setReason(byte[] reason)
```
    Sets the reason in the response.
    
    Parameters:
    reason -
  - addCookie
```
void addCookie(javax.servlet.http.Cookie cookie)
```
    Add a cookie to the response.
    
    Parameters:
    cookie -
  - getCookies
```
javax.servlet.http.Cookie[] getCookies()
```
    Get all the cookies for the response
    
    Returns:
    Cookie[] containing all the Cookies.
  - prepareHeadersForWrite
```
void prepareHeadersForWrite()
```
    Prepare to write the headers
  - writeHeaders
```
void writeHeaders()
```
    Write the headers
  - setHeader
```
void setHeader(java.lang.String name,
             java.lang.String s)
```
    Parameters:
    name -
    s -
  - setHeader
```
void setHeader(byte[] name,
             byte[] bs)
```
    Parameters:
    name -
    bs -
  - setContentType
```
void setContentType(java.lang.String value)
```
    Set the content type for the response
    
    Parameters:
    value -
  - setContentType
```
void setContentType(byte[] value)
```
    Set the content type for the response
    
    Parameters:
    value -
  - setContentLanguage
```
void setContentLanguage(java.lang.String value)
```
    Set the content language for the response
    
    Parameters:
    value -
  - setContentLanguage
```
void setContentLanguage(byte[] value)
```
    Set the content language for the response
    
    Parameters:
    value -
  - setAllocateDirect
```
void setAllocateDirect(boolean allocateDirect)
```
    Set whether to allocate direct or indirect byte buffers
    
    Parameters:
    allocateDirect -
  - isAllocateDirect
```
boolean isAllocateDirect()
```
    Get whether to allocate direct or indirect byte buffers
  - setLastBuffer
```
void setLastBuffer(boolean writeLastBuffer)
```
    Set the last buffer mode
    
    Parameters:
    writeLastBuffer -
  - releaseChannel
```
void releaseChannel()
```
  - removeCookie
```
void removeCookie(java.lang.String cookieName)
```

setStatusCode

getOutputStream

isCommitted

addHeader

addHeader

addDateHeader

addIntHeader

setDateHeader

setIntHeader

getHeaderNames

getHeaders

getHeader

getHeaderTable

getHeader

containsHeader

containsHeader

removeHeader

removeHeader

clearHeaders

getWCCRequest

setFlushMode

getFlushMode

flushBufferedContent

setReason

setReason

addCookie

getCookies

prepareHeadersForWrite

writeHeaders

setHeader

setHeader

setContentType

setContentType

setContentLanguage

setContentLanguage

setAllocateDirect

isAllocateDirect

setLastBuffer

releaseChannel

removeCookie