WebdavRequestImpl (Apache Jackrabbit 2.20.16 API)

java.lang.Object
- org.apache.jackrabbit.webdav.WebdavRequestImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, BindServletRequest, ContentCodingAwareRequest, DavConstants, DavServletRequest, ObservationDavServletRequest, OrderingDavServletRequest, TransactionDavServletRequest, DeltaVServletRequest, WebdavRequest
```
public class WebdavRequestImpl
extends Object
implements WebdavRequest, DavConstants, ContentCodingAwareRequest
```
WebdavRequestImpl...

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
- Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants
  creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE
- Fields inherited from interface org.apache.jackrabbit.webdav.ContentCodingAwareRequest
  PRECONDITION_SUPPORTED

Constructor Summary

Constructors
Constructor and Description
`WebdavRequestImpl(javax.servlet.http.HttpServletRequest httpRequest, DavLocatorFactory factory)` Creates a new `DavServletRequest` with the given parameters.
`WebdavRequestImpl(javax.servlet.http.HttpServletRequest httpRequest, DavLocatorFactory factory, boolean createAbsoluteURI)` Creates a new `DavServletRequest` with the given parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`String`	`getAcceptableCodings()`
`javax.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String s)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`BindInfo`	`getBindInfo()` Returns the `BindInfo` present with the request
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String s)`
`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 field and return the path of the destination resource.
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String s)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String s)`
`DavResourceLocator`	`getHrefLocator(String href)` Parse a href and return the path of the resource.
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String s)`
`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.
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`LockInfo`	`getLockInfo()` `LockInfo` object encapsulating the information passed with a LOCK request if the LOCK request body was valid.
`String`	`getLockToken()` Retrieve the lock token from the 'Lock-Token' header.
`DavResourceLocator`	`getMemberLocator(String segment)` Returns the path of the member resource of the request resource which is identified by the segment parameter.
`MergeInfo`	`getMergeInfo()` Return the request body as `MergeInfo` object or `null` if the creation failed due to invalid format.
`String`	`getMethod()`
`OptionsInfo`	`getOptionsInfo()` Returns the `OptionsInfo` present with the request or `null`.
`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.
`String`	`getParameter(String s)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String s)`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`long`	`getPollTimeout()` Returns the `PollTimeout header` or 0 (zero) if no such header is present.
`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.
`DavPropertyNameSet`	`getPropFindProperties()` Returns the set of properties requested by the PROPFIND body or an empty set if the `type` is either 'allprop' or 'propname'.
`int`	`getPropFindType()` Returns the type of PROPFIND as indicated by the request body.
`List<? extends PropEntry>`	`getPropPatchChangeList()` Return a `List` of property change operations.
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String s)`
`RebindInfo`	`getRebindInfo()` Returns the `RebindInfo` present with the request
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`ReportInfo`	`getReportInfo()` Returns the request body and the Depth header as `ReportInfo` object.
`List<String>`	`getRequestContentCodings()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String s)`
`Document`	`getRequestDocument()` Parse the Xml request body and return a `Document`.
`String`	`getRequestedSessionId()`
`DavResourceLocator`	`getRequestLocator()` Return a `DavResourceLocator` representing the request handle.
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean b)`
`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.
`long`	`getTimeout()` Parse the Timeout header and return a long representing the value.
`String`	`getTransactionId()` Retrieve the transaction id from the `TransactionId header`.
`TransactionInfo`	`getTransactionInfo()` Retrieve the 'transactioninfo' request body that must be included with the UNLOCK request of a transaction lock.
`UnbindInfo`	`getUnbindInfo()` Returns the `UnbindInfo` present with the request
`UpdateInfo`	`getUpdateInfo()` Parses the UPDATE request body a build the corresponding `UpdateInfo` object.
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isOverwrite()` Return true if the overwrite header does not inhibit overwriting.
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String s)`
`void`	`login(String username, String password)`
`void`	`logout()`
`boolean`	`matchesIfHeader(DavResource resource)` Test if the if header 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`	`removeAttribute(String s)`
`void`	`setAttribute(String s, Object o)`
`void`	`setCharacterEncoding(String s)`
`void`	`setDavSession(DavSession session)` Sets the session field and adds all lock tokens present with either the Lock-Token header or the If header to the given session object.
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebdavRequestImpl
```
public WebdavRequestImpl(javax.servlet.http.HttpServletRequest httpRequest,
                         DavLocatorFactory factory)
```
    Creates a new DavServletRequest with the given parameters.
  - WebdavRequestImpl
