com.ibm.websphere.servlet.response

Interface IResponse


  1. 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

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

Method Detail

setStatusCode

  1. void setStatusCode(int code)
Sets the HTTP status code
Parameters:
code - the HTTP status code

getOutputStream

  1. java.io.OutputStream getOutputStream( )
  2. throws java.io.IOException
Get the OutputStream
Returns:
OutputStream the output stream
Throws:
java.io.IOException

isCommitted

  1. boolean isCommitted()
Check if the response is committed yet
Returns:
boolean whether or not the response is committed

addHeader

  1. void addHeader(java.lang.String name,
  2. java.lang.String value)
Add a header
Parameters:
name - the name of the header

addHeader

  1. void addHeader(byte[] name,
  2. byte[] value)
Add a header
Parameters:
name - the name of the header
value - the value of the header

addDateHeader

  1. void addDateHeader(java.lang.String name,
  2. long t)
Add a header as a long value
Parameters:
name - the header name
t - the header date value

addIntHeader

  1. void addIntHeader(java.lang.String name,
  2. int i)
Add a header as an int value
Parameters:
name - the header name
i - the header int value

setDateHeader

  1. void setDateHeader(java.lang.String name,
  2. long t)
Set date header as a long value
Parameters:
name - the header name
t - the header date value

setIntHeader

  1. void setIntHeader(java.lang.String name,
  2. int i)
Set a header as an int
Parameters:
name - the header name
i - the header int value

getHeaderNames

  1. java.util.Enumeration getHeaderNames( )
Gets all the header names (keys)
Returns:
Collection of header names

getHeaders

  1. java.util.Enumeration getHeaders( java.lang.String name)
Gets all the header values for a particular header name
Returns:
Collection of header v

getHeader

  1. java.lang.String getHeader(java.lang.String name)
Get a header
Parameters:
name - the header name
Returns:
String the header value

getHeaderTable

  1. java.util.Vector[] getHeaderTable( )
Get the header table
Returns:
Vector the header names

getHeader

  1. java.lang.String getHeader(byte[] name)
Get a header
Parameters:
name - the header name
Returns:
String the header value

containsHeader

  1. 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

  1. 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

  1. void removeHeader(java.lang.String name)
Removes the header with the given name
Parameters:
name - the header name

removeHeader

  1. void removeHeader(byte[] name)
Removes the header with the given name
Parameters:
name - the header name

clearHeaders

  1. void clearHeaders()
Clears the headers datastructure

getWCCRequest

  1. IRequest getWCCRequest()
Get the webcontainer channel request object for this response
Returns:
IWCCRequest the associated request for this response

setFlushMode

  1. 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

  1. boolean getFlushMode()
Gets the flush mode.
Returns:
flushToWire

flushBufferedContent

  1. void flushBufferedContent()
Flushes the contents to wire

setReason

  1. void setReason(java.lang.String reason)
Sets the reason in the response.
Parameters:
reason -

setReason

  1. void setReason(byte[] reason)
Sets the reason in the response.
Parameters:
reason -

addCookie

  1. void addCookie(javax.servlet.http.Cookie cookie)
Add a cookie to the response.
Parameters:
cookie -

getCookies

  1. javax.servlet.http.Cookie[] getCookies( )
Get all the cookies for the response
Returns:
Cookie[] containing all the Cookies.

prepareHeadersForWrite

  1. void prepareHeadersForWrite()
Prepare to write the headers

writeHeaders

  1. void writeHeaders()
Write the headers

setHeader

  1. void setHeader(java.lang.String name,
  2. java.lang.String s)
Parameters:
name -
s -

setHeader

  1. void setHeader(byte[] name,
  2. byte[] bs)
Parameters:
name -
bs -

setContentType

  1. void setContentType(java.lang.String value)
Set the content type for the response
Parameters:
value -

setContentType

  1. void setContentType(byte[] value)
Set the content type for the response
Parameters:
value -

setContentLanguage

  1. void setContentLanguage(java.lang.String value)
Set the content language for the response
Parameters:
value -

setContentLanguage

  1. void setContentLanguage(byte[] value)
Set the content language for the response
Parameters:
value -

setAllocateDirect

  1. void setAllocateDirect(boolean allocateDirect)
Set whether to allocate direct or indirect byte buffers
Parameters:
allocateDirect -

isAllocateDirect

  1. boolean isAllocateDirect()
Get whether to allocate direct or indirect byte buffers

setLastBuffer

  1. void setLastBuffer(boolean writeLastBuffer)
Set the last buffer mode
Parameters:
writeLastBuffer -

releaseChannel

  1. void releaseChannel()

removeCookie

  1. void removeCookie(java.lang.String cookieName)