Package org.infinispan.lock.impl.manager

Class EmbeddedClusteredLockManager

java.lang.Object

org.infinispan.lock.impl.manager.EmbeddedClusteredLockManager

All Implemented Interfaces:

ClusteredLockManager

@MBean(objectName="ClusteredLockManager",
       description="Component to manage clustered locks")
public class EmbeddedClusteredLockManager
extends Object
implements ClusteredLockManager

The Embedded version for the lock cluster manager

Since:

9.2

Author:

Katia Aresti, karesti@redhat.com

Field Summary

Fields

Modifier and Type	Field	Description
static String	FORCE_RELEASE
static String	IS_DEFINED
static String	IS_LOCKED
static String	OBJECT_NAME
static String	REMOVE

Constructor Summary

Constructors

Constructor	Description
EmbeddedClusteredLockManager(ClusteredLockManagerConfiguration config)

Method Summary

Modifier and Type	Method	Description
boolean	defineLock(String name)	Defines a lock with the specific name and the default ClusteredLockConfiguration.
boolean	defineLock(String name, ClusteredLockConfiguration configuration)	Defines a lock with the specific name and ClusteredLockConfiguration.
CompletableFuture<Boolean>	forceRelease(String name)	Releases - or unlocks - a ClusteredLock if such exists.
boolean	forceReleaseSync(String name)
ClusteredLock	get(String name)	Get’s a ClusteredLock by it’s name.
ClusteredLockConfiguration	getConfiguration(String name)	Returns the configuration of a ClusteredLock, if such exists.This method throws ClusteredLockException if the lock is not not defined.
ScheduledExecutorService	getScheduledExecutorService()
boolean	isDefined(String name)	Checks if a lock is already defined.
boolean	isLockedSync(String name)
CompletableFuture<Boolean>	remove(String name)	Removes a ClusteredLock if such exists.
boolean	removeSync(String name)
void	start()
void	stop()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_NAME

public static final String OBJECT_NAME

See Also:

Constant Field Values

FORCE_RELEASE

public static final String FORCE_RELEASE

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

IS_DEFINED

public static final String IS_DEFINED

See Also:

Constant Field Values

IS_LOCKED

public static final String IS_LOCKED

See Also:

Constant Field Values

Constructor Detail

EmbeddedClusteredLockManager

public EmbeddedClusteredLockManager(ClusteredLockManagerConfiguration config)

Method Detail

start

public void start()

stop

public void stop()

defineLock

public boolean defineLock(String name)

Description copied from interface: ClusteredLockManager

Defines a lock with the specific name and the default ClusteredLockConfiguration. It does not overwrite existing configurations. Returns true if successfully defined or false if the lock is already defined or any other failure.

Specified by:

defineLock in interface ClusteredLockManager

Parameters:

name - , the name of the lock

Returns:

true if the lock was successfully defined

defineLock

public boolean defineLock(String name,
                          ClusteredLockConfiguration configuration)

Description copied from interface: ClusteredLockManager

Defines a lock with the specific name and ClusteredLockConfiguration. It does not overwrite existing configurations. Returns true if successfully defined or false if the lock is already defined or any other failure.

Specified by:

defineLock in interface ClusteredLockManager

Parameters:

name - , the name of the lock

configuration - , a ClusteredLockConfiguration object with the configuration of the lock

Returns:

true if the lock was successfully defined

get

public ClusteredLock get(String name)

Description copied from interface: ClusteredLockManager

Get’s a ClusteredLock by it’s name. This method throws ClusteredLockException if the lock is not not defined. A call of ClusteredLockManager.defineLock(java.lang.String) must be done at least once in the cluster. This method will return the same lock object depending on the OwnershipLevel. If the OwnershipLevel is OwnershipLevel.NODE, it wll return the same instance per ClusteredLockManager If the OwnershipLevel is OwnershipLevel.INSTANCE, it wll return a new instance per call.

Specified by:

get in interface ClusteredLockManager

Parameters:

name - , the name of the lock

Returns:

ClusteredLock instance

getConfiguration

public ClusteredLockConfiguration getConfiguration(String name)

Description copied from interface: ClusteredLockManager

Returns the configuration of a ClusteredLock, if such exists.This method throws ClusteredLockException if the lock is not not defined. A call of ClusteredLockManager.defineLock(java.lang.String) must be done at least once in the cluster.

Specified by:

getConfiguration in interface ClusteredLockManager

Parameters:

name - , the name of the lock

Returns:

ClusteredLockConfiguration for this lock

isDefined

@ManagedOperation(description="Returns true if the lock is defined",
                  displayName="Is Lock Defined",
                  name="isDefined")
public boolean isDefined(String name)

Description copied from interface: ClusteredLockManager

Checks if a lock is already defined.

Specified by:

isDefined in interface ClusteredLockManager

Parameters:

name - , the lock name

Returns:

true if this lock is defined

remove

public CompletableFuture<Boolean> remove(String name)

Description copied from interface: ClusteredLockManager

Removes a ClusteredLock if such exists.

Specified by:

remove in interface ClusteredLockManager

Parameters:

name - , the name of the lock

Returns:

true if the lock is removed

removeSync

@ManagedOperation(description="Removes the lock from the cluster. The lock has to be recreated to access next time.",
                  displayName="Remove Clustered Lock",
                  name="remove")
public boolean removeSync(String name)

forceRelease

public CompletableFuture<Boolean> forceRelease(String name)

Description copied from interface: ClusteredLockManager

Releases - or unlocks - a ClusteredLock if such exists. This method is used when we just want to force the release the lock no matter who is holding it at a given time. Calling this method may cause concurrency issues and has to be used in exceptional situations.

Specified by:

forceRelease in interface ClusteredLockManager

Parameters:

name - , the name of the lock

Returns:

true if the lock has been released

forceReleaseSync

@ManagedOperation(description="Forces a release of the lock if such exist",
                  displayName="Release Clustered Lock",
                  name="forceRelease")
public boolean forceReleaseSync(String name)

isLockedSync

@ManagedOperation(description="Returns true if the lock exists and is acquired",
                  displayName="Is Locked",
                  name="isLocked")
public boolean isLockedSync(String name)

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

toString

public String toString()

Overrides:

toString in class Object