```
public WebdavRequestImpl(javax.servlet.http.HttpServletRequest httpRequest,
                         DavLocatorFactory factory,
                         boolean createAbsoluteURI)
```
    Creates a new DavServletRequest with the given parameters.
    
    Parameters:
    
    httpRequest -
    
    factory -
    
    createAbsoluteURI - defines if we must create a absolute URI. if false a absolute path will be created
- Method Detail
  - setDavSession
```
public void setDavSession(DavSession session)
```
    Sets the session field and adds all lock tokens present with either the Lock-Token header or the If header to the given session object.
    
    Specified by:
    
    setDavSession in interface DavServletRequest
    
    Parameters:
    
    session -
    
    See Also:
    
    DavServletRequest.setDavSession(DavSession)
  - getDavSession
```
public DavSession getDavSession()
```
    Description copied from interface: DavServletRequest
    
    Returns the DavSession created for this request.
    
    Specified by:
    
    getDavSession in interface DavServletRequest
    
    Returns:
    
    session for this resource
    
    See Also:
    
    DavServletRequest.getDavSession()
  - getRequestLocator
```
public DavResourceLocator getRequestLocator()
```
    Return a DavResourceLocator representing the request handle.
    
    Specified by:
    
    getRequestLocator in interface DavServletRequest
    
    Returns:
    
    locator of the requested resource
    
    See Also:
    
    DavServletRequest.getRequestLocator()
  - getDestinationLocator
```
public DavResourceLocator getDestinationLocator()
                                         throws DavException
```
    Parse the destination header field and return the path of the destination resource.
    
    Specified by:
    
    getDestinationLocator in interface DavServletRequest
    
    Returns:
    
    path of the destination resource.
    
    Throws:
    
    DavException
    
    See Also:
    
    DavConstants.HEADER_DESTINATION, DavServletRequest.getDestinationLocator()
  - getHrefLocator
```
public DavResourceLocator getHrefLocator(String href)
                                  throws DavException
```
    Parse a href and return the path of the resource.
    
    Specified by:
    
    getHrefLocator in interface BindServletRequest
    
    Returns:
    
    path of the resource identified by the href.
    
    Throws:
    
    DavException
    
    See Also:
    
    BindServletRequest.getHrefLocator(java.lang.String)
  - getMemberLocator
```
public DavResourceLocator getMemberLocator(String segment)
```
    Returns the path of the member resource of the request resource which is identified by the segment parameter.
    
    Specified by:
    
    getMemberLocator in interface BindServletRequest
    
    Returns:
    
    path of internal member resource.
  - isOverwrite
```
public boolean isOverwrite()
```
    Return true if the overwrite header does not inhibit overwriting.
    
    Specified by:
    
    isOverwrite in interface DavServletRequest
    
    Returns:
    
    true if the overwrite header requests 'overwriting'
    
    See Also:
    
    DavConstants.HEADER_OVERWRITE, DavServletRequest.isOverwrite()
  - getDepth
```
public int getDepth(int defaultValue)
```
    Description copied from interface: DavServletRequest
    
    Returns the integer representation of the Depth header or the given defaultValue, if the Depth header is missing.
    
    Specified by:
    
    getDepth in interface DavServletRequest
    
    Parameters:
    
    defaultValue - to be returned if no Depth header is present.
    
    Returns:
    
    integer representation of the Depth header or the given defaultValue.
    
    See Also:
    
    DavServletRequest.getDepth(int)
  - getDepth
