com.ibm.xdms.xcap
Interface XcapServerResponse

All Superinterfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
All Known Implementing Classes:
XcapServerResponseWrapper

public interface XcapServerResponse
extends javax.servlet.http.HttpServletResponse

XCAP Server Response Object which is passed between XcapFilters. This object frontends the HttpServletResponse while providing XCAP specific convienence methods


Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Fields inherited from interface javax.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY
 
Method Summary
 int getContentLength()
          Returns the content length
 long getCurrentETag()
          Returns the current ETag for the XML response
 javax.servlet.http.HttpServletResponse getHttpServletResponse()
          Returns the underlying HttpServletResponse.
 long getLastModifiedDate()
          Returns the last modified date for this response
 long getPreviousETag()
          Returns the previous ETag for the XML response
 int getStatus()
          Returns the status code for this response
 java.lang.String getXml()
          Returns the current XML document which will be returned to the client as a String
 void setCurrentETag(long currentETag)
          Sets the current ETag for the XML response
 void setLastModifiedDate(java.lang.Long lastModified)
          Sets the last modified date for this response
 void setPreviousETag(long previousETag)
          Sets the previous ETag for the XML response
 void setStatus(int statusCode)
          Sets the status code for this response
 void setXml(java.lang.String xml)
          Sets the response XML.
 
Methods inherited from interface javax.servlet.http.HttpServletResponse
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus
 
Methods inherited from interface javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Copyright

Method Detail

setXml

void setXml(java.lang.String xml)
Sets the response XML.

Parameters:
xml - The XML response.

getXml

java.lang.String getXml()
Returns the current XML document which will be returned to the client as a String

Returns:
XML Document as a String

getContentLength

int getContentLength()
Returns the content length

Returns:
Returns the content length

setCurrentETag

void setCurrentETag(long currentETag)
Sets the current ETag for the XML response

Parameters:
currentETag - The current ETag for the XML response

getCurrentETag

long getCurrentETag()
Returns the current ETag for the XML response

Returns:
Current ETag for the XML response

setStatus

void setStatus(int statusCode)
Sets the status code for this response

Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse
Parameters:
statusCode - New status code

setPreviousETag

void setPreviousETag(long previousETag)
Sets the previous ETag for the XML response

Parameters:
previousETag - The previous ETag for the XML response

getPreviousETag

long getPreviousETag()
Returns the previous ETag for the XML response

Returns:
Previous ETag for the XML response

getStatus

int getStatus()
Returns the status code for this response

Returns:
The status code for this response

setLastModifiedDate

void setLastModifiedDate(java.lang.Long lastModified)
Sets the last modified date for this response

Parameters:
lastModified - Last modified date

getLastModifiedDate

long getLastModifiedDate()
Returns the last modified date for this response

Returns:
The last modified date for this response

getHttpServletResponse

javax.servlet.http.HttpServletResponse getHttpServletResponse()
Returns the underlying HttpServletResponse. Use available methods in this class before calling methods in the underlying HttpServletResponse.

Returns:
Returns the HttpServletResponse