org.apache.webdav.lib.properties

Class LockDiscoveryProperty

Implemented Interfaces:
Property

public class LockDiscoveryProperty
extends BaseProperty

This class represents a listing of who has lock, what type of lock he has, the timeout type and the time remaining on the timeout, and the associated lock token. The server is free to withhold any or all of this information if the requesting principal does not have sufficient access rights to see the requested data. <!ELEMENT lockdiscovery (activelock)* >
Version:
$Revision: 1.4.2.1 $

Field Summary

static String
TAG_NAME
The property name.

Fields inherited from class org.apache.webdav.lib.BaseProperty

element, response

Constructor Summary

LockDiscoveryProperty(ResponseEntity response, Element element)
Default constructor for the property.

Method Summary

Lock[]
getActiveLocks()
Get the activelock in this lockdiscovery property.
String
getPropertyAsString()
This method returns the value of the property.
protected Lock
parseLock(Element element)
Parse a lock.

Methods inherited from class org.apache.webdav.lib.BaseProperty

getElement, getLocalName, getName, getNamespaceURI, getOwningURL, getPropertyAsString, getStatusCode, toString

Field Details

TAG_NAME

public static final String TAG_NAME
The property name.

Constructor Details

LockDiscoveryProperty

public LockDiscoveryProperty(ResponseEntity response,
                             Element element)
Default constructor for the property.

Method Details

getActiveLocks

public Lock[] getActiveLocks()
Get the activelock in this lockdiscovery property.
Returns:
Lock[] A lock array or null when there is no lock.

getPropertyAsString

public String getPropertyAsString()
This method returns the value of the property. Thus, for example, calling this method on a property such as <D:getlastmodified>Tue, 05 Dec 2000 05:25:02</D:getlastmodified> returns Tue, 05 Dec 2000 05:25:02.
Note: Mixed content (text and xml together) will not be returned accurately.
Specified by:
getPropertyAsString in interface Property
Overrides:
getPropertyAsString in interface BaseProperty

parseLock

protected Lock parseLock(Element element)
Parse a lock.