cz.ues.platform.concurrent

Interface UESLockManager

@UESComponent
@WebServiceAccessible(wspHandlerChain="ues/platform/concurrent/UESLockManagerHandlerChain.xml")
public interface UESLockManager

Component for managing of UES Locks.

Since:

UES7-10

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI resourceUri, UESLockCreate lock) Creates new lock for given resource.
UESLockAttributes	getAttributes(UESURI lockUri) Returns attributes of given lock.
UESResultList<UESLockAttributes,UESLockGetList>	getLockList(UESURI resourceUri, UESLockGetList criteria) Returns list of all locks on given resource.
boolean	isValid(UESURI lockUri, java.lang.String ownerId) Checks if lock is valid (was not deleted and is not expired).
void	reallocate(UESURI lockUri, java.lang.String ownerId, java.lang.Long lockTimeout) Reallocates lock and thus allows prolonging (or shortening) its expiration time.
void	unlock(UESURI lockUri, java.lang.String ownerId) Unlocks lock with given UESURI.

Method Detail

create

UESURI create(UESURI resourceUri,
UESLockCreate lock)
throws UESLockManagerRTException

Creates new lock for given resource. If no additional parameters are given, reentrant lock with generic code is used. Each lock must have unique code in scope of resource (therefore there can be only one lock with unspecified/generic code).

Parameters:

resourceUri - UESURI of locked resource

lock - Additional lock attributes

Returns:

UESURI of created lock or null if lock with given code already exists

Throws:

UESLockManagerRTException - In case creating of lock failed

Since:

UES7-10

getLockList

UESResultList<UESLockAttributes,UESLockGetList> getLockList(UESURI resourceUri,
UESLockGetList criteria)
throws UESLockManagerRTException

Returns list of all locks on given resource.

Parameters:

resourceUri - UESURI of resource

Returns:

List of all locks

Throws:

UESLockManagerRTException - In case listing of locks failed

Since:

UES7-10

getAttributes

UESLockAttributes getAttributes(UESURI lockUri)
throws UESLockManagerRTException

Returns attributes of given lock.

Parameters:

lockUri - UESURI of lock to be read

Returns:

Attributes of lock

Throws:

UESLockManagerRTException - In case reading of lock failed

Since:

UES7-10

reallocate

void reallocate(UESURI lockUri,
java.lang.String ownerId,
java.lang.Long lockTimeout)
throws UESLockManagerRTException

Reallocates lock and thus allows prolonging (or shortening) its expiration time.

Parameters:

lockUri - UESURI of lock to be refreshed

ownerId - Optional ID of lock owner (owner is checked only if value is given)

lockTimeout - New value of lock timeout

Throws:

UESLockManagerRTException - In case refreshing of lock failed

Since:

UES7-10

isValid

boolean isValid(UESURI lockUri,
java.lang.String ownerId)
throws UESLockManagerRTException

Checks if lock is valid (was not deleted and is not expired).

Parameters:

lockUri - UESURI of lock

ownerId - Optional ID of lock owner (owner is checked only if value is given)

Returns:

True if lock is valid

Throws:

UESLockManagerRTException - In case checking of lock validity failed

Since:

UES7-10

unlock

void unlock(UESURI lockUri,
java.lang.String ownerId)
throws UESLockManagerRTException

Unlocks lock with given UESURI.

Parameters:

lockUri - UESURI of lock to be unlocked

ownerId - Only proper owner of lock can unlock it

Throws:

UESLockManagerRTException - In case unlocking of lock failed

Since:

UES7-10