org.apache.webdav.lib.properties
Class LockDiscoveryProperty

java.lang.Object
  extended byorg.apache.webdav.lib.BaseProperty
      extended byorg.apache.webdav.lib.properties.LockDiscoveryProperty
All 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.

Version:
$Revision: 1.5 $

Field Summary
static java.lang.String TAG_NAME
          The property name.
 
Fields inherited from class org.apache.webdav.lib.BaseProperty
element, response
 
Constructor Summary
LockDiscoveryProperty(ResponseEntity response, org.w3c.dom.Element element)
          Default constructor for the property.
 
Method Summary
 Lock[] getActiveLocks()
          Get the activelock in this lockdiscovery property.
 java.lang.String getPropertyAsString()
          This method returns the value of the property.
protected  Lock parseLock(org.w3c.dom.Element element)
          Parse a lock.
 
Methods inherited from class org.apache.webdav.lib.BaseProperty
getElement, getLocalName, getName, getNamespaceURI, getOwningURL, getStatusCode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME
The property name.

See Also:
Constant Field Values
Constructor Detail

LockDiscoveryProperty

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

Method Detail

getActiveLocks

public Lock[] getActiveLocks()
Get the activelock in this lockdiscovery property.

Returns:
Lock[] A lock array or null when there is no lock.

parseLock

protected Lock parseLock(org.w3c.dom.Element element)
Parse a lock.


getPropertyAsString

public java.lang.String getPropertyAsString()
Description copied from class: BaseProperty
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 class BaseProperty