Package org.apache.jackrabbit.webdav.lock

Class LockDiscovery

java.lang.Object

org.apache.jackrabbit.webdav.property.AbstractDavProperty<java.util.List<ActiveLock>>

org.apache.jackrabbit.webdav.lock.LockDiscovery

All Implemented Interfaces:

DavConstants, DavProperty<java.util.List<ActiveLock>>, PropEntry, XmlSerializable

public class LockDiscovery
extends AbstractDavProperty<java.util.List<ActiveLock>>

The LockDiscovery class encapsulates the webdav lock discovery property that is sent in the request body (PROPFIND and LOCK) and received in a LOCK response body.

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
LockDiscovery()	Creates a new empty LockDiscovery property
LockDiscovery(ActiveLock lock)	Create a new LockDiscovery property
LockDiscovery(ActiveLock[] locks)	Create a new LockDiscovery property

Method Summary

Modifier and Type	Method	Description
static LockDiscovery	createFromXml(org.w3c.dom.Element lockDiscoveryElement)	Builds a new LockDiscovery object from the given xml element.
java.util.List<ActiveLock>	getValue()	Returns the list of active locks.
org.w3c.dom.Element	toXml(org.w3c.dom.Document document)	Creates a <lockdiscovery> element in response to a LOCK request or to the lockdiscovery property of a PROPFIND request. NOTE: if the activeLocks list is empty an empty lockdiscovery property is created ( <lockdiscovery/>)

Methods inherited from class org.apache.jackrabbit.webdav.property.AbstractDavProperty

equals, getName, hashCode, isInvisibleInAllprop

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LockDiscovery

public LockDiscovery()

Creates a new empty LockDiscovery property

LockDiscovery

public LockDiscovery(ActiveLock lock)

Create a new LockDiscovery property

Parameters:

lock -

LockDiscovery

public LockDiscovery(ActiveLock[] locks)

Create a new LockDiscovery property

Parameters:

locks -

Method Detail

getValue

public java.util.List<ActiveLock> getValue()

Returns the list of active locks.

Returns:

list of active locks

See Also:

DavProperty.getValue()

toXml

public org.w3c.dom.Element toXml(org.w3c.dom.Document document)

Creates a <lockdiscovery> element in response to a LOCK request or to the lockdiscovery property of a PROPFIND request.
NOTE: if the activeLocks list is empty an empty lockdiscovery property is created ( <lockdiscovery/>)

Specified by:

toXml in interface XmlSerializable

Overrides:

toXml in class AbstractDavProperty<java.util.List<ActiveLock>>

Parameters:

document -

Returns:

A <lockdiscovery> element.

See Also:

XmlSerializable.toXml(Document)

createFromXml

public static LockDiscovery createFromXml(org.w3c.dom.Element lockDiscoveryElement)

Builds a new LockDiscovery object from the given xml element.

Parameters:

lockDiscoveryElement -

Returns:

Throws:

java.lang.IllegalArgumentException - if the given xml element is not a DAV:lockdiscovery element.