com.ibm.portal.resolver.webdav.tree
Interface WebdavLockInfo

public interface WebdavLockInfo

Provides information about a requested lock

Since:

6.1.5

Note:

This interface is designed to be implemented by clients.

Method Summary

DefaultWebdavContentHandler.LockScope	getLockScope() The scope of the requested lock.
DefaultWebdavContentHandler.LockType	getLockType() The type of the requested lock.
javax.xml.transform.Source	getOwner() Description of the owner of the lock.
long[]	getTimeouts() Sequence of requested lock timeouts in seconds.
boolean	isInfiniteDepth() Indicates if the lock locks the complete hierarchy or simply the resource itself.

Method Detail

getLockScope

DefaultWebdavContentHandler.LockScope getLockScope()

The scope of the requested lock. Specifies whether a lock is an exclusive lock, or a shared lock. May return null in case the request was a LOCK refresh request.

Returns:

the lock scope or null

getLockType

DefaultWebdavContentHandler.LockType getLockType()

The type of the requested lock. Specifies the access type of a lock. At present, this specification only defines one lock type, the write lock. May return null in case the request was a LOCK refresh request.

Returns:

the lock type or null

getOwner

javax.xml.transform.Source getOwner()

Description of the owner of the lock. The owner information may be null. If given, the root element of the owner document must be <DAV:owner>

Returns:

a source object that describes the owner or null

getTimeouts

long[] getTimeouts()

Sequence of requested lock timeouts in seconds. A value of -1 indicates an infinite lock. The lock provider does not need to respect this request but can use the timeout list as a hint.

Returns:

timeout in seconds

isInfiniteDepth

boolean isInfiniteDepth()

Indicates if the lock locks the complete hierarchy or simply the resource itself. This value makes sense for collection resource rather than file resources

Returns:

true if the lock is valid for the complete hierarchy, else false