org.apache.jackrabbit.webdav.ordering

Interface OrderingDavServletRequest

All Superinterfaces:

DavServletRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

All Known Subinterfaces:

WebdavRequest

All Known Implementing Classes:

WebdavRequestImpl

public interface OrderingDavServletRequest
extends DavServletRequest

OrderingDavServletRequest provides extensions to the DavServletRequest interface used for ordering members of orderable collections.

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
String	getOrderingType() Returns the Ordering-Type header.
OrderPatch	getOrderPatch() Return a OrderPatch object encapsulating the request body of an ORDERPATCH request or null if the request body was either missing or could not be parsed.
Position	getPosition() Return a Position object encapsulating the Position header field or null if no Position header is present or does not contain a valid format.

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

getOrderingType

String getOrderingType()

Returns the Ordering-Type header.

Returns:

the String value of the Ordering-Type header.

getPosition

Position getPosition()

Return a Position object encapsulating the Position header field or null if no Position header is present or does not contain a valid format.

Returns:

Position object encapsulating the Position header

getOrderPatch

OrderPatch getOrderPatch()
                  throws DavException

Return a OrderPatch object encapsulating the request body of an ORDERPATCH request or null if the request body was either missing or could not be parsed.

Returns:

OrderPatch object encapsulating the request body.

Throws:

DavException