com.ibm.portal.resolver.webdav.tree.helper
Class DefaultWebdavLock

java.lang.Object
  com.ibm.portal.resolver.webdav.tree.helper.DefaultWebdavLock

All Implemented Interfaces:

WebdavCommand.Lock, WebdavLock

public class DefaultWebdavLock
extends java.lang.Object
implements WebdavLock

Default implementation of the WebdavLock interface

Since:

6.1.5

Note:

This interface is designed to be implemented by clients.

Constructor Summary

DefaultWebdavLock()
Default constructor

DefaultWebdavLock(WebdavLock aCopy)
Copy constructor that copies the properties of another 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.
void	setInfiniteDepth(boolean aInfiniteDepth) Assigns the infinite depth flag.
void	setLockScope(DefaultWebdavContentHandler.LockScope aLockScope) Sets the scope of this lock
void	setLockToken(java.net.URI aLockToken) Assigns the lock token that identifies the lock
void	setLockType(DefaultWebdavContentHandler.LockType aLockType) Assigns the type of the lock
void	setOwner(javax.xml.transform.Source aOwner) Assigns the owner of the lock
void	setTimeout(long aTimeout) Assigns a lock timeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWebdavLock

public DefaultWebdavLock()

Default constructor

DefaultWebdavLock

public DefaultWebdavLock(WebdavLock aCopy)

Copy constructor that copies the properties of another lock. The owner field is NOT copied.

Parameters:

aCopy - token to copy, not null

Since:

7.0.0.2

Method Detail

getLockScope

public DefaultWebdavContentHandler.LockScope getLockScope()

Description copied from interface: WebdavCommand.Lock

The scope of the lock

Specified by:

getLockScope in interface WebdavCommand.Lock

Returns:

scope, not null

getLockToken

public java.net.URI getLockToken()

Description copied from interface: WebdavCommand.Lock

The URI of the lock token associated with this resource

Specified by:

getLockToken in interface WebdavCommand.Lock

Returns:

the lock token URI

getLockType

public DefaultWebdavContentHandler.LockType getLockType()

Description copied from interface: WebdavCommand.Lock

The type of the lock

Specified by:

getLockType in interface WebdavCommand.Lock

Returns:

type, not null

getOwner

public javax.xml.transform.Source getOwner()

Description copied from interface: WebdavCommand.Lock

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).

Specified by:

getOwner in interface WebdavCommand.Lock

Returns:

a source object that describes the owner or null

getTimeout

public long getTimeout()

Description copied from interface: WebdavCommand.Lock

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

Specified by:

getTimeout in interface WebdavCommand.Lock

Returns:

timeout in seconds

isInfiniteDepth

public boolean isInfiniteDepth()

Description copied from interface: WebdavCommand.Lock

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

Specified by:

isInfiniteDepth in interface WebdavCommand.Lock

Returns:

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

setInfiniteDepth

public void setInfiniteDepth(boolean aInfiniteDepth)

Assigns the infinite depth flag.

Parameters:

infiniteDepth - false if the token only applies to a single resource, true otherwise

setLockScope

public void setLockScope(DefaultWebdavContentHandler.LockScope aLockScope)

Sets the scope of this lock

Parameters:

aLockScope - the scope

setLockToken

public void setLockToken(java.net.URI aLockToken)

Assigns the lock token that identifies the lock

Parameters:

aLockToken - the lock token URI

setLockType

public void setLockType(DefaultWebdavContentHandler.LockType aLockType)

Assigns the type of the lock

Parameters:

aLockType - the lock type

setOwner

public void setOwner(javax.xml.transform.Source aOwner)

Assigns the owner of the lock

Parameters:

aOwner - the owner

setTimeout

public void setTimeout(long aTimeout)

Assigns a lock timeout

Parameters:

aTimeout - the timeout