org.apache.hudi.client.transaction.lock

Class BaseZookeeperBasedLockProvider

java.lang.Object

org.apache.hudi.client.transaction.lock.BaseZookeeperBasedLockProvider

All Implemented Interfaces:

Serializable, AutoCloseable, Lock, LockProvider<org.apache.curator.framework.recipes.locks.InterProcessMutex>

Direct Known Subclasses:

ZookeeperBasedImplicitBasePathLockProvider, ZookeeperBasedLockProvider

@NotThreadSafe
public abstract class BaseZookeeperBasedLockProvider
extends Object
implements LockProvider<org.apache.curator.framework.recipes.locks.InterProcessMutex>, Serializable

A zookeeper based lock. This LockProvider implementation allows to lock table operations using zookeeper. Users need to have a Zookeeper cluster deployed to be able to use this lock.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LockConfiguration	lockConfiguration
protected String	lockKey
protected String	zkBasePath

Constructor Summary

Constructors

Constructor and Description
BaseZookeeperBasedLockProvider(LockConfiguration lockConfiguration, StorageConfiguration<?> conf)

Method Summary

Modifier and Type	Method and Description
void	close()
protected String	generateLogStatement(LockState state, String suffix)
protected String	generateLogSuffixString()
org.apache.curator.framework.recipes.locks.InterProcessMutex	getLock()
protected abstract String	getLockKey(LockConfiguration lockConfiguration)
protected String	getLockPath()
protected abstract String	getZkBasePath(LockConfiguration lockConfiguration)
boolean	tryLock(long time, TimeUnit unit)
void	unlock()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hudi.common.lock.LockProvider

getCurrentOwnerLockInfo, lock, lockInterruptibly, newCondition, tryLock

Field Detail

lockConfiguration

protected final LockConfiguration lockConfiguration

zkBasePath

protected final String zkBasePath

lockKey

protected final String lockKey

Constructor Detail

BaseZookeeperBasedLockProvider

public BaseZookeeperBasedLockProvider(LockConfiguration lockConfiguration,
                                      StorageConfiguration<?> conf)

Method Detail

getZkBasePath

protected abstract String getZkBasePath(LockConfiguration lockConfiguration)

getLockKey

protected abstract String getLockKey(LockConfiguration lockConfiguration)

generateLogSuffixString

protected String generateLogSuffixString()

getLockPath

protected String getLockPath()

tryLock

public boolean tryLock(long time,
                       TimeUnit unit)

Specified by:

tryLock in interface Lock

unlock

public void unlock()

Specified by:

unlock in interface Lock

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LockProvider<org.apache.curator.framework.recipes.locks.InterProcessMutex>

getLock

public org.apache.curator.framework.recipes.locks.InterProcessMutex getLock()

Specified by:

getLock in interface LockProvider<org.apache.curator.framework.recipes.locks.InterProcessMutex>

generateLogStatement

protected String generateLogStatement(LockState state,
                                      String suffix)