alluxio.master.file.meta

Class LockedInodePath

java.lang.Object

alluxio.master.file.meta.LockedInodePath

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

MutableLockedInodePath

@ThreadSafe
public abstract class LockedInodePath
extends Object
implements Closeable

This class represents a path of locked Inode, starting from the root.

Field Summary

Fields

Modifier and Type	Field and Description
protected InodeLockList	mLockList
protected InodeTree.LockMode	mLockMode
protected String[]	mPathComponents
protected AlluxioURI	mUri

Method Summary

Modifier and Type	Method and Description
void	close()
LockedInodePath	createTempPathForChild(String childName) Constructs a temporary LockedInodePath from an existing LockedInodePath, for a direct child of the existing path.
LockedInodePath	createTempPathForExistingChild(Inode<?> child, InodeTree.LockMode lockMode) Constructs a temporary LockedInodePath from an existing LockedInodePath, for a direct child of the existing path.
void	downgradeLast() Downgrades the last inode that was locked, if the inode was previously WRITE locked.
void	downgradeLastWithScheme(LockingScheme lockingScheme) Downgrades the last inode that was locked, according to the specified LockingScheme.
boolean	fullPathExists()
Inode<?>	getAncestorInode() Returns the closest ancestor of the target inode (last inode in the full path).
Inode<?>	getInode()
InodeFile	getInodeFile()
List<Inode<?>>	getInodeList()
Inode<?>	getInodeOrNull()
Inode	getLastExistingInode()
InodeTree.LockMode	getLockMode()
InodeDirectory	getParentInodeDirectory()
Inode	getParentInodeOrNull()
AlluxioURI	getUri()
void	unlockLast() Unlocks the last inode that was locked.

Methods inherited from class java.lang.Object

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

Field Detail

mUri

protected final AlluxioURI mUri

mPathComponents

protected final String[] mPathComponents

mLockList

protected final InodeLockList mLockList

mLockMode

protected InodeTree.LockMode mLockMode

Method Detail

getUri

public AlluxioURI getUri()

Returns:

the full uri of the path

getInode

public Inode<?> getInode()
                  throws FileDoesNotExistException

Returns:

the target inode

Throws:

FileDoesNotExistException - if the target inode does not exist

getInodeOrNull

@Nullable
public Inode<?> getInodeOrNull()

Returns:

the target inode, or null if it does not exist

getInodeFile

public InodeFile getInodeFile()
                       throws FileDoesNotExistException

Returns:

the target inode as an InodeFile

Throws:

FileDoesNotExistException - if the target inode does not exist, or it is not a file

getParentInodeDirectory

public InodeDirectory getParentInodeDirectory()
                                       throws InvalidPathException,
                                              FileDoesNotExistException

Returns:

the parent of the target inode

Throws:

InvalidPathException - if the parent inode is not a directory

FileDoesNotExistException - if the parent of the target does not exist

getParentInodeOrNull

@Nullable
public Inode getParentInodeOrNull()

Returns:

the parent of the target inode, or null if the parent does not exist

getLastExistingInode

public Inode getLastExistingInode()

Returns:

the last existing inode on the inode path

getInodeList

public List<Inode<?>> getInodeList()

Returns:

a copy of the list of existing inodes, from the root

fullPathExists

public boolean fullPathExists()

Returns:

true if the entire path of inodes exists, false otherwise

getLockMode

public InodeTree.LockMode getLockMode()

Returns:

the InodeTree.LockMode of this path

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

downgradeLast

public void downgradeLast()

Downgrades the last inode that was locked, if the inode was previously WRITE locked. If the inode was previously READ locked, no additional locking will occur.

downgradeLastWithScheme

public void downgradeLastWithScheme(LockingScheme lockingScheme)

Downgrades the last inode that was locked, according to the specified LockingScheme. If the locking scheme initially desired the READ lock, the downgrade will occur. Otherwise, downgrade will not be performed.

Parameters:

lockingScheme - the locking scheme to inspect

getAncestorInode

public Inode<?> getAncestorInode()
                          throws FileDoesNotExistException

Returns the closest ancestor of the target inode (last inode in the full path).

Returns:

the closest ancestor inode

Throws:

FileDoesNotExistException - if an ancestor does not exist

createTempPathForChild

public LockedInodePath createTempPathForChild(String childName)
                                       throws InvalidPathException

Constructs a temporary LockedInodePath from an existing LockedInodePath, for a direct child of the existing path. The child does not exist yet, this method simply adds the child to the path.

Parameters:

childName - the name of the direct child

Returns:

a LockedInodePath for the direct child

Throws:

InvalidPathException - if the path is invalid

createTempPathForExistingChild

public LockedInodePath createTempPathForExistingChild(Inode<?> child,
                                                      InodeTree.LockMode lockMode)
                                               throws InvalidPathException,
                                                      FileDoesNotExistException

Constructs a temporary LockedInodePath from an existing LockedInodePath, for a direct child of the existing path. The child must exist and this method will lock the child. A new LockedInodePath object is returned. When the returned temporary path is closed, it does not close the existing path.

Parameters:

child - the inode of the direct child

lockMode - the desired locking mode for the child

Returns:

a LockedInodePath for the direct child

Throws:

InvalidPathException - if the path is invalid

FileDoesNotExistException - if the file does not exist

unlockLast

public void unlockLast()

Unlocks the last inode that was locked.