org.apache.jackrabbit.webdav.observation

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 the DavServletRequest interface used for dealing with observation.

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Method Summary

Modifier and Type	Method and Description
long	getPollTimeout() Returns the PollTimeout header or 0 (zero) if no such header is present.
String	getSubscriptionId() Return the SubscriptionId header or null if no such header is present.
SubscriptionInfo	getSubscriptionInfo() Return a SubscriptionInfo object representing the subscription info present in the SUBSCRIBE request body or null 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

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, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Method Detail

getSubscriptionId

String getSubscriptionId()

Return the SubscriptionId header or null if no such header is present.

Returns:

the SubscriptionId header

getPollTimeout

long getPollTimeout()

Returns the PollTimeout header or 0 (zero) if no such header is present.

Returns:

milliseconds indicating length of the poll timeout.

getSubscriptionInfo

SubscriptionInfo getSubscriptionInfo()
                              throws DavException

Return a SubscriptionInfo object representing the subscription info present in the SUBSCRIBE request body or null 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.