alluxio.master.file.meta

Class MutableInodeDirectory

java.lang.Object

alluxio.master.file.meta.MutableInode<MutableInodeDirectory>

alluxio.master.file.meta.MutableInodeDirectory

All Implemented Interfaces:

InodeDirectoryView, InodeView, JournalEntryRepresentable, Comparable<InodeView>

@NotThreadSafe
public final class MutableInodeDirectory
extends MutableInode<MutableInodeDirectory>
implements InodeDirectoryView

Alluxio file system's directory representation in the file system master.

Field Summary

Fields inherited from class alluxio.master.file.meta.MutableInode

mAcl, mCreationTimeMs, mDirectory, mId, mTtl, mTtlAction

Method Summary

Modifier and Type	Method and Description
static MutableInodeDirectory	create(long id, long parentId, String name, CreateDirectoryContext context) Creates an MutableInodeDirectory.
static MutableInodeDirectory	fromJournalEntry(File.InodeDirectoryEntry entry) Converts the entry to an MutableInodeDirectory.
static MutableInodeDirectory	fromProto(InodeMeta.InodeOrBuilder inode)
FileInfo	generateClientFileInfo(String path) Generates client file info for a folder.
long	getChildCount()
DefaultAccessControlList	getDefaultACL()
protected MutableInodeDirectory	getThis()
boolean	isDirectChildrenLoaded()
boolean	isMountPoint()
MutableInodeDirectory	setChildCount(long childCount)
MutableInodeDirectory	setDefaultACL(DefaultAccessControlList acl)
MutableInodeDirectory	setDirectChildrenLoaded(boolean directChildrenLoaded)
MutableInodeDirectory	setMountPoint(boolean mountPoint)
Journal.JournalEntry	toJournalEntry()
Journal.JournalEntry	toJournalEntry(String path)
InodeMeta.Inode	toProto()
String	toString()
void	updateFromEntry(File.UpdateInodeDirectoryEntry entry) Updates this inode directory's state from the given entry.

Methods inherited from class alluxio.master.file.meta.MutableInode

asDirectory, asFile, checkPermission, equals, getACL, getCreationTimeMs, getGroup, getId, getLastAccessTimeMs, getLastModificationTimeMs, getMediumTypes, getMode, getName, getOwner, getParentId, getPermission, getPersistenceState, getTtl, getTtlAction, getUfsFingerprint, getXAttr, hashCode, isDeleted, isDirectory, isFile, isPersisted, isPinned, removeAcl, removeExtendedAcl, replaceAcl, setAcl, setCreationTimeMs, setDeleted, setGroup, setInternalAcl, setLastAccessTimeMs, setLastAccessTimeMs, setLastModificationTimeMs, setLastModificationTimeMs, setMediumTypes, setMode, setName, setOwner, setParentId, setPersistenceState, setPinned, setTtl, setTtlAction, setUfsFingerprint, setXAttr, toProtoBuilder, toStringHelper, updateFromEntry, updateMask

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface alluxio.master.file.meta.InodeView

checkPermission, compareTo, getACL, getCreationTimeMs, getGroup, getId, getLastAccessTimeMs, getLastModificationTimeMs, getMediumTypes, getMode, getName, getOwner, getParentId, getPermission, getPersistenceState, getTtl, getTtlAction, getUfsFingerprint, getXAttr, isDeleted, isDirectory, isFile, isPersisted, isPinned

Method Detail

getThis

protected MutableInodeDirectory getThis()

Specified by:

getThis in class MutableInode<MutableInodeDirectory>

Returns:

this so that the abstract class can use the fluent builder pattern

isMountPoint

public boolean isMountPoint()

Specified by:

isMountPoint in interface InodeDirectoryView

Returns:

true if the inode is a mount point, false otherwise

isDirectChildrenLoaded

public boolean isDirectChildrenLoaded()

Specified by:

isDirectChildrenLoaded in interface InodeDirectoryView

Returns:

true if we have loaded all the direct children's metadata once

getChildCount

public long getChildCount()

Specified by:

getChildCount in interface InodeDirectoryView

Returns:

the number of children contained in the directory

getDefaultACL

public DefaultAccessControlList getDefaultACL()

Specified by:

getDefaultACL in interface InodeView

Returns:

the default ACL associated with this inode

setMountPoint

public MutableInodeDirectory setMountPoint(boolean mountPoint)

Parameters:

mountPoint - the mount point flag value to use

Returns:

the updated object

setDirectChildrenLoaded

public MutableInodeDirectory setDirectChildrenLoaded(boolean directChildrenLoaded)

Parameters:

directChildrenLoaded - whether to load the direct children if they were not loaded before

Returns:

the updated object

setChildCount

public MutableInodeDirectory setChildCount(long childCount)

Parameters:

childCount - the child count to set

Returns:

the updated object

setDefaultACL

public MutableInodeDirectory setDefaultACL(DefaultAccessControlList acl)

Specified by:

setDefaultACL in class MutableInode<MutableInodeDirectory>

Parameters:

acl - set the default ACL associated with this inode

Returns:

the updated object

generateClientFileInfo

public FileInfo generateClientFileInfo(String path)

Generates client file info for a folder. xAttr is intentionally left out as the information is not yet exposed to clients

Specified by:

generateClientFileInfo in interface InodeView

Specified by:

generateClientFileInfo in class MutableInode<MutableInodeDirectory>

Parameters:

path - the path of the folder in the filesystem

Returns:

the generated FileInfo

updateFromEntry

public void updateFromEntry(File.UpdateInodeDirectoryEntry entry)

Updates this inode directory's state from the given entry.

Parameters:

entry - the entry

toString

public String toString()

Overrides:

toString in class Object

fromJournalEntry

public static MutableInodeDirectory fromJournalEntry(File.InodeDirectoryEntry entry)

Converts the entry to an MutableInodeDirectory.

Parameters:

entry - the entry to convert

Returns:

the MutableInodeDirectory representation

create

public static MutableInodeDirectory create(long id,
                                           long parentId,
                                           String name,
                                           CreateDirectoryContext context)

Creates an MutableInodeDirectory.

Parameters:

id - id of this inode

parentId - id of the parent of this inode

name - name of this inode

context - context to create this directory

Returns:

the MutableInodeDirectory representation

toJournalEntry

public Journal.JournalEntry toJournalEntry()

Specified by:

toJournalEntry in interface JournalEntryRepresentable

Returns:

the Journal.JournalEntry representing this object

toJournalEntry

public Journal.JournalEntry toJournalEntry(String path)

Specified by:

toJournalEntry in class MutableInode<MutableInodeDirectory>

Parameters:

path - path of the inode

Returns:

the journal entry representing the inode

toProto

public InodeMeta.Inode toProto()

Specified by:

toProto in interface InodeView

Returns:

the protocol buffer representation of the inode

fromProto

public static MutableInodeDirectory fromProto(InodeMeta.InodeOrBuilder inode)

Parameters:

inode - a protocol buffer inode

Returns:

the MutableInodeDirectory representation for the inode