```
public int getDepth()
```
    Description copied from interface: DavServletRequest
    
    Return the integer representation of the given Depth header. 'Infinity' is represented by DavConstants.DEPTH_INFINITY.
    
    Specified by:
    
    getDepth in interface DavServletRequest
    
    Returns:
    
    integer representation of the Depth header.
    
    See Also:
    
    DavServletRequest.getDepth()
  - getTimeout
```
public long getTimeout()
```
    Parse the Timeout header and return a long representing the value. DavConstants.UNDEFINED_TIMEOUT is used as default value if no header is available or if the parsing fails.
    
    Specified by:
    
    getTimeout in interface DavServletRequest
    
    Returns:
    
    milliseconds indicating length of the timeout.
    
    See Also:
    
    DavServletRequest.getTimeout(), TimeoutHeader.parse(javax.servlet.http.HttpServletRequest, long)
  - getLockToken
```
public String getLockToken()
```
    Retrieve the lock token from the 'Lock-Token' header.
    
    Specified by:
    
    getLockToken in interface DavServletRequest
    
    Returns:
    
    String representing the lock token sent in the Lock-Token header.
    
    Throws:
    
    IllegalArgumentException - If the value has not the correct format.
    
    See Also:
    
    DavConstants.HEADER_LOCK_TOKEN, DavServletRequest.getLockToken()
  - getRequestDocument
```
public Document getRequestDocument()
                            throws DavException
```
    Description copied from interface: DavServletRequest
    
    Parse the Xml request body and return a Document.
    
    Specified by:
    
    getRequestDocument in interface DavServletRequest
    
    Returns:
    
    Document representing the Xml request body or null if no request body is present.
    
    Throws:
    
    DavException - If the request body cannot be parsed into an Xml Document.
    
    See Also:
    
    DavServletRequest.getRequestDocument()
  - getPropFindType
```
public int getPropFindType()
                    throws DavException
```
    Returns the type of PROPFIND as indicated by the request body.
    
    Specified by:
    
    getPropFindType in interface DavServletRequest
    
    Returns:
    
    type of the PROPFIND request. Default value is allprops
    
    Throws:
    
    DavException - If the propfind type could not be determined due to an invalid request body.
    
    See Also:
    
    DavServletRequest.getPropFindType()
  - getPropFindProperties
```
public DavPropertyNameSet getPropFindProperties()
                                         throws DavException
```
    Returns the set of properties requested by the PROPFIND body or an empty set if the type is either 'allprop' or 'propname'.
    
    Specified by:
    
    getPropFindProperties in interface DavServletRequest
    
    Returns:
    
    set of properties requested by the PROPFIND body or an empty set.
    
    Throws:
    
    DavException - In case of invalid request body
    
    See Also:
    
    DavServletRequest.getPropFindProperties()
  - getRequestContentCodings
```
public List<String> getRequestContentCodings()
```
    Specified by:
    
    getRequestContentCodings in interface ContentCodingAwareRequest
    
    Returns:
    
    content codings used in request
  - getAcceptableCodings
```
public String getAcceptableCodings()
```
    Specified by:
    
    getAcceptableCodings in interface ContentCodingAwareRequest
    
    Returns:
    
    value suitable for Accept response field
  - getPropPatchChangeList
```
public List<? extends PropEntry> getPropPatchChangeList()
                                                 throws DavException
```
    Return a 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.
    
    Specified by:
    
    getPropPatchChangeList in interface DavServletRequest
    
    Returns:
    
    the list of change operations entries in the PROPPATCH request body
    
    Throws:
    
    DavException - In case of invalid request body
    
    See Also:
    
    DavServletRequest.getPropPatchChangeList()
  - getLockInfo
