com.ibm.xdms.xcap
Interface XcapServerRequest

All Superinterfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
All Known Implementing Classes:
XcapServerRequestWrapper

public interface XcapServerRequest
extends javax.servlet.http.HttpServletRequest

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


Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Method Summary
 ApplicationUsage getApplicationUsage()
          Returns the current ApplicationUsage associated with the AUID.
 java.lang.String getAuid()
          Returns the AUID.
 java.lang.String getContentType()
          Returns the content type for this request
 com.ibm.xcap.DocumentSelector getDocumentSelector()
          Returns the Document Selector for this request
 com.ibm.xcap.NodeSelector getNodeSelector()
          Returns the NodeSelector.
 XcapCaps getXcapCaps()
          Returns the XcapCaps object containing information from the xcap-caps.xml for this XDMS.
 java.lang.String getXcapRoot()
          Returns the XCAP Root.
 java.net.URL getXcapURI()
          Returns the XCAP URI
 java.lang.String getXml()
          Returns the xml.
 java.lang.String getXmlName()
          Returns the xmlName.
 java.lang.String getXui()
          Returns the xui.
 boolean isGlobalDocument()
          Returns the isGlobalDocument.
 void setXcapURI(java.lang.String xcapURI)
          Sets the full XCAP URI used to send the XCAP request.
 
Methods inherited from interface javax.servlet.http.HttpServletRequest
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole
 
Methods inherited from interface javax.servlet.ServletRequest
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Copyright

Method Detail

setXcapURI

void setXcapURI(java.lang.String xcapURI)
                throws java.net.MalformedURLException
Sets the full XCAP URI used to send the XCAP request. Must be of the form: http(s)://hostname:hostport/contextRoot/AUID/xcapDocSelector/~~/xcapNodeSelector

Parameters:
xcapURI - The full XCAP URI used to send the XCAP request.
Throws:
java.net.MalformedURLException

getXcapURI

java.net.URL getXcapURI()
Returns the XCAP URI

Returns:
XCAP URI, as a URL Object

getXcapRoot

java.lang.String getXcapRoot()
Returns the XCAP Root.

Returns:
String

getAuid

java.lang.String getAuid()
Returns the AUID.

Returns:
String

getContentType

java.lang.String getContentType()
Returns the content type for this request

Specified by:
getContentType in interface javax.servlet.ServletRequest
Returns:
Content Type

isGlobalDocument

boolean isGlobalDocument()
Returns the isGlobalDocument.

Returns:
boolean

getXui

java.lang.String getXui()
Returns the xui.

Returns:
String

getXmlName

java.lang.String getXmlName()
Returns the xmlName.

Returns:
String

getNodeSelector

com.ibm.xcap.NodeSelector getNodeSelector()
Returns the NodeSelector.

Returns:
NodeSelector

getXml

java.lang.String getXml()
Returns the xml.

Returns:
String

getXcapCaps

XcapCaps getXcapCaps()
Returns the XcapCaps object containing information from the xcap-caps.xml for this XDMS.

Returns:
Returns the XcapCaps object containing information from the xcap-caps.xml for this XDMS.

getApplicationUsage

ApplicationUsage getApplicationUsage()
Returns the current ApplicationUsage associated with the AUID.

Returns:
Returns the current ApplicationUsage associated with the AUID.

getDocumentSelector

com.ibm.xcap.DocumentSelector getDocumentSelector()
Returns the Document Selector for this request

Returns:
Returns the Document Selector for this request