com.ibm.websphere.servlet.response
Interface IResponse
-
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 valuevoid
addHeader(byte[] name, byte[] value)
Add a headervoid
addHeader(java.lang.String name, java.lang.String value)
Add a headervoid
addIntHeader(java.lang.String name, int i)
Add a header as an int valuevoid
clearHeaders()
Clears the headers datastructureboolean
containsHeader(byte[] name)
Returns true if the header with the supplied name is already presentboolean
containsHeader(java.lang.String name)
Returns true is the header with the supplied name is already presentvoid
flushBufferedContent()
Flushes the contents to wirejavax.servlet.http.Cookie[]
getCookies()
Get all the cookies for the responseboolean
getFlushMode()
Gets the flush mode.java.lang.String
getHeader(byte[] name)
Get a headerjava.lang.String
getHeader(java.lang.String name)
Get a headerjava.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 namejava.util.Vector[]
getHeaderTable()
Get the header tablejava.io.OutputStream
getOutputStream()
Get the OutputStreamIRequest
getWCCRequest()
Get the webcontainer channel request object for this responseboolean
isAllocateDirect()
Get whether to allocate direct or indirect byte buffersboolean
isCommitted()
Check if the response is committed yetvoid
prepareHeadersForWrite()
Prepare to write the headersvoid
releaseChannel()
void
removeCookie(java.lang.String cookieName)
void
removeHeader(byte[] name)
Removes the header with the given namevoid
removeHeader(java.lang.String name)
Removes the header with the given namevoid
setAllocateDirect(boolean allocateDirect)
Set whether to allocate direct or indirect byte buffersvoid
setContentLanguage(byte[] value)
Set the content language for the responsevoid
setContentLanguage(java.lang.String value)
Set the content language for the responsevoid
setContentType(byte[] value)
Set the content type for the responsevoid
setContentType(java.lang.String value)
Set the content type for the responsevoid
setDateHeader(java.lang.String name, long t)
Set date header as a long valuevoid
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 intvoid
setLastBuffer(boolean writeLastBuffer)
Set the last buffer modevoid
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 codevoid
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 headername
- the value of the header
-
addHeader
void addHeader(byte[] name, byte[] value)
Add a header- Parameters:
name
- the name of the headervalue
- 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 namet
- the header date value
-
addIntHeader
void addIntHeader(java.lang.String name, int i)
Add a header as an int value- Parameters:
name
- the header namei
- the header int value
-
setDateHeader
void setDateHeader(java.lang.String name, long t)
Set date header as a long value- Parameters:
name
- the header namet
- the header date value
-
setIntHeader
void setIntHeader(java.lang.String name, int i)
Set a header as an int- Parameters:
name
- the header namei
- 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)
-
-