alluxio.master.file.meta

Class Inode

java.lang.Object

alluxio.master.file.meta.Inode

All Implemented Interfaces:

InodeView, JournalEntryRepresentable, Comparable<InodeView>

Direct Known Subclasses:

InodeDirectory, InodeFile

public abstract class Inode
extends Object
implements InodeView

Base class for read only inodes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Inode(InodeView delegate)

Method Summary

Modifier and Type	Method and Description
InodeDirectory	asDirectory() Casts the inode as an InodeDirectory if it is one, otherwise throws an exception.
InodeFile	asFile()
boolean	checkPermission(String user, List<String> groups, AclAction action) Checks whether the user or one of the groups has the permission to take the action.
boolean	equals(Object other)
FileInfo	generateClientFileInfo(String path) Generates a FileInfo of the file or folder.
AccessControlList	getACL()
long	getCreationTimeMs()
DefaultAccessControlList	getDefaultACL()
String	getGroup()
long	getId()
long	getLastAccessTimeMs()
long	getLastModificationTimeMs()
com.google.common.collect.ImmutableSet<String>	getMediumTypes()
short	getMode()
String	getName()
String	getOwner()
long	getParentId()
AclActions	getPermission(String user, List<String> groups) Gets the permitted actions for a user.
PersistenceState	getPersistenceState()
long	getTtl()
TtlAction	getTtlAction()
String	getUfsFingerprint()
Map<String,byte[]>	getXAttr()
int	hashCode()
boolean	isDeleted()
boolean	isDirectory()
boolean	isFile()
boolean	isPersisted()
boolean	isPinned()
Journal.JournalEntry	toJournalEntry()
InodeMeta.Inode	toProto()
static Inode	wrap(InodeView delegate) Wraps an InodeView, providing read-only access.

Methods inherited from class java.lang.Object

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

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

compareTo

Constructor Detail

Inode

protected Inode(InodeView delegate)

Method Detail

getCreationTimeMs

public long getCreationTimeMs()

Specified by:

getCreationTimeMs in interface InodeView

Returns:

the create time, in milliseconds

getGroup

public String getGroup()

Specified by:

getGroup in interface InodeView

Returns:

the group of the inode

getId

public long getId()

Specified by:

getId in interface InodeView

Returns:

the id of the inode

getTtl

public long getTtl()

Specified by:

getTtl in interface InodeView

Returns:

the ttl of the file

getTtlAction

public TtlAction getTtlAction()

Specified by:

getTtlAction in interface InodeView

Returns:

the TtlAction

getLastModificationTimeMs

public long getLastModificationTimeMs()

Specified by:

getLastModificationTimeMs in interface InodeView

Returns:

the last modification time, in milliseconds

getLastAccessTimeMs

public long getLastAccessTimeMs()

Specified by:

getLastAccessTimeMs in interface InodeView

Returns:

the last access time, in milliseconds

getName

public String getName()

Specified by:

getName in interface InodeView

Returns:

the name of the inode

getMode

public short getMode()

Specified by:

getMode in interface InodeView

Returns:

the mode of the inode

getPersistenceState

public PersistenceState getPersistenceState()

Specified by:

getPersistenceState in interface InodeView

Returns:

the PersistenceState of the inode

getParentId

public long getParentId()

Specified by:

getParentId in interface InodeView

Returns:

the id of the parent folder

getOwner

public String getOwner()

Specified by:

getOwner in interface InodeView

Returns:

the owner of the inode

getXAttr

@Nullable
public Map<String,byte[]> getXAttr()

Specified by:

getXAttr in interface InodeView

Returns:

any extended attributes on the inode

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface InodeView

Returns:

true if the inode is deleted, false otherwise

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface InodeView

Returns:

true if the inode is a directory, false otherwise

isFile

public boolean isFile()

Specified by:

isFile in interface InodeView

Returns:

true if the inode is a file, false otherwise

isPinned

public boolean isPinned()

Specified by:

isPinned in interface InodeView

Returns:

true if the inode is pinned, false otherwise

isPersisted

public boolean isPersisted()

Specified by:

isPersisted in interface InodeView

Returns:

true if the file has persisted, false otherwise

getUfsFingerprint

public String getUfsFingerprint()

Specified by:

getUfsFingerprint in interface InodeView

Returns:

the UFS fingerprint

getACL

public AccessControlList getACL()

Specified by:

getACL in interface InodeView

Returns:

the access control list

getDefaultACL

public DefaultAccessControlList getDefaultACL()
                                       throws UnsupportedOperationException

Specified by:

getDefaultACL in interface InodeView

Returns:

the default ACL associated with this inode

Throws:

UnsupportedOperationException - if the inode is a file

getMediumTypes

public com.google.common.collect.ImmutableSet<String> getMediumTypes()

Specified by:

getMediumTypes in interface InodeView

Returns:

the pinned medium types set

generateClientFileInfo

public FileInfo generateClientFileInfo(String path)

Description copied from interface: InodeView

Generates a FileInfo of the file or folder.

Specified by:

generateClientFileInfo in interface InodeView

Parameters:

path - the path of the file

Returns:

generated FileInfo

checkPermission

public boolean checkPermission(String user,
                               List<String> groups,
                               AclAction action)

Description copied from interface: InodeView

Checks whether the user or one of the groups has the permission to take the action.

Specified by:

checkPermission in interface InodeView

Parameters:

user - the user checking permission

groups - the groups the user belongs to

action - the action to take

Returns:

whether permitted to take the action

See Also:

AccessControlList.checkPermission(String, List, AclAction)

getPermission

public AclActions getPermission(String user,
                                List<String> groups)

Description copied from interface: InodeView

Gets the permitted actions for a user.

Specified by:

getPermission in interface InodeView

Parameters:

user - the user

groups - the groups the user belongs to

Returns:

the permitted actions

See Also:

AccessControlList.getPermission(String, List)

toProto

public InodeMeta.Inode toProto()

Specified by:

toProto in interface InodeView

Returns:

the protocol buffer representation of the inode

toJournalEntry

public Journal.JournalEntry toJournalEntry()

Specified by:

toJournalEntry in interface JournalEntryRepresentable

Returns:

the Journal.JournalEntry representing this object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asDirectory

public InodeDirectory asDirectory()

Casts the inode as an InodeDirectory if it is one, otherwise throws an exception. This gives convenience in method chaining, e.g. inode.asDirectory().getChildren() instead of ((InodeDirectory) inode).getChildren()

Returns:

the inode as an inode directory

asFile

public InodeFile asFile()

Returns:

the inode as an inode file

wrap

public static Inode wrap(InodeView delegate)

Wraps an InodeView, providing read-only access. Modifications to the underlying inode will affect the created read-only inode.

Parameters:

delegate - the delegate to wrap

Returns:

the created read-only inode