|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DavServletRequest
DavServletRequest
extends the HttpServletRequest by Webdav
specific METHODS.
Field Summary |
---|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Method Summary | |
---|---|
DavSession |
getDavSession()
Returns the DavSession created for this request. |
int |
getDepth()
Return the integer representation of the given Depth header . |
int |
getDepth(int defaultValue)
Returns the integer representation of the Depth header or the given defaultValue, if the Depth header is missing. |
DavResourceLocator |
getDestinationLocator()
Parse the Destination header
and return the locator of the corresponding resource . |
LockInfo |
getLockInfo()
Return the parsed 'lockinfo' request body, the Timeout header and the Depth header
of a LOCK request as LockInfo object. |
String |
getLockToken()
Returns the token present in the Lock-Token Header or null if no such header is available. |
DavPropertyNameSet |
getPropFindProperties()
Return the set of properties the client requested with a PROPFIND request or an empty set if the type of PROPFIND request was DavConstants.PROPFIND_ALL_PROP
or DavConstants.PROPFIND_PROPERTY_NAMES . |
int |
getPropFindType()
Return the type of PROPFIND request as indicated by the PROPFIND request body. |
List |
getPropPatchChangeList()
Return a List of property change operations. |
DavPropertyNameSet |
getPropPatchRemoveProperties()
Deprecated. use getPropPatchChangeList() instead |
DavPropertySet |
getPropPatchSetProperties()
Deprecated. use getPropPatchChangeList() instead |
Document |
getRequestDocument()
Parse the Xml request body and return a Document . |
DavResourceLocator |
getRequestLocator()
Return the locator of the requested resource . |
long |
getTimeout()
Return the timeout requested in the Timeout header as long . |
boolean |
isOverwrite()
Returns true if the Overwrite header
is set to 'T' thus instructing the server to overwrite the state of a
non-null destination resource during a COPY or MOVE. |
boolean |
matchesIfHeader(DavResource resource)
Returns true, if the If header present
with the request matches the given resource. |
boolean |
matchesIfHeader(String href,
String token,
String eTag)
Returns true, if the If header present
with the request matches to the given href, token and eTag. |
void |
setDavSession(DavSession session)
Sets the DavSession to this request. |
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 |
---|
void setDavSession(DavSession session)
DavSession
to this request.
session
- DavSession getDavSession()
DavSession
created for this request.
DavResourceLocator getRequestLocator()
resource
.
resource
.DavResourceLocator getDestinationLocator() throws DavException
Destination header
and return the locator of the corresponding resource
.
DavException
DavConstants.HEADER_DESTINATION
boolean isOverwrite()
Overwrite header
is set to 'T' thus instructing the server to overwrite the state of a
non-null destination resource during a COPY or MOVE. A Overwrite header
value of 'F' will return false.
DavConstants.HEADER_OVERWRITE
int getDepth()
Depth header
. 'Infinity' is represented by DavConstants.DEPTH_INFINITY
.
Depth header
.DavConstants.HEADER_DEPTH
int getDepth(int defaultValue)
Depth header
or the given defaultValue, if the Depth header is missing.
defaultValue
- to be returned if no Depth header is present.
Depth header
or the given defaultValue.DavConstants.HEADER_DEPTH
String getLockToken()
Lock-Token Header
or null
if no such header is available.
DavConstants.HEADER_LOCK_TOKEN
long getTimeout()
Timeout header
as long
. The representation of the
'Infinite' timeout is left to the implementation.
DavConstants.HEADER_TIMEOUT
,
DavConstants.TIMEOUT_INFINITE
Document getRequestDocument() throws DavException
Document
.
null
if no request body is present.
DavException
- If the request body cannot be parsed into an Xml
Document.int getPropFindType() throws DavException
DavException
- If the propfind type could not be determined due to
an invalid request body.DavConstants.PROPFIND_ALL_PROP
,
DavConstants.PROPFIND_BY_PROPERTY
,
DavConstants.PROPFIND_PROPERTY_NAMES
,
DavConstants.PROPFIND_ALL_PROP_INCLUDE
DavPropertyNameSet getPropFindProperties() throws DavException
DavConstants.PROPFIND_ALL_PROP
or DavConstants.PROPFIND_PROPERTY_NAMES
.
DavException
- In case of invalid request bodyDavPropertySet getPropPatchSetProperties() throws DavException
getPropPatchChangeList()
instead
DavException
- In case of invalid request bodyDavPropertyNameSet getPropPatchRemoveProperties() throws DavException
getPropPatchChangeList()
instead
DavPropertyNameSet
is returned and not a DavPropertySet
DavException
- In case of invalid request bodyList getPropPatchChangeList() throws DavException
List
of property change operations. Each entry
is either of type DavPropertyName
, indicating a <remove>
operation, or of type DavProperty
, indicating a <set>
operation. Note that ordering is significant here.
List
of property change operations
DavException
- In case of invalid request bodyLockInfo getLockInfo() throws DavException
Timeout header
and the Depth header
of a LOCK request as LockInfo
object.
LockInfo
object encapsulating the information
present in the LOCK request.
DavException
DavConstants.HEADER_TIMEOUT
,
DavConstants.HEADER_DEPTH
,
DavConstants.XML_LOCKINFO
boolean matchesIfHeader(DavResource resource)
If header
present
with the request matches the given resource.
resource
-
boolean matchesIfHeader(String href, String token, String eTag)
If header
present
with the request matches to the given href, token and eTag.
href
- token
- eTag
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |