org.apache.jackrabbit.webdav.jcr.transaction
Class TxLockManagerImpl

java.lang.Object
  org.apache.jackrabbit.webdav.jcr.transaction.TxLockManagerImpl

All Implemented Interfaces:

org.apache.jackrabbit.webdav.lock.LockManager, org.apache.jackrabbit.webdav.transaction.TxLockManager

public class TxLockManagerImpl

extends Object

implements org.apache.jackrabbit.webdav.transaction.TxLockManager

TxLockManagerImpl manages locks with locktype 'dcr:transaction'.

todo: removing all expired locks todo: 'local' and 'global' are not accurate terms in the given context > replace todo: the usage of the 'global' transaction is not according to the JTA specification, which explicitely requires any transaction present on a servlet to be completed before the service method returns. Starting/completing transactions on the session object, which is possible with the jackrabbit implementation is a hack. todo: review of this transaction part is therefore required. Is there a use-case for those 'global' transactions at all...

Constructor Summary

TxLockManagerImpl()

Method Summary

org.apache.jackrabbit.webdav.lock.ActiveLock	createLock(org.apache.jackrabbit.webdav.lock.LockInfo lockInfo, org.apache.jackrabbit.webdav.DavResource resource) Create a new lock.
org.apache.jackrabbit.webdav.lock.ActiveLock	getLock(org.apache.jackrabbit.webdav.lock.Type type, org.apache.jackrabbit.webdav.lock.Scope scope, org.apache.jackrabbit.webdav.DavResource resource) Always returns null
org.apache.jackrabbit.webdav.lock.ActiveLock	getLock(org.apache.jackrabbit.webdav.lock.Type type, org.apache.jackrabbit.webdav.lock.Scope scope, org.apache.jackrabbit.webdav.transaction.TransactionResource resource) Return the lock applied to the given resource or null
boolean	hasLock(String token, org.apache.jackrabbit.webdav.DavResource resource) Returns true if the given lock token belongs to a lock that applies to the given resource, false otherwise.
org.apache.jackrabbit.webdav.lock.ActiveLock	refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo lockInfo, String lockToken, org.apache.jackrabbit.webdav.DavResource resource) Refresh the lock indentified by the given lock token.
void	releaseLock(String lockToken, org.apache.jackrabbit.webdav.DavResource resource) Throws UnsupportedOperationException.
void	releaseLock(org.apache.jackrabbit.webdav.transaction.TransactionInfo lockInfo, String lockToken, org.apache.jackrabbit.webdav.transaction.TransactionResource resource) Release the lock identified by the given lock token.

Methods inherited from class java.lang.Object

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

Constructor Detail

TxLockManagerImpl

public TxLockManagerImpl()

Method Detail

createLock

public org.apache.jackrabbit.webdav.lock.ActiveLock createLock(org.apache.jackrabbit.webdav.lock.LockInfo lockInfo,
                                                               org.apache.jackrabbit.webdav.DavResource resource)
                                                        throws org.apache.jackrabbit.webdav.DavException

Create a new lock.

Specified by:

createLock in interface org.apache.jackrabbit.webdav.lock.LockManager

Parameters:

lockInfo - as present in the request body.

resource -

Returns:

the lock

Throws:

org.apache.jackrabbit.webdav.DavException - if the lock could not be obtained.

IllegalArgumentException - if the resource is null or does not implement TransactionResource interface.

See Also:

LockManager.createLock(org.apache.jackrabbit.webdav.lock.LockInfo, org.apache.jackrabbit.webdav.DavResource)

refreshLock

public org.apache.jackrabbit.webdav.lock.ActiveLock refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo lockInfo,
                                                                String lockToken,
                                                                org.apache.jackrabbit.webdav.DavResource resource)
                                                         throws org.apache.jackrabbit.webdav.DavException

Refresh the lock indentified by the given lock token.

Specified by:

refreshLock in interface org.apache.jackrabbit.webdav.lock.LockManager

Parameters:

lockInfo -

lockToken -

resource -

Returns:

the lock

Throws:

org.apache.jackrabbit.webdav.DavException

IllegalArgumentException - if the resource is null or does not implement TransactionResource interface.

See Also:

LockManager.refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo, String, org.apache.jackrabbit.webdav.DavResource)

releaseLock

public void releaseLock(String lockToken,
                        org.apache.jackrabbit.webdav.DavResource resource)
                 throws org.apache.jackrabbit.webdav.DavException

Throws UnsupportedOperationException.

Specified by:

releaseLock in interface org.apache.jackrabbit.webdav.lock.LockManager

Parameters:

lockToken -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

LockManager.releaseLock(String, org.apache.jackrabbit.webdav.DavResource)

releaseLock

public void releaseLock(org.apache.jackrabbit.webdav.transaction.TransactionInfo lockInfo,
                        String lockToken,
                        org.apache.jackrabbit.webdav.transaction.TransactionResource resource)
                 throws org.apache.jackrabbit.webdav.DavException

Release the lock identified by the given lock token.

Specified by:

releaseLock in interface org.apache.jackrabbit.webdav.transaction.TxLockManager

Parameters:

lockInfo -

lockToken -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

getLock

public org.apache.jackrabbit.webdav.lock.ActiveLock getLock(org.apache.jackrabbit.webdav.lock.Type type,
                                                            org.apache.jackrabbit.webdav.lock.Scope scope,
                                                            org.apache.jackrabbit.webdav.DavResource resource)

Always returns null

Specified by:

getLock in interface org.apache.jackrabbit.webdav.lock.LockManager

Parameters:

type -

scope -

resource -

Returns:

null

See Also:

getLock(Type, Scope, TransactionResource), LockManager.getLock(org.apache.jackrabbit.webdav.lock.Type, org.apache.jackrabbit.webdav.lock.Scope, org.apache.jackrabbit.webdav.DavResource)

getLock

public org.apache.jackrabbit.webdav.lock.ActiveLock getLock(org.apache.jackrabbit.webdav.lock.Type type,
                                                            org.apache.jackrabbit.webdav.lock.Scope scope,
                                                            org.apache.jackrabbit.webdav.transaction.TransactionResource resource)

Return the lock applied to the given resource or null

Specified by:

getLock in interface org.apache.jackrabbit.webdav.transaction.TxLockManager

Parameters:

type -

scope -

resource -

Returns:

lock applied to the given resource or null

See Also:

todo: is it correct to return one that specific lock, the current session is token-holder of?

hasLock

public boolean hasLock(String token,
                       org.apache.jackrabbit.webdav.DavResource resource)

Returns true if the given lock token belongs to a lock that applies to the given resource, false otherwise. The token may either be retrieved from the Lock-Token header or from the TransactionId header.

Specified by:

hasLock in interface org.apache.jackrabbit.webdav.lock.LockManager

Parameters:

token -

resource -

Returns:

See Also:

LockManager.hasLock(String token, DavResource resource)