alluxio.master.file.meta

Class MutableInodeFile

java.lang.Object

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

alluxio.master.file.meta.MutableInodeFile

All Implemented Interfaces:

InodeFileView, InodeView, JournalEntryRepresentable, java.lang.Comparable<InodeView>

@NotThreadSafe
public final class MutableInodeFile
extends MutableInode<MutableInodeFile>
implements InodeFileView

Alluxio file system's file 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 MutableInodeFile	create(long blockContainerId, long parentId, java.lang.String name, long creationTimeMs, CreateFileContext context) Creates an MutableInodeFile.
static MutableInodeFile	fromJournalEntry(File.InodeFileEntry entry) Converts the entry to an MutableInodeFile.
static MutableInodeFile	fromProto(InodeMeta.InodeOrBuilder inode)
FileInfo	generateClientFileInfo(java.lang.String path) Generates a FileInfo of the file or folder.
long	getBlockContainerId()
long	getBlockIdByIndex(int blockIndex) Gets the block id for a given index.
java.util.List<java.lang.Long>	getBlockIds()
long	getBlockSizeBytes()
DefaultAccessControlList	getDefaultACL()
long	getLength()
long	getNewBlockId()
long	getPersistJobId()
int	getReplicationDurable()
int	getReplicationMax()
int	getReplicationMin()
long	getShouldPersistTime()
java.lang.String	getTempUfsPath()
protected MutableInodeFile	getThis()
boolean	isCacheable()
boolean	isCompleted()
void	reset() Resets the file inode.
MutableInodeFile	setBlockIds(java.util.List<java.lang.Long> blockIds)
MutableInodeFile	setBlockSizeBytes(long blockSizeBytes)
MutableInodeFile	setCacheable(boolean cacheable)
MutableInodeFile	setCompleted(boolean completed)
MutableInodeFile	setDefaultACL(DefaultAccessControlList acl)
MutableInodeFile	setLength(long length)
MutableInodeFile	setPersistJobId(long persistJobId)
MutableInodeFile	setReplicationDurable(int replicationDurable)
MutableInodeFile	setReplicationMax(int replicationMax)
MutableInodeFile	setReplicationMin(int replicationMin)
MutableInodeFile	setShouldPersistTime(long shouldPersistTime)
MutableInodeFile	setTempUfsPath(java.lang.String tempUfsPath)
Journal.JournalEntry	toJournalEntry()
Journal.JournalEntry	toJournalEntry(java.lang.String path)
InodeMeta.Inode	toProto()
java.lang.String	toString()
void	updateFromEntry(File.UpdateInodeFileEntry entry) Updates this inode file'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 MutableInodeFile getThis()

Specified by:

getThis in class MutableInode<MutableInodeFile>

Returns:

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

generateClientFileInfo

public FileInfo generateClientFileInfo(java.lang.String path)

Description copied from interface: InodeView

Generates a FileInfo of the file or folder.

Specified by:

generateClientFileInfo in interface InodeView

Specified by:

generateClientFileInfo in class MutableInode<MutableInodeFile>

Parameters:

path - the path of the file

Returns:

generated FileInfo

reset

public void reset()

Resets the file inode.

getDefaultACL

public DefaultAccessControlList getDefaultACL()
                                       throws java.lang.UnsupportedOperationException

Specified by:

getDefaultACL in interface InodeView

Returns:

the default ACL associated with this inode

Throws:

java.lang.UnsupportedOperationException - if the inode is a file

setDefaultACL

public MutableInodeFile setDefaultACL(DefaultAccessControlList acl)
                               throws java.lang.UnsupportedOperationException

Specified by:

setDefaultACL in class MutableInode<MutableInodeFile>

Parameters:

acl - set the default ACL associated with this inode

Returns:

the updated object

Throws:

java.lang.UnsupportedOperationException - if the inode is a file

getBlockIds

public java.util.List<java.lang.Long> getBlockIds()

Specified by:

getBlockIds in interface InodeFileView

Returns:

a duplication of all the block ids of the file

getBlockSizeBytes

public long getBlockSizeBytes()

Specified by:

getBlockSizeBytes in interface InodeFileView

Returns:

the block size in bytes

getLength

public long getLength()

Specified by:

getLength in interface InodeFileView

Returns:

the length of the file in bytes. This is not accurate before the file is closed

getBlockContainerId

public long getBlockContainerId()

Specified by:

getBlockContainerId in interface InodeFileView

Returns:

the block container ID for this inode file

getBlockIdByIndex

public long getBlockIdByIndex(int blockIndex)
                       throws BlockInfoException

Description copied from interface: InodeFileView

Gets the block id for a given index.

