com.ibm.portal.resolver.webdav.commands
Interface WebdavCommand.Lock

All Known Subinterfaces:

WebdavLock

All Known Implementing Classes:

DefaultWebdavLock

Enclosing interface:

WebdavCommand

public static interface WebdavCommand.Lock

Information about a lock

Method Summary

DefaultWebdavContentHandler.LockScope	getLockScope() The scope of the lock
java.net.URI	getLockToken() The URI of the lock token associated with this resource
DefaultWebdavContentHandler.LockType	getLockType() The type of the lock
javax.xml.transform.Source	getOwner() Description of the owner of the lock.
long	getTimeout() The timeout associated with a lock in seconds or -1 for an infinite lock.
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 lock

Returns:

scope, not null

getLockToken

java.net.URI getLockToken()

The URI of the lock token associated with this resource

Returns:

the lock token URI

getLockType

DefaultWebdavContentHandler.LockType getLockType()

The type of the lock

Returns:

type, not 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> (the prefix is actually of no importance as long as it identifies the DAV namespace).

Returns:

a source object that describes the owner or null

getTimeout

long getTimeout()

The timeout associated with a lock in seconds or -1 for an infinite lock. Return 0 if the timeout is unknown or unspecified.

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