```
public LockInfo getLockInfo()
                     throws DavException
```
    LockInfo object encapsulating the information passed with a LOCK request if the LOCK request body was valid. If the request body is missing a 'refresh lock' request is assumed. The LockInfo then only provides timeout and isDeep property and returns true on LockInfo.isRefreshLock()
    
    Specified by:
    
    getLockInfo in interface DavServletRequest
    
    Returns:
    
    lock info object or null if an error occurred while parsing the request body.
    
    Throws:
    
    DavException - throws a 400 (Bad Request) DavException if a request body is present but does not start with a DAV:lockinfo element. Note however, that a non-existing request body is a valid request used to refresh an existing lock.
    
    See Also:
    
    DavServletRequest.getLockInfo()
  - matchesIfHeader
```
public boolean matchesIfHeader(DavResource resource)
```
    Test if the if header matches the given resource. The comparison is made with the resource href and the token returned from an exclusive write lock present on the resource.
    NOTE: If either the If header or the resource is null or if the resource has not applied an exclusive write lock the preconditions are met. If in contrast the lock applied to the given resource returns a null lock token (e.g. for security reasons) or a lock token that does not match, the method will return false.
    
    Specified by:
    
    matchesIfHeader in interface DavServletRequest
    
    Parameters:
    
    resource - Webdav resources being operated on
    
    Returns:
    
    true if the test is successful and the preconditions for the request processing are fulfilled.
    
    See Also:
    
    DavServletRequest.matchesIfHeader(DavResource), IfHeader.matches(String, String, String), DavResource.hasLock(org.apache.jackrabbit.webdav.lock.Type, org.apache.jackrabbit.webdav.lock.Scope), ActiveLock.getToken()
  - matchesIfHeader
```
public boolean matchesIfHeader(String href,
                               String token,
                               String eTag)
```
    Description copied from interface: DavServletRequest
    
    Returns true, if the If header present with the request matches to the given href, token and eTag.
    
    Specified by:
    
    matchesIfHeader in interface DavServletRequest
    
    Returns:
    
    true, if the test is successful, false otherwise.
    
    See Also:
    
    DavServletRequest.matchesIfHeader(String, String, String), IfHeader.matches(String, String, String)
  - getTransactionId
```
public String getTransactionId()
```
    Description copied from interface: TransactionDavServletRequest
    
    Retrieve the transaction id from the TransactionId header.
    
    Specified by:
    
    getTransactionId in interface TransactionDavServletRequest
    
    Returns:
    
    transaction id as present in the TransactionId header or null.
    
    See Also:
    
    TransactionDavServletRequest.getTransactionId()
  - getTransactionInfo
```
public TransactionInfo getTransactionInfo()
                                   throws DavException
```
    Description copied from interface: TransactionDavServletRequest
    
    Retrieve the 'transactioninfo' request body that must be included with the UNLOCK request of a transaction lock. If the request body is does not provide the information required (either because it is missing or the Xml is not valid) null is returned.
    
    Specified by:
    
    getTransactionInfo in interface TransactionDavServletRequest
    
    Returns:
    
    TransactionInfo object encapsulating the 'transactioninfo' Xml element present in the request body or null if no body is present or if it could not be parsed.
    
    Throws:
    
    DavException - if an invalid request body is present.
    
    See Also:
    
    TransactionDavServletRequest.getTransactionInfo()
  - getSubscriptionId
```
public String getSubscriptionId()
```
    Description copied from interface: ObservationDavServletRequest
    
    Return the SubscriptionId header or null if no such header is present.
    
    Specified by:
    
    getSubscriptionId in interface ObservationDavServletRequest
    
    Returns:
    
    the SubscriptionId header
    
    See Also:
    
    ObservationDavServletRequest.getSubscriptionId()
  - getPollTimeout
```
public long getPollTimeout()
```
    Description copied from interface: ObservationDavServletRequest
    
    Returns the PollTimeout header or 0 (zero) if no such header is present.
    
    Specified by:
    
    getPollTimeout in interface ObservationDavServletRequest
    
    Returns:
    
    milliseconds indicating length of the poll timeout.
    
    See Also:
    
    ObservationDavServletRequest.getPollTimeout()
  - getSubscriptionInfo
