Package org.apache.jackrabbit.webdav.client.methods

Class BaseDavRequest

    • Constructor Summary

      Constructors 
      Constructor Description
      BaseDavRequest​(java.net.URI uri)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void checkSuccess​(org.apache.http.HttpResponse response)
      Check the response and throw when it is considered to represent a failure.
      org.w3c.dom.Document getResponseBodyAsDocument​(org.apache.http.HttpEntity entity)
      Gets a Document representing the response body.
      EventDiscovery getResponseBodyAsEventDiscovery​(org.apache.http.HttpResponse response)
      Return response body as EventDiscovery object.
      LockDiscovery getResponseBodyAsLockDiscovery​(org.apache.http.HttpResponse response)
      Return response body as LockDiscovery object.
      MultiStatus getResponseBodyAsMultiStatus​(org.apache.http.HttpResponse response)
      Return response body as MultiStatus object.
      SubscriptionDiscovery getResponseBodyAsSubscriptionDiscovery​(org.apache.http.HttpResponse response)
      Return response body as SubscriptionDiscovery object.
      DavException getResponseException​(org.apache.http.HttpResponse response)
      Obtain a DavException representing the response.
      boolean succeeded​(org.apache.http.HttpResponse response)
      Check the provided HttpResponse for successful execution.

      • Methods inherited from class org.apache.http.client.methods.HttpEntityEnclosingRequestBase

        clone, expectContinue, getEntity, setEntity

      • Methods inherited from class org.apache.http.client.methods.HttpRequestBase

        getConfig, getMethod, getProtocolVersion, getRequestLine, getURI, releaseConnection, setConfig, setProtocolVersion, setURI, started, toString

      • Methods inherited from class org.apache.http.client.methods.AbstractExecutionAwareRequest

        abort, completed, isAborted, reset, setCancellable, setConnectionRequest, setReleaseTrigger

      • Methods inherited from class org.apache.http.message.AbstractHttpMessage

        addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.apache.http.HttpMessage

        addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

      • Methods inherited from interface org.apache.http.HttpRequest

        getRequestLine

      • Methods inherited from interface org.apache.http.client.methods.HttpUriRequest

        abort, isAborted

    • Constructor Detail

      • BaseDavRequest

        public BaseDavRequest​(java.net.URI uri)

    • Method Detail

      • getResponseBodyAsDocument

        public org.w3c.dom.Document getResponseBodyAsDocument​(org.apache.http.HttpEntity entity)
                                               throws java.io.IOException
        Gets a Document representing the response body.
        Returns:
        document or null for null entity
        Throws:
        java.io.IOException - in case of I/O or XMP pasting problems

      • getResponseBodyAsMultiStatus

        public MultiStatus getResponseBodyAsMultiStatus​(org.apache.http.HttpResponse response)
                                         throws DavException
        Return response body as MultiStatus object.
        Throws:
        java.lang.IllegalStateException - when response does not represent a MultiStatus
        DavException - for failures in obtaining/parsing the response body

      • getResponseBodyAsLockDiscovery

        public LockDiscovery getResponseBodyAsLockDiscovery​(org.apache.http.HttpResponse response)
                                             throws DavException
        Return response body as LockDiscovery object.
        Throws:
        java.lang.IllegalStateException - when response does not represent a LockDiscovery
        DavException - for failures in obtaining/parsing the response body

      • getResponseBodyAsEventDiscovery

        public EventDiscovery getResponseBodyAsEventDiscovery​(org.apache.http.HttpResponse response)
                                               throws DavException
        Return response body as EventDiscovery object.
        Throws:
        java.lang.IllegalStateException - when response does not represent a EventDiscovery
        DavException - for failures in obtaining/parsing the response body

      • checkSuccess

        public void checkSuccess​(org.apache.http.HttpResponse response)
                  throws DavException
        Check the response and throw when it is considered to represent a failure.
        Throws:
        DavException

      • getResponseException

        public DavException getResponseException​(org.apache.http.HttpResponse response)
        Obtain a DavException representing the response.
        Throws:
        java.lang.IllegalStateException - when the response is considered to be successful

      • succeeded

        public boolean succeeded​(org.apache.http.HttpResponse response)
        Check the provided HttpResponse for successful execution. The default implementation treats all 2xx status codes (RFC 7231, Section 6.3). Implementations can further restrict the accepted range of responses (or even check the response body).