IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.soapcontainer
Interface SOAPResponse


public interface SOAPResponse

This is the interface that is supported by the SOAP Container to represent a response object. The SOAP Container will call the methods of this interface while processing a request/response.


Method Summary
 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
 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 finishResponse()
          This method triggers the completion of the response.
 void flushBufferedContent()
          Cause the current buffers to be written immediately.
 javax.servlet.http.Cookie[] getCookies()
          Get all the cookies for the response
 java.lang.String getHeader(byte[] name)
          Get a header
 java.lang.String getHeader(java.lang.String name)
          Get a header
 java.io.OutputStream getOutputStream()
          Get the OutputStream
 SOAPRequest getRequest()
          Get the webcontainer channel request object for this response
 boolean isCommitted()
          Check if the response is committed yet
 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 setContentLength(int value)
          Sets the "content length" header in the response.
 void setContentType(java.lang.String value)
          Sets the "content type" header in 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 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
 

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
value - 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

getHeader

java.lang.String getHeader(java.lang.String name)
Get a header

Parameters:
name - the header name
Returns:
String the header value

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

getRequest

SOAPRequest getRequest()
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 -

setContentType

void setContentType(java.lang.String value)
Sets the "content type" header in the response.

Parameters:
value -

setContentLength

void setContentLength(int value)
Sets the "content length" header in the response.

Parameters:
value -

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.

setHeader

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

setHeader

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

flushBufferedContent

void flushBufferedContent()
Cause the current buffers to be written immediately.


finishResponse

void finishResponse()
This method triggers the completion of the response.


IBM WebSphere Application ServerTM
Release 8