Specified by:

getBlockIdByIndex in interface InodeFileView

Parameters:

blockIndex - the index to get the block id for

Returns:

the block id for the index

Throws:

BlockInfoException - if the index of the block is out of range

getPersistJobId

public long getPersistJobId()

Specified by:

getPersistJobId in interface InodeFileView

Returns:

the job id of the job persisting this file

getShouldPersistTime

public long getShouldPersistTime()

Specified by:

getShouldPersistTime in interface InodeFileView

Returns:

the time that this file should start persisting

getReplicationDurable

public int getReplicationDurable()

Specified by:

getReplicationDurable in interface InodeFileView

Returns:

the durable number of block replication

getReplicationMax

public int getReplicationMax()

Specified by:

getReplicationMax in interface InodeFileView

Returns:

the maximum number of block replication

getReplicationMin

public int getReplicationMin()

Specified by:

getReplicationMin in interface InodeFileView

Returns:

the minimum number of block replication

getTempUfsPath

public java.lang.String getTempUfsPath()

Specified by:

getTempUfsPath in interface InodeFileView

Returns:

the temporary UFS path this file is persisted to

isCacheable

public boolean isCacheable()

Specified by:

isCacheable in interface InodeFileView

Returns:

true if the file is cacheable, false otherwise

isCompleted

public boolean isCompleted()

Specified by:

isCompleted in interface InodeFileView

Returns:

true if the file is complete, false otherwise

getNewBlockId

public long getNewBlockId()

Returns:

the id of a new block of the file

setBlockSizeBytes

public MutableInodeFile setBlockSizeBytes(long blockSizeBytes)

Parameters:

blockSizeBytes - the block size to use

Returns:

the updated object

setBlockIds

public MutableInodeFile setBlockIds(java.util.List<java.lang.Long> blockIds)

Parameters:

blockIds - the id's of the block

Returns:

the updated object

setCacheable

public MutableInodeFile setCacheable(boolean cacheable)

Parameters:

cacheable - the cacheable flag value to use

Returns:

the updated object

setCompleted

public MutableInodeFile setCompleted(boolean completed)

Parameters:

completed - the complete flag value to use

Returns:

the updated object

setLength

public MutableInodeFile setLength(long length)

Parameters:

length - the length to use

Returns:

the updated object

setPersistJobId

public MutableInodeFile setPersistJobId(long persistJobId)

Parameters:

persistJobId - the id of the job persisting this file

Returns:

the updated object

setShouldPersistTime

public MutableInodeFile setShouldPersistTime(long shouldPersistTime)

Parameters:

shouldPersistTime - the time that this file should start persisting

Returns:

the updated object

setReplicationDurable

public MutableInodeFile setReplicationDurable(int replicationDurable)

Parameters:

replicationDurable - the durable number of block replication

Returns:

the updated object

setReplicationMax

public MutableInodeFile setReplicationMax(int replicationMax)

Parameters:

replicationMax - the maximum number of block replication

Returns:

the updated object

setReplicationMin

public MutableInodeFile setReplicationMin(int replicationMin)

Parameters:

replicationMin - the minimum number of block replication

Returns:

the updated object

setTempUfsPath

public MutableInodeFile setTempUfsPath(java.lang.String tempUfsPath)

Parameters:

tempUfsPath - the temporary UFS path this file is persisted to

Returns:

the updated object

updateFromEntry

public void updateFromEntry(File.UpdateInodeFileEntry entry)

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

Parameters:

entry - the entry

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fromJournalEntry

public static MutableInodeFile fromJournalEntry(File.InodeFileEntry entry)

Converts the entry to an MutableInodeFile.

Parameters:

entry - the entry to convert

Returns:

the MutableInodeFile representation

create

public static MutableInodeFile create(long blockContainerId,
                                      long parentId,
                                      java.lang.String name,
                                      long creationTimeMs,
                                      CreateFileContext context)

Creates an MutableInodeFile.

Parameters:

blockContainerId - block container id of this inode

parentId - id of the parent of this inode

name - name of this inode

creationTimeMs - the creation time for this inode

context - context to create this file

Returns:

the MutableInodeFile representation

toJournalEntry

public Journal.JournalEntry toJournalEntry()

Specified by:

toJournalEntry in interface JournalEntryRepresentable

toJournalEntry

public Journal.JournalEntry toJournalEntry(java.lang.String path)

Specified by:

toJournalEntry in class MutableInode<MutableInodeFile>

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 MutableInodeFile fromProto(InodeMeta.InodeOrBuilder inode)

Parameters:

inode - a protocol buffer inode

Returns:

the MutableInodeFile for the inode