Package com.github.toolarium.common.object

Class ObjectLockManager

java.lang.Object

com.github.toolarium.common.object.ObjectLockManager

All Implemented Interfaces:

IObjectLockManager, java.io.Serializable

public class ObjectLockManager
extends java.lang.Object
implements IObjectLockManager, java.io.Serializable

Defines the object lock manager

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ObjectLockManager()	Constructor
ObjectLockManager(java.lang.Integer lockSize, java.lang.Long unlockTimeout)	Constructor

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleanup too old unlock elements
void	cleanupAfterUnlock(boolean cleanupAfterUnlock)	Define if the cleanup of unlock timeout should be forced after an unlock
StatisticCounter	getIgnoreLockStatistic()	Get the statistics of locks that could not be obtained because they are already locked.
StatisticCounter	getLockStatistic()	Get the object lock statistic (the number of lock elements)
long	getNumberOfLockSizeReached()	Get the count of how many times the max lock size was reached
StatisticCounter	getUnlockStatistic()	Get the statistics of locks that could not be obtained because of the unlock timeout.
protected void	init()	Initialize
<L extends java.io.Serializable> java.util.List<L>	lock(java.util.List<L> theObjectLockList)	Locks a list of objects inside the same JVM.
void	releaseResource()	Release all object locks and resources
IObjectLockManager	setObjectLockSize(java.lang.Integer lockSize)	Sets the size of the object lock
IObjectLockManager	setUnlockTimeout(java.lang.Long unlockTimeout)	Sets the unlock timeout which defines how long an element can't be locked again after an unlock
java.lang.String	toString()
<L extends java.io.Serializable> java.util.List<L>	unlock(java.util.List<L> theObjectLockList)	Unlock a list of objects inside the same JVM.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectLockManager

public ObjectLockManager()

Constructor

ObjectLockManager

public ObjectLockManager(java.lang.Integer lockSize,
                         java.lang.Long unlockTimeout)

Constructor

Parameters:

lockSize - defines the lock size

unlockTimeout - the timeout after unlock an object is still not be able to lock

Method Detail

setObjectLockSize

public IObjectLockManager setObjectLockSize(java.lang.Integer lockSize)
                                     throws java.lang.IllegalArgumentException

Description copied from interface: IObjectLockManager

Sets the size of the object lock

Specified by:

setObjectLockSize in interface IObjectLockManager

Parameters:

lockSize - the object lock size (positive number) or null

Returns:

the instance

Throws:

java.lang.IllegalArgumentException

See Also:

IObjectLockManager.setObjectLockSize(Integer)

setUnlockTimeout

public IObjectLockManager setUnlockTimeout(java.lang.Long unlockTimeout)

Description copied from interface: IObjectLockManager

Sets the unlock timeout which defines how long an element can't be locked again after an unlock

Specified by:

setUnlockTimeout in interface IObjectLockManager

Parameters:

unlockTimeout - the unlock timeout (positive number) or null

Returns:

the instance

See Also:

IObjectLockManager.setUnlockTimeout(java.lang.Long)

lock

public <L extends java.io.Serializable> java.util.List<L> lock(java.util.List<L> theObjectLockList)

Description copied from interface: IObjectLockManager

Locks a list of objects inside the same JVM.

Specified by:

lock in interface IObjectLockManager

Type Parameters:

L - the object lock type

Parameters:

theObjectLockList - the list of objects to lock

Returns:

Returns only the successfully locked objects. It returns in all cases a list but it doesn't throws any exceptions!

See Also:

IObjectLockManager.lock(java.util.List)

unlock

public <L extends java.io.Serializable> java.util.List<L> unlock(java.util.List<L> theObjectLockList)

Description copied from interface: IObjectLockManager

Unlock a list of objects inside the same JVM.

Specified by:

unlock in interface IObjectLockManager

Type Parameters:

L - the object lock type

Parameters:

theObjectLockList - the list of objects to unlock

Returns:

the list of objects to unlock

See Also:

IObjectLockManager.unlock(java.util.List)

cleanupAfterUnlock

public void cleanupAfterUnlock(boolean cleanupAfterUnlock)

Define if the cleanup of unlock timeout should be forced after an unlock

Parameters:

cleanupAfterUnlock - true or false

cleanup

public void cleanup()

Cleanup too old unlock elements

releaseResource

public void releaseResource()

Description copied from interface: IObjectLockManager

Release all object locks and resources

Specified by:

releaseResource in interface IObjectLockManager

See Also:

IObjectLockManager.releaseResource()

getLockStatistic

public StatisticCounter getLockStatistic()

Description copied from interface: IObjectLockManager

Get the object lock statistic (the number of lock elements)

Specified by:

getLockStatistic in interface IObjectLockManager

Returns:

the object lock statistic

See Also:

IObjectLockManager.getLockStatistic()

getUnlockStatistic

public StatisticCounter getUnlockStatistic()

Description copied from interface: IObjectLockManager

Get the statistics of locks that could not be obtained because of the unlock timeout.

Specified by:

getUnlockStatistic in interface IObjectLockManager

Returns:

the object unlock statistic

See Also:

IObjectLockManager.getUnlockStatistic()

getIgnoreLockStatistic

public StatisticCounter getIgnoreLockStatistic()

Description copied from interface: IObjectLockManager

Get the statistics of locks that could not be obtained because they are already locked.

Specified by:

getIgnoreLockStatistic in interface IObjectLockManager

Returns:

the ignore object lock statistic

See Also:

IObjectLockManager.getIgnoreLockStatistic()

getNumberOfLockSizeReached

public long getNumberOfLockSizeReached()

Description copied from interface: IObjectLockManager

Get the count of how many times the max lock size was reached

Specified by:

getNumberOfLockSizeReached in interface IObjectLockManager

Returns:

the count of how many times the max lock size was reached

See Also:

IObjectLockManager.getNumberOfLockSizeReached()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

init

protected void init()

Initialize