|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
com.ibm.xdms.xcap.XcapServerRequestWrapper
public class XcapServerRequestWrapper
Provides a convenient implementation of the XcapServerRequest interface that can be subclassed by developers wishing to adapt the request to a XcapFilter. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.
XcapServerRequest
Field Summary |
---|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
XcapServerRequestWrapper(XcapServerRequest request)
Constructs a request object wrapping the given request. |
Method Summary | |
---|---|
ApplicationUsage |
getApplicationUsage()
Default behavior is to return getApplicationUsage() on the wrapped request |
java.lang.String |
getAuid()
Default behavior is to return getAuid() on the wrapped request |
com.ibm.xcap.DocumentSelector |
getDocumentSelector()
Default behavior is to return getDocumentSelector() on the wrapped request |
com.ibm.xcap.NodeSelector |
getNodeSelector()
Default behavior is to return getNodeSelector() on the wrapped request |
XcapCaps |
getXcapCaps()
Default behavior is to return getXcapCaps() on the wrapped request |
java.lang.String |
getXcapRoot()
Default behavior is to return getXcapRoot() on the wrapped request |
java.net.URL |
getXcapURI()
Default behavior is to return getXcapURI() on the wrapped request |
java.lang.String |
getXml()
Default behavior is to return getXml() on the wrapped request |
java.lang.String |
getXmlName()
Default behavior is to return getXmlName() on the wrapped request |
java.lang.String |
getXui()
Default behavior is to return getXui() on the wrapped request |
boolean |
isGlobalDocument()
Default behavior is to return isGlobalDocument() on the wrapped request |
void |
setXcapURI(java.lang.String xcapURI)
Default behavior is to call setXcapURI() on the wrapped request |
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper |
---|
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 class javax.servlet.ServletRequestWrapper |
---|
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.xdms.xcap.XcapServerRequest |
---|
getContentType |
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 |
Constructor Detail |
---|
public XcapServerRequestWrapper(XcapServerRequest request)
request
- XcapServletRequest to wrap
java.lang.IllegalArgumentException
- if the request is nullMethod Detail |
---|
public ApplicationUsage getApplicationUsage()
getApplicationUsage
in interface XcapServerRequest
XcapServerRequest.getApplicationUsage()
public java.lang.String getAuid()
getAuid
in interface XcapServerRequest
XcapServerRequest.getAuid()
public com.ibm.xcap.DocumentSelector getDocumentSelector()
getDocumentSelector
in interface XcapServerRequest
XcapServerRequest.getDocumentSelector()
public com.ibm.xcap.NodeSelector getNodeSelector()
getNodeSelector
in interface XcapServerRequest
XcapServerRequest.getNodeSelector()
public XcapCaps getXcapCaps()
getXcapCaps
in interface XcapServerRequest
XcapServerRequest.getXcapCaps()
public java.lang.String getXcapRoot()
getXcapRoot
in interface XcapServerRequest
XcapServerRequest.getXcapRoot()
public java.net.URL getXcapURI()
getXcapURI
in interface XcapServerRequest
XcapServerRequest.getXcapURI()
public java.lang.String getXml()
getXml
in interface XcapServerRequest
XcapServerRequest.getXml()
public java.lang.String getXmlName()
getXmlName
in interface XcapServerRequest
XcapServerRequest.getXmlName()
public java.lang.String getXui()
getXui
in interface XcapServerRequest
XcapServerRequest.getXui()
public boolean isGlobalDocument()
isGlobalDocument
in interface XcapServerRequest
XcapServerRequest.isGlobalDocument()
public void setXcapURI(java.lang.String xcapURI) throws java.net.MalformedURLException
setXcapURI
in interface XcapServerRequest
xcapURI
- The full XCAP URI used to send the XCAP request.
java.net.MalformedURLException
XcapServerRequest.setXcapURI(java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |