Interface ObservationDavServletRequest
-
- All Superinterfaces:
DavServletRequest
,javax.servlet.http.HttpServletRequest
,javax.servlet.ServletRequest
- All Known Subinterfaces:
WebdavRequest
- All Known Implementing Classes:
WebdavRequestImpl
public interface ObservationDavServletRequest extends DavServletRequest
ObservationDavServletRequest
provides extensions to theDavServletRequest
interface used for dealing with observation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getPollTimeout()
Returns thePollTimeout header
or 0 (zero) if no such header is present.String
getSubscriptionId()
Return theSubscriptionId header
ornull
if no such header is present.SubscriptionInfo
getSubscriptionInfo()
Return aSubscriptionInfo
object representing the subscription info present in the SUBSCRIBE request body ornull
if retrieving the subscription info fails.-
Methods inherited from interface org.apache.jackrabbit.webdav.DavServletRequest
getDavSession, getDepth, getDepth, getDestinationLocator, getLockInfo, getLockToken, getPropFindProperties, getPropFindType, getPropPatchChangeList, getRequestDocument, getRequestLocator, getTimeout, isOverwrite, matchesIfHeader, matchesIfHeader, setDavSession
-
Methods inherited from interface javax.servlet.http.HttpServletRequest
authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade
-
Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync
-
-
-
-
Method Detail
-
getSubscriptionId
String getSubscriptionId()
Return theSubscriptionId header
ornull
if no such header is present.- Returns:
- the
SubscriptionId header
-
getPollTimeout
long getPollTimeout()
Returns thePollTimeout header
or 0 (zero) if no such header is present.- Returns:
- milliseconds indicating length of the poll timeout.
-
getSubscriptionInfo
SubscriptionInfo getSubscriptionInfo() throws DavException
Return aSubscriptionInfo
object representing the subscription info present in the SUBSCRIBE request body ornull
if retrieving the subscription info fails.- Returns:
- subscription info object encapsulating the SUBSCRIBE request body
or
null
if the subscription info cannot be built. - Throws:
DavException
- if an invalid request body was encountered.
-
-