com.pega.pegarules.pub.context

Interface ILockProvider

public interface ILockProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILockProvider.LockStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	DATABASE
static java.lang.String	HAZELCAST
static java.lang.String	LOCK_PROVIDER_NAME
static java.lang.String	RESOURCE_NAME
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
ILockInformation	attemptLock(ILockInformation lockInformation) Attempts to lock the passed instance.
ILockInformation	createLockInformation(java.lang.String aRequestorID, java.lang.String aOperatorID, java.lang.String aOperatorName, java.util.Date aExpireTime, java.util.Date aAcquisitionTime, java.lang.String aLockHandle, java.util.Date aCreateTime, java.util.Date aUpdateTime, java.lang.String aUserHost, java.lang.String aTenantID) Create lock information
ILockInformation	createLockInformation(java.lang.String aRequestorID, java.lang.String aOperatorID, java.lang.String aOperatorName, java.util.Date aExpireTime, java.util.Date aAcquisitionTime, java.lang.String aLockHandle, java.util.Date aCreateTime, java.util.Date aUpdateTime, java.lang.String aUserHost, java.lang.String aCreateSystemId, java.lang.String aSystemName, java.lang.String aSystemNode, java.lang.String aPzInsKey, java.lang.String aUpdateOperatorId, java.lang.String aUpateOpeatorName, java.lang.String aTenantID) Create lock information
java.util.Collection<ILockInformation>	expireRequestorLocks(java.lang.String requestorId) When the current requestor times out expire all locks held by him by moving the expiration date to now
ILockInformation	findExistingLockInstance(java.lang.String aLockName) Gets the a current lock instance from the database/hazelcast cluster.
java.util.Collection<ILockInformation>	getAllLocks()
java.util.Collection<ILockInformation>	getLocksInformation()
ILockInformation	getRequestorLockInformation(java.lang.String requestorId) Retrieve first active lock information for the requestor id.
java.lang.String	getType()
ILockProvider.LockStatus	releaseLock(java.lang.String aLockName, java.lang.String requestorId, boolean aInDifferentRequestor, boolean aSetStatusIfLost, boolean localCache) Releases a lock.
int	releaseSystemLocks()
boolean	removeAllLocks()
int	unlockAllForOperator(java.lang.String operatorId)
int	unlockForRequestor(java.lang.String requestorId)
boolean	updateLock(ILockInformation existingLock, ILockInformation newLock) Updates a lock instance.
ILockInformation	withNewExpiration(ILockInformation aLockInformation, java.util.Date newExpirationTime, java.util.Date newDBExpirationTime, java.util.Date newUpdateTime, java.lang.String aTenantID) Create a new lock that is a copy of this lock, except with a new expiration time.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

DATABASE

static final java.lang.String DATABASE

See Also:

Constant Field Values

RESOURCE_NAME

static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

HAZELCAST

static final java.lang.String HAZELCAST

See Also:

Constant Field Values

LOCK_PROVIDER_NAME

static final java.lang.String LOCK_PROVIDER_NAME

See Also:

Constant Field Values

Method Detail

attemptLock

ILockInformation attemptLock(ILockInformation lockInformation)
                      throws LockFailureException

Attempts to lock the passed instance. Return null if the lock could not be obtained due to various locking exception including but not limited to a primary key violation.

Parameters:

lockInformation - lock information of the lock to be attempted on

Returns:

information about the acquired lock, or null if we could not get it

Throws:

LockFailureException - if there is any problem during locking

findExistingLockInstance

ILockInformation findExistingLockInstance(java.lang.String aLockName)
                                   throws LockFailureException

Gets the a current lock instance from the database/hazelcast cluster.

Parameters:

aLockName - name of the desired lock

Returns:

information about the lock instance, if one exists; otherwise, null

Throws:

LockFailureException - if something goes wrong

updateLock

boolean updateLock(ILockInformation existingLock,
                   ILockInformation newLock)
            throws LockFailureException

Updates a lock instance.

Parameters:

existingLock - existing lock instance whose information should be updated

newLock - new lock instance with the information to be updated

Returns:

information about the new lock, or null if we could not update the lock (because it disappeared)

Throws:

LockFailureException - if there is a database problem

releaseLock

ILockProvider.LockStatus releaseLock(java.lang.String aLockName,
                                     java.lang.String requestorId,
                                     boolean aInDifferentRequestor,
                                     boolean aSetStatusIfLost,
                                     boolean localCache)
                              throws LockFailureException,
                                     DatabaseException

Releases a lock.

Parameters:

aLockName - key of the lock to release

requestorId - requestor id whose lock should be released

aInDifferentRequestor - should we unlock it even if a different Requestor is holding it?

aSetStatusIfLost - if this is true, then the processing status is set to fail if the lock to release is not there

localCache - if this is true, then the lock is released from local cache too

Returns:

