Package org.apache.jackrabbit.webdav.version

Interface DeltaVServletRequest

All Superinterfaces:

DavServletRequest, HttpServletRequest, ServletRequest

All Known Subinterfaces:

WebdavRequest

All Known Implementing Classes:

WebdavRequestImpl

public interface DeltaVServletRequest
extends DavServletRequest

DeltaVServletRequest provides extension useful for functionality related to RFC 3253.

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	Description
java.lang.String	getLabel()	Returns the Label header or null
LabelInfo	getLabelInfo()	Return the request body as LabelInfo object or null if parsing the request body or the creation of the label info failed.
MergeInfo	getMergeInfo()	Return the request body as MergeInfo object or null if the creation failed due to invalid format.
OptionsInfo	getOptionsInfo()	Returns the OptionsInfo present with the request or null.
ReportInfo	getReportInfo()	Returns the request body and the Depth header as ReportInfo object.
UpdateInfo	getUpdateInfo()	Parses the UPDATE request body a build the corresponding UpdateInfo object.

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

getLabel

java.lang.String getLabel()

Returns the Label header or null

Returns:

label header or null

See Also:

DeltaVConstants.HEADER_LABEL

getLabelInfo

LabelInfo getLabelInfo()
                throws DavException

Return the request body as LabelInfo object or null if parsing the request body or the creation of the label info failed.

Returns:

LabelInfo object or null

Throws:

DavException - in case of an invalid request body

getMergeInfo

MergeInfo getMergeInfo()
                throws DavException

Return the request body as MergeInfo object or null if the creation failed due to invalid format.

Returns:

MergeInfo object or null

Throws:

DavException - in case of an invalid request body

getUpdateInfo

UpdateInfo getUpdateInfo()
                  throws DavException

Parses the UPDATE request body a build the corresponding UpdateInfo object. If the request body is missing or does not of the required format null is returned.

Returns:

the parsed update request body or null

Throws:

DavException - in case of an invalid request body

getReportInfo

ReportInfo getReportInfo()
                  throws DavException

Returns the request body and the Depth header as ReportInfo object. The default depth, if no Depth header, is DavConstants.DEPTH_0. If the request body could not be parsed into an Element null is returned.

Returns:

ReportInfo or null

Throws:

DavException - in case of an invalid request body

getOptionsInfo

OptionsInfo getOptionsInfo()
                    throws DavException

Returns the OptionsInfo present with the request or null.

Returns:

OptionsInfo or null

Throws:

DavException - in case of an invalid request body