Package com.github.sardine.impl.methods

Class HttpLock

java.lang.Object
org.apache.http.message.AbstractHttpMessage
org.apache.http.client.methods.AbstractExecutionAwareRequest
org.apache.http.client.methods.HttpRequestBase
org.apache.http.client.methods.HttpEntityEnclosingRequestBase
com.github.sardine.impl.methods.HttpLock
All Implemented Interfaces:
Cloneable, org.apache.http.client.methods.AbortableHttpRequest, org.apache.http.client.methods.Configurable, org.apache.http.client.methods.HttpExecutionAware, org.apache.http.client.methods.HttpUriRequest, org.apache.http.HttpEntityEnclosingRequest, org.apache.http.HttpMessage, org.apache.http.HttpRequest
public class HttpLock
extends org.apache.http.client.methods.HttpEntityEnclosingRequestBase

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static String METHOD_NAME  

    Fields inherited from class org.apache.http.message.AbstractHttpMessage

    headergroup, params

  • Constructor Summary

    Constructors 
    Constructor Description
    HttpLock​(String url)  
    HttpLock​(URI url)  

  • Method Summary

    Modifier and Type Method Description
    String getMethod()  
    void setDepth​(String depth)
    The Depth header may be used with the LOCK method.
    void setInfinite()
    Desires an infinite length lock.
    void setTimeout​(int seconds)
    Clients may include Timeout headers in their LOCK requests.

    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, 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, finalize, 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

  • Field Details

  • Constructor Details

  • Method Details

    • getMethod

      public String getMethod()
      Specified by:
      getMethod in interface org.apache.http.client.methods.HttpUriRequest
      Specified by:
      getMethod in class org.apache.http.client.methods.HttpRequestBase

    • setDepth

      public void setDepth​(String depth)

      The Depth header may be used with the LOCK method. Values other than 0 or infinity must not be used with the Depth header on a LOCK method. All resources that support the LOCK method must support the Depth header.

      If no Depth header is submitted on a LOCK request then the request must act as if a Depth:infinity had been submitted.

      Parameters:
      depth - "0" or "infinity".

    • setTimeout

      public void setTimeout​(int seconds)
      Clients may include Timeout headers in their LOCK requests. However, the server is not required to honor or even consider these requests.

    • setInfinite

      public void setInfinite()
      Desires an infinite length lock.