true iff a lock record (expired or not) was deleted and iff aInDifferentRequestor is false (that is, if we know that we deleted a record that corresponded to our Requestor)

Throws:

DatabaseException - if a connection fails or something goes wrong

LockGoneException - if the lock is no longer there. If this happens, then the processing status will be set to "fail" iff the aSetStatusIfLost parameter is set to true.

LockFailureException - if there is some other database/hazelcast-related problem

unlockAllForOperator

int unlockAllForOperator(java.lang.String operatorId)
                  throws LockFailureException

Parameters:

operatorId - operator id whose locks should be released

Returns:

number of previously locked instances that are now unlocked

Throws:

LockFailureException - if there is some other database/hazelcast-related problem

unlockForRequestor

int unlockForRequestor(java.lang.String requestorId)
                throws LockFailureException

Parameters:

requestorId - requestor id whose locks should be released

Returns:

number of previously locked instances that are now unlocked

Throws:

LockFailureException - if there is some other database/hazelcast-related problem

releaseSystemLocks

int releaseSystemLocks()
                throws LockFailureException

Returns:

number of previously locked instances that are now released

Throws:

LockFailureException - if there is some other database/hazelcast-related problem

expireRequestorLocks

java.util.Collection<ILockInformation> expireRequestorLocks(java.lang.String requestorId)
                                                     throws LockFailureException

When the current requestor times out expire all locks held by him by moving the expiration date to now

Parameters:

requestorId - requestor id whose locks should be released

Returns:

collection of locks that are expired

Throws:

LockFailureException - if there is some other database/hazelcast-related problem

getLocksInformation

java.util.Collection<ILockInformation> getLocksInformation()
                                                    throws LockFailureException

Returns:

collection of locks that are held currently

Throws:

LockFailureException - if there is some other database/hazelcast-related problem

createLockInformation

ILockInformation createLockInformation(java.lang.String aRequestorID,
                                       java.lang.String aOperatorID,
                                       java.lang.String aOperatorName,
                                       java.util.Date aExpireTime,
                                       java.util.Date aAcquisitionTime,
                                       java.lang.String aLockHandle,
                                       java.util.Date aCreateTime,
                                       java.util.Date aUpdateTime,
                                       java.lang.String aUserHost,
                                       java.lang.String aTenantID)

Create lock information

Parameters:

aRequestorID -

aOperatorID -

aOperatorName -

aExpireTime -

aAcquisitionTime -

aLockHandle -

aCreateTime -

aUpdateTime -

aUserHost -

aTenantID -

Returns:

ILockInformation

createLockInformation

ILockInformation createLockInformation(java.lang.String aRequestorID,
                                       java.lang.String aOperatorID,
                                       java.lang.String aOperatorName,
                                       java.util.Date aExpireTime,
                                       java.util.Date aAcquisitionTime,
                                       java.lang.String aLockHandle,
                                       java.util.Date aCreateTime,
                                       java.util.Date aUpdateTime,
                                       java.lang.String aUserHost,
                                       java.lang.String aCreateSystemId,
                                       java.lang.String aSystemName,
                                       java.lang.String aSystemNode,
                                       java.lang.String aPzInsKey,
                                       java.lang.String aUpdateOperatorId,
                                       java.lang.String aUpateOpeatorName,
                                       java.lang.String aTenantID)

Create lock information

Parameters:

aRequestorID -

aOperatorID -

aOperatorName -

aExpireTime -

aAcquisitionTime -

aLockHandle -

aCreateTime -

aUpdateTime -

aUserHost -

aCreateSystemId -

aSystemName -

aSystemNode -

aPzInsKey -

aUpdateOperatorId -

aUpateOpeatorName -

aTenantID -

Returns:

ILockInformation

withNewExpiration

ILockInformation withNewExpiration(ILockInformation aLockInformation,
                                   java.util.Date newExpirationTime,
                                   java.util.Date newDBExpirationTime,
                                   java.util.Date newUpdateTime,
                                   java.lang.String aTenantID)

Create a new lock that is a copy of this lock, except with a new expiration time.

Parameters:

aLockInformation - LockInformation to be changed.

newExpirationTime - Date representing the desired expiration time

newDBExpirationTime - Date representing the desired db expiration time

newUpdateTime - Date representing the updatetime

aTenantID -

Returns:

a new LockInformation object

getType

java.lang.String getType()

removeAllLocks

boolean removeAllLocks()
                throws LockFailureException

Throws:

LockFailureException

getAllLocks

java.util.Collection<ILockInformation> getAllLocks()
                                            throws LockFailureException

Throws:

LockFailureException

getRequestorLockInformation

ILockInformation getRequestorLockInformation(java.lang.String requestorId)
                                      throws LockFailureException

Retrieve first active lock information for the requestor id.

Parameters:

requestorId -

Returns:

ILockInformation

Throws:

LockFailureException - if there is some other database-related problem