```
public SubscriptionInfo getSubscriptionInfo()
                                     throws DavException
```
    Description copied from interface: ObservationDavServletRequest
    
    Return a SubscriptionInfo object representing the subscription info present in the SUBSCRIBE request body or null if retrieving the subscription info fails.
    
    Specified by:
    
    getSubscriptionInfo in interface ObservationDavServletRequest
    
    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.
    
    See Also:
    
    ObservationDavServletRequest.getSubscriptionInfo()
  - getOrderingType
```
public String getOrderingType()
```
    Description copied from interface: OrderingDavServletRequest
    
    Returns the Ordering-Type header.
    
    Specified by:
    
    getOrderingType in interface OrderingDavServletRequest
    
    Returns:
    
    the String value of the Ordering-Type header.
    
    See Also:
    
    OrderingDavServletRequest.getOrderingType()
  - getPosition
```
public Position getPosition()
```
    Description copied from interface: OrderingDavServletRequest
    
    Return a Position object encapsulating the Position header field or null if no Position header is present or does not contain a valid format.
    
    Specified by:
    
    getPosition in interface OrderingDavServletRequest
    
    Returns:
    
    Position object encapsulating the Position header
    
    See Also:
    
    OrderingDavServletRequest.getPosition()
  - getOrderPatch
```
public OrderPatch getOrderPatch()
                         throws DavException
```
    Description copied from interface: OrderingDavServletRequest
    
    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.
    
    Specified by:
    
    getOrderPatch in interface OrderingDavServletRequest
    
    Returns:
    
    OrderPatch object representing the orderpatch request body or null if the
    
    Throws:
    
    DavException
    
    See Also:
    
    OrderingDavServletRequest.getOrderPatch()
  - getLabel
```
public String getLabel()
```
    Description copied from interface: DeltaVServletRequest
    
    Returns the Label header or null
    
    Specified by:
    
    getLabel in interface DeltaVServletRequest
    
    Returns:
    
    label header or null
    
    See Also:
    
    DeltaVServletRequest.getLabel()
  - getLabelInfo
```
public LabelInfo getLabelInfo()
                       throws DavException
```
    Description copied from interface: DeltaVServletRequest
    
    Return the request body as LabelInfo object or null if parsing the request body or the creation of the label info failed.
    
    Specified by:
    
    getLabelInfo in interface DeltaVServletRequest
    
    Returns:
    
    LabelInfo object or null
    
    Throws:
    
    DavException - in case of an invalid request body
    
    See Also:
    
    DeltaVServletRequest.getLabelInfo()
  - getMergeInfo
```
public MergeInfo getMergeInfo()
                       throws DavException
```
    Description copied from interface: DeltaVServletRequest
    
    Return the request body as MergeInfo object or null if the creation failed due to invalid format.
    
    Specified by:
    
    getMergeInfo in interface DeltaVServletRequest
    
    Returns:
    
    MergeInfo object or null
    
    Throws:
    
    DavException - in case of an invalid request body
    
    See Also:
    
    DeltaVServletRequest.getMergeInfo()
  - getUpdateInfo
```
public UpdateInfo getUpdateInfo()
                         throws DavException
```
    Description copied from interface: DeltaVServletRequest
    
    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.
    
    Specified by:
    
    getUpdateInfo in interface DeltaVServletRequest
    
    Returns:
    
    the parsed update request body or null
    
    Throws:
    
    DavException - in case of an invalid request body
    
    See Also:
    
    DeltaVServletRequest.getUpdateInfo()
  - getReportInfo
```
public ReportInfo getReportInfo()
                         throws DavException
```
    Description copied from interface: DeltaVServletRequest
    
    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.
    
    Specified by:
    
    getReportInfo in interface DeltaVServletRequest
    
    Returns:
    
    ReportInfo or null
    
    Throws:
    
    DavException - in case of an invalid request body
    
    See Also:
    
    DeltaVServletRequest.getReportInfo()
  - getOptionsInfo
