alluxio.master.file.meta

Class LockingScheme

java.lang.Object

alluxio.master.file.meta.LockingScheme

@ThreadSafe
public final class LockingScheme
extends Object

This class represents information about how a path should be locked.

Constructor Summary

Constructors

Constructor and Description
LockingScheme(AlluxioURI path, InodeTree.LockPattern desiredLockPattern, boolean shouldSync) Constructs a LockingScheme.
LockingScheme(AlluxioURI path, InodeTree.LockPattern desiredPattern, FileSystemMasterCommonPOptions options, UfsSyncPathCache pathCache, DescendantType descendantType) Create a new LockingScheme.

Method Summary

Modifier and Type	Method and Description
InodeTree.LockPattern	getDesiredPattern()
AlluxioURI	getPath()
InodeTree.LockPattern	getPattern()
SyncCheck	shouldSync()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LockingScheme

public LockingScheme(AlluxioURI path,
                     InodeTree.LockPattern desiredLockPattern,
                     boolean shouldSync)

Constructs a LockingScheme. Avoid using this constructor where shouldSync is set true, if possible. #LockingScheme(AlluxioURI, LockPattern, FileSystemMasterCommonPOptions, UfsSyncPathCache, DescendantType) is the preferred one in such case, to make the metadata sync dedup feature work.

Parameters:

path - the path to lock

desiredLockPattern - the desired lock mode

shouldSync - true if the path should be synced

LockingScheme

public LockingScheme(AlluxioURI path,
                     InodeTree.LockPattern desiredPattern,
                     FileSystemMasterCommonPOptions options,
                     UfsSyncPathCache pathCache,
                     DescendantType descendantType)
              throws InvalidPathException

Create a new LockingScheme. Thi constructor computes the value of mShouldSync with the extra argument provided.

Parameters:

path - the path to lock

desiredPattern - the desired lock mode

options - the common options provided in an RPC

pathCache - the DefaultFileSystemMaster's path cache

descendantType - the descendant type

Throws:

InvalidPathException

Method Detail

getDesiredPattern

public InodeTree.LockPattern getDesiredPattern()

Returns:

the desired mode for the locking

getPattern

public InodeTree.LockPattern getPattern()

Returns:

the mode that should be used to lock the path, considering if ufs sync should occur

getPath

public AlluxioURI getPath()

Returns:

the path for this locking scheme

shouldSync

public SyncCheck shouldSync()

Returns:

true if the path should be synced with ufs

toString

public String toString()

Overrides:

toString in class Object