com.hazelcast.cp.internal.datastructures.lock

Class LockService

java.lang.Object

com.hazelcast.cp.internal.datastructures.spi.AbstractCPMigrationAwareService

com.hazelcast.cp.internal.datastructures.spi.blocking.AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

com.hazelcast.cp.internal.datastructures.lock.LockService

All Implemented Interfaces:

RaftManagedService, RaftRemoteService, SnapshotAwareService<com.hazelcast.cp.internal.datastructures.lock.LockRegistry>, RaftNodeLifecycleAwareService, SessionAwareService, ManagedService, LiveOperationsTracker, MigrationAwareService

public class LockService
extends AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

Contains Raft-based lock instances

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Name of the service

Fields inherited from class com.hazelcast.cp.internal.datastructures.spi.blocking.AbstractBlockingService

logger, raftService, WAIT_TIMEOUT_TASK_UPPER_BOUND_MILLIS

Fields inherited from class com.hazelcast.cp.internal.datastructures.spi.AbstractCPMigrationAwareService

nodeEngine

Constructor Summary

Constructors

Constructor and Description
LockService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
AcquireResult	acquire(CPGroupId groupId, String name, LockInvocationKey key, long timeoutMs)
protected com.hazelcast.cp.internal.datastructures.lock.LockRegistry	createNewRegistry(CPGroupId groupId) Creates a registry for the given Raft group.
FencedLock	createProxy(String proxyName) Creates a proxy for a CP data structure.
protected Object	expiredWaitKeyResponse() Creates the response object that will be sent for a expired wait key.
LockOwnershipState	getLockOwnershipState(CPGroupId groupId, String name)
protected void	initImpl() Subclasses can implement their custom initialization logic here
void	onCPSubsystemRestart() Called when CP Subsystem is restarted.
protected void	onRegistryRestored(com.hazelcast.cp.internal.datastructures.lock.LockRegistry registry)
boolean	release(CPGroupId groupId, long commitIndex, String name, LockEndpoint endpoint, UUID invocationUid)
protected String	serviceName() Returns name of the service.

Methods inherited from class com.hazelcast.cp.internal.datastructures.spi.blocking.AbstractBlockingService

clearPartitionReplica, destroyRaftObject, expireWaitKeys, getAttachedSessions, getBackupCount, getGroupIdSet, getLiveOperations, getOrInitRegistry, getRegistryOrNull, getSnapshotMap, heartbeatSession, init, notifyWaitKeys, onRaftGroupDestroyed, onRaftNodeSteppedDown, onSessionClose, populate, reset, restoreSnapshot, scheduleTimeout, setSessionAccessor, shutdown, shutdownImpl, takeSnapshot

Methods inherited from class com.hazelcast.cp.internal.datastructures.spi.AbstractCPMigrationAwareService

beforeMigration, commitMigration, prepareReplicationOperation, rollbackMigration

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.spi.partition.MigrationAwareService

beforeMigration, commitMigration, prepareReplicationOperation, rollbackMigration

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Name of the service

See Also:

Constant Field Values

Constructor Detail

LockService

public LockService(NodeEngine nodeEngine)

Method Detail

initImpl

protected void initImpl()

Description copied from class: AbstractBlockingService

Subclasses can implement their custom initialization logic here

Overrides:

initImpl in class AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

acquire

public AcquireResult acquire(CPGroupId groupId,
                             String name,
                             LockInvocationKey key,
                             long timeoutMs)

release

public boolean release(CPGroupId groupId,
                       long commitIndex,
                       String name,
                       LockEndpoint endpoint,
                       UUID invocationUid)

getLockOwnershipState

public LockOwnershipState getLockOwnershipState(CPGroupId groupId,
                                                String name)

createNewRegistry

protected com.hazelcast.cp.internal.datastructures.lock.LockRegistry createNewRegistry(CPGroupId groupId)

Description copied from class: AbstractBlockingService

Creates a registry for the given Raft group.

Specified by:

createNewRegistry in class AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

expiredWaitKeyResponse

protected Object expiredWaitKeyResponse()

Description copied from class: AbstractBlockingService

Creates the response object that will be sent for a expired wait key.

Specified by:

expiredWaitKeyResponse in class AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

onRegistryRestored

protected void onRegistryRestored(com.hazelcast.cp.internal.datastructures.lock.LockRegistry registry)

Overrides:

onRegistryRestored in class AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

serviceName

protected String serviceName()

Description copied from class: AbstractBlockingService

Returns name of the service.

Specified by:

serviceName in class AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>

createProxy

public FencedLock createProxy(String proxyName)

Description copied from interface: RaftRemoteService

Creates a proxy for a CP data structure. This method is called outside of the Raft layer.

Parameters:

proxyName - the name of the CP data structure

Returns:

the created proxy

onCPSubsystemRestart

public void onCPSubsystemRestart()

Description copied from interface: RaftManagedService

Called when CP Subsystem is restarted.

Specified by:

onCPSubsystemRestart in interface RaftManagedService

Overrides:

onCPSubsystemRestart in class AbstractBlockingService<LockInvocationKey,Lock,com.hazelcast.cp.internal.datastructures.lock.LockRegistry>