```
public OptionsInfo getOptionsInfo()
                           throws DavException
```
    Description copied from interface: DeltaVServletRequest
    
    Returns the OptionsInfo present with the request or null.
    
    Specified by:
    
    getOptionsInfo in interface DeltaVServletRequest
    
    Returns:
    
    OptionsInfo or null
    
    Throws:
    
    DavException - in case of an invalid request body
    
    See Also:
    
    DeltaVServletRequest.getOptionsInfo()
  - getRebindInfo
```
public RebindInfo getRebindInfo()
                         throws DavException
```
    Description copied from interface: BindServletRequest
    
    Returns the RebindInfo present with the request
    
    Specified by:
    
    getRebindInfo in interface BindServletRequest
    
    Returns:
    
    RebindInfo object
    
    Throws:
    
    DavException - in case of an invalid or missing request body
    
    See Also:
    
    BindServletRequest.getRebindInfo()
  - getUnbindInfo
```
public UnbindInfo getUnbindInfo()
                         throws DavException
```
    Description copied from interface: BindServletRequest
    
    Returns the UnbindInfo present with the request
    
    Specified by:
    
    getUnbindInfo in interface BindServletRequest
    
    Returns:
    
    UnbindInfo object
    
    Throws:
    
    DavException - in case of an invalid or missing request body
    
    See Also:
    
    BindServletRequest.getUnbindInfo()
  - getBindInfo
```
public BindInfo getBindInfo()
                     throws DavException
```
    Description copied from interface: BindServletRequest
    
    Returns the BindInfo present with the request
    
    Specified by:
    
    getBindInfo in interface BindServletRequest
    
    Returns:
    
    BindInfo object
    
    Throws:
    
    DavException - in case of an invalid or missing request body
    
    See Also:
    
    BindServletRequest.getBindInfo()
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String s)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String s)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration<String> getHeaders(String s)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String s)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String s)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean b)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - getAttribute
```
public Object getAttribute(String s)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String s)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getParameter
```
public String getParameter(String s)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String s)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String s,
                         Object o)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String s)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String s)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - getRealPath
```
public String getRealPath(String s)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - changeSessionId
```
public String changeSessionId()
```
    Specified by:
    
    changeSessionId in interface javax.servlet.http.HttpServletRequest
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException
```
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - login
```
public void login(String username,
                  String password)
           throws javax.servlet.ServletException
```
    Specified by:
    
    login in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Specified by:
    
    logout in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - getParts
```
public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException
```
    Specified by:
    
    getParts in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getPart
```
public javax.servlet.http.Part getPart(String name)
                                throws IOException,
                                       javax.servlet.ServletException
```
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException
```
    Specified by:
    
    upgrade in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface javax.servlet.ServletRequest
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface javax.servlet.ServletRequest
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface javax.servlet.ServletRequest
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface javax.servlet.ServletRequest
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest

Class WebdavRequestImpl

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants

Fields inherited from interface org.apache.jackrabbit.webdav.ContentCodingAwareRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebdavRequestImpl

WebdavRequestImpl

Method Detail

setDavSession

getDavSession

getRequestLocator

getDestinationLocator

getHrefLocator

getMemberLocator

isOverwrite

getDepth

getDepth

getTimeout

getLockToken

getRequestDocument

getPropFindType

getPropFindProperties

getRequestContentCodings

getAcceptableCodings

getPropPatchChangeList

getLockInfo

matchesIfHeader

matchesIfHeader

getTransactionId

getTransactionInfo

getSubscriptionId

getPollTimeout

getSubscriptionInfo

getOrderingType

getPosition

getOrderPatch

getLabel

getLabelInfo

getMergeInfo

getUpdateInfo

getReportInfo

getOptionsInfo

getRebindInfo

getUnbindInfo

getBindInfo

getAuthType

getCookies

getDateHeader

getHeader

getHeaders

getHeaderNames

getIntHeader

getMethod

getPathInfo

getPathTranslated

getContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentType