Package org.apache.hadoop.ozone.om.multitenant

Class AuthorizerLockImpl

java.lang.Object

org.apache.hadoop.ozone.om.multitenant.AuthorizerLockImpl

All Implemented Interfaces:

AuthorizerLock

public class AuthorizerLockImpl
extends Object
implements AuthorizerLock

Implementation of AuthorizerLock.

Constructor Summary

Constructors

Constructor	Description
AuthorizerLockImpl()

Method Summary

Modifier and Type	Method	Description
boolean	isWriteLockHeldByCurrentThread()	Returns true if the authorizer write lock is held by the current thread.
long	tryOptimisticReadThrowOnTimeout()
long	tryReadLock(long timeout)	Attempt to acquire the read lock to the authorizer with a timeout.
long	tryWriteLock(long timeout)	Attempt to acquire the write lock to authorizer with a timeout.
void	tryWriteLockInOMRequest()	A wrapper around tryWriteLockThrowOnTimeout() that is used exclusively in OMRequests.
long	tryWriteLockThrowOnTimeout()	A wrapper around tryWriteLock() that throws when timed out.
void	unlockRead(long stamp)	Release read lock on the authorizer.
void	unlockWrite(long stamp)	Release read lock on the authorizer.
void	unlockWriteInOMRequest()	A wrapper around unlockWrite() that is used exclusively in OMRequests.
boolean	validateOptimisticRead(long stamp)

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizerLockImpl

public AuthorizerLockImpl()

Method Details

tryReadLock

public long tryReadLock(long timeout)
                 throws InterruptedException

Description copied from interface: AuthorizerLock

Attempt to acquire the read lock to the authorizer with a timeout.

Specified by:

tryReadLock in interface AuthorizerLock

Returns:

stamp returned from lock op. required when releasing the lock

Throws:

InterruptedException

unlockRead

public void unlockRead(long stamp)

Release read lock on the authorizer. This is only used by BG sync at the moment.

Specified by:

unlockRead in interface AuthorizerLock

tryOptimisticReadThrowOnTimeout

public long tryOptimisticReadThrowOnTimeout()
                                     throws IOException

Specified by:

tryOptimisticReadThrowOnTimeout in interface AuthorizerLock

Returns:

stamp that can be passed to AuthorizerLock.validateOptimisticRead(long) to check if a write lock was acquired since the stamp was issued.

Throws:

IOException - If an ongoing write prevents the lock from moving to the read state for longer than the timeout.

validateOptimisticRead

public boolean validateOptimisticRead(long stamp)

Specified by:

validateOptimisticRead in interface AuthorizerLock

Returns:

True if the write lock was not acquired since this stamp was issued for an optimistic read. False otherwise.

tryWriteLock

public long tryWriteLock(long timeout)
                  throws InterruptedException

Description copied from interface: AuthorizerLock

Attempt to acquire the write lock to authorizer with a timeout.

Specified by:

tryWriteLock in interface AuthorizerLock

Returns:

stamp

Throws:

InterruptedException

unlockWrite

public void unlockWrite(long stamp)

Release read lock on the authorizer. This is used by both BG sync and tenant requests.

Specified by:

unlockWrite in interface AuthorizerLock

tryWriteLockThrowOnTimeout

public long tryWriteLockThrowOnTimeout()
                                throws IOException

Description copied from interface: AuthorizerLock

A wrapper around tryWriteLock() that throws when timed out.

Specified by:

tryWriteLockThrowOnTimeout in interface AuthorizerLock

Returns:

stamp

Throws:

IOException

tryWriteLockInOMRequest

public void tryWriteLockInOMRequest()
                             throws IOException

Description copied from interface: AuthorizerLock

A wrapper around tryWriteLockThrowOnTimeout() that is used exclusively in OMRequests. MUST use paired with unlockWriteInOMRequest() for unlocking to ensure correctness.

Specified by:

tryWriteLockInOMRequest in interface AuthorizerLock

Throws:

IOException

unlockWriteInOMRequest

public void unlockWriteInOMRequest()

Description copied from interface: AuthorizerLock

A wrapper around unlockWrite() that is used exclusively in OMRequests.

Specified by:

unlockWriteInOMRequest in interface AuthorizerLock

isWriteLockHeldByCurrentThread

public boolean isWriteLockHeldByCurrentThread()

Description copied from interface: AuthorizerLock

Returns true if the authorizer write lock is held by the current thread. Used in OMMultiTenantManagerImpl.AuthorizerOp.

Specified by:

isWriteLockHeldByCurrentThread in interface AuthorizerLock