Package org.apache.jackrabbit.webdav.client.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

org.apache.jackrabbit.webdav.client.methods.BaseDavRequest

org.apache.jackrabbit.webdav.client.methods.HttpLock

All Implemented Interfaces:

Cloneable, AbortableHttpRequest, Configurable, HttpExecutionAware, HttpUriRequest, HttpEntityEnclosingRequest, HttpMessage, HttpRequest

public class HttpLock
extends BaseDavRequest

Represents an HTTP LOCK request.

Since:

2.13.6

See Also:

• RFC 4918, Section 9.10

Constructor Summary

Constructors

Constructor	Description
HttpLock(String uri, long timeout, String[] lockTokens)
HttpLock(String uri, LockInfo lockInfo)
HttpLock(URI uri, long timeout, String[] lockTokens)
HttpLock(URI uri, LockInfo lockInfo)

Method Summary

Modifier and Type	Method	Description
String	getLockToken(HttpResponse response)
String	getMethod()	Returns the HTTP method this request uses, such as GET, PUT, POST, or other.
boolean	succeeded(HttpResponse response)	Check the provided HttpResponse for successful execution.

Methods inherited from class org.apache.jackrabbit.webdav.client.methods.BaseDavRequest

checkSuccess, getResponseBodyAsDocument, getResponseBodyAsEventDiscovery, getResponseBodyAsLockDiscovery, getResponseBodyAsMultiStatus, getResponseBodyAsSubscriptionDiscovery, getResponseException

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

HttpLock

public HttpLock(URI uri,
 LockInfo lockInfo)
         throws IOException

Throws:

IOException

HttpLock

public HttpLock(String uri,
 LockInfo lockInfo)
         throws IOException

Throws:

IOException

HttpLock

public HttpLock(URI uri,
 long timeout,
 String[] lockTokens)

HttpLock

public HttpLock(String uri,
 long timeout,
 String[] lockTokens)

Method Details

getMethod

public String getMethod()

Description copied from interface: HttpUriRequest

Returns the HTTP method this request uses, such as GET, PUT, POST, or other.

Specified by:

getMethod in interface HttpUriRequest

Specified by:

getMethod in class HttpRequestBase

getLockToken

public String getLockToken(HttpResponse response)

succeeded

public boolean succeeded(HttpResponse response)

Description copied from class: BaseDavRequest

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).

Overrides:

succeeded in class BaseDavRequest