alluxio.master.file.meta

Class InodeFile

java.lang.Object

alluxio.master.file.meta.Inode<InodeFile>

alluxio.master.file.meta.InodeFile

All Implemented Interfaces:

JournalEntryRepresentable

@NotThreadSafe
public final class InodeFile
extends Inode<InodeFile>

Alluxio file system's file representation in the file system master. The inode must be locked (Inode.lockRead() or Inode.lockWrite()) before methods are called.

Field Summary

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

mCreationTimeMs, mDirectory, mId, mTtl, mTtlAction

Method Summary

Modifier and Type	Method and Description
void	complete(long length) Completes the file.
static InodeFile	create(long blockContainerId, long parentId, String name, long creationTimeMs, CreateFileOptions options) Creates an InodeFile.
static InodeFile	fromJournalEntry(File.InodeFileEntry entry) Converts the entry to an InodeFile.
FileInfo	generateClientFileInfo(String path) Generates a FileInfo of the file or folder.
long	getBlockIdByIndex(int blockIndex) Gets the block id for a given index.
List<Long>	getBlockIds()
long	getBlockSizeBytes()
long	getLength()
long	getNewBlockId()
protected InodeFile	getThis()
boolean	isCacheable()
boolean	isCompleted()
void	reset() Resets the file inode.
InodeFile	setBlockIds(List<Long> blockIds)
InodeFile	setBlockSizeBytes(long blockSizeBytes)
InodeFile	setCacheable(boolean cacheable)
InodeFile	setCompleted(boolean completed)
InodeFile	setLength(long length)
Journal.JournalEntry	toJournalEntry()
String	toString()

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

compareAndSwap, equals, getCreationTimeMs, getGroup, getId, getLastModificationTimeMs, getMode, getName, getOwner, getParentId, getPersistenceState, getTtl, getTtlAction, getUfsFingerprint, hashCode, isDeleted, isDirectory, isFile, isPersisted, isPinned, isReadLocked, isWriteLocked, lockRead, lockReadAndCheckNameAndParent, lockReadAndCheckParent, lockWrite, lockWriteAndCheckNameAndParent, lockWriteAndCheckParent, setCreationTimeMs, setDeleted, setGroup, setLastModificationTimeMs, setLastModificationTimeMs, setMode, setName, setOwner, setParentId, setPersistenceState, setPinned, setTtl, setTtlAction, setUfsFingerprint, toStringHelper, unlockRead, unlockWrite

Methods inherited from class java.lang.Object

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

Method Detail

getThis

protected InodeFile getThis()

Specified by:

getThis in class Inode<InodeFile>

Returns:

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

generateClientFileInfo

public FileInfo generateClientFileInfo(String path)

Description copied from class: Inode

Generates a FileInfo of the file or folder.

Specified by:

generateClientFileInfo in class Inode<InodeFile>

Parameters:

path - the path of the file

Returns:

generated FileInfo

reset

public void reset()

Resets the file inode.

getBlockIds

public List<Long> getBlockIds()

Returns:

a duplication of all the block ids of the file

getBlockSizeBytes

public long getBlockSizeBytes()

Returns:

the block size in bytes

getLength

public long getLength()

Returns:

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

getNewBlockId

public long getNewBlockId()

Returns:

the id of a new block of the file

getBlockIdByIndex

public long getBlockIdByIndex(int blockIndex)
                       throws BlockInfoException

Gets the block id for a given index.

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

isCacheable

public boolean isCacheable()

Returns:

true if the file is cacheable, false otherwise

isCompleted

public boolean isCompleted()

Returns:

true if the file is complete, false otherwise

setBlockSizeBytes

public InodeFile setBlockSizeBytes(long blockSizeBytes)

Parameters:

blockSizeBytes - the block size to use

Returns:

the updated object

setBlockIds

public InodeFile setBlockIds(List<Long> blockIds)

Parameters:

blockIds - the id's of the block

Returns:

the updated object

setCacheable

public InodeFile setCacheable(boolean cacheable)

Parameters:

cacheable - the cacheable flag value to use

Returns:

the updated object

setCompleted

public InodeFile setCompleted(boolean completed)

Parameters:

completed - the complete flag value to use

Returns:

the updated object

setLength

public InodeFile setLength(long length)

Parameters:

length - the length to use

Returns:

the updated object

complete

public void complete(long length)
              throws InvalidFileSizeException,
                     FileAlreadyCompletedException

Completes the file. Cannot set the length if the file is already completed. However, an unknown file size, Constants.UNKNOWN_SIZE, is valid. Cannot complete an already complete file, unless the completed length was previously Constants.UNKNOWN_SIZE.

Parameters:

length - The new length of the file, cannot be negative, but can be Constants.UNKNOWN_SIZE

Throws:

InvalidFileSizeException - if invalid file size is encountered

FileAlreadyCompletedException - if the file is already completed

toString

public String toString()

Overrides:

toString in class Object

fromJournalEntry

public static InodeFile fromJournalEntry(File.InodeFileEntry entry)

Converts the entry to an InodeFile.

Parameters:

entry - the entry to convert

Returns:

the InodeFile representation

create

public static InodeFile create(long blockContainerId,
                               long parentId,
                               String name,
                               long creationTimeMs,
                               CreateFileOptions options)

Creates an InodeFile.

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

options - options to create this file

Returns:

the InodeFile representation

toJournalEntry

public Journal.JournalEntry toJournalEntry()

Returns:

the Journal.JournalEntry representing this object