alluxio.master.file.meta

Interface InodeView

All Superinterfaces:

java.lang.Comparable<InodeView>, JournalEntryRepresentable

All Known Subinterfaces:

InodeDirectoryView, InodeFileView

All Known Implementing Classes:

Inode, InodeDirectory, InodeFile, MutableInode, MutableInodeDirectory, MutableInodeFile

public interface InodeView
extends JournalEntryRepresentable, java.lang.Comparable<InodeView>

Read-only view of an inode.

Method Summary

Modifier and Type	Method and Description
boolean	checkPermission(java.lang.String user, java.util.List<java.lang.String> groups, AclAction action) Checks whether the user or one of the groups has the permission to take the action.
default int	compareTo(InodeView o)
FileInfo	generateClientFileInfo(java.lang.String path) Generates a FileInfo of the file or folder.
AccessControlList	getACL()
long	getCreationTimeMs()
DefaultAccessControlList	getDefaultACL()
java.lang.String	getGroup()
long	getId()
long	getLastAccessTimeMs()
long	getLastModificationTimeMs()
java.util.Set<java.lang.String>	getMediumTypes()
short	getMode()
java.lang.String	getName()
java.lang.String	getOwner()
long	getParentId()
AclActions	getPermission(java.lang.String user, java.util.List<java.lang.String> groups) Gets the permitted actions for a user.
PersistenceState	getPersistenceState()
long	getTtl()
TtlAction	getTtlAction()
java.lang.String	getUfsFingerprint()
java.util.Map<java.lang.String,byte[]>	getXAttr()
boolean	isDeleted()
boolean	isDirectory()
boolean	isFile()
boolean	isPersisted()
boolean	isPinned()
InodeMeta.Inode	toProto()

Methods inherited from interface alluxio.master.journal.JournalEntryRepresentable

toJournalEntry

Method Detail

getCreationTimeMs

long getCreationTimeMs()

Returns:

the create time, in milliseconds

getGroup

java.lang.String getGroup()

Returns:

the group of the inode

getId

long getId()

Returns:

the id of the inode

getTtl

long getTtl()

Returns:

the ttl of the file

getTtlAction

TtlAction getTtlAction()

Returns:

the TtlAction

getLastModificationTimeMs

long getLastModificationTimeMs()

Returns:

the last modification time, in milliseconds

getLastAccessTimeMs

long getLastAccessTimeMs()

Returns:

the last access time, in milliseconds

getName

java.lang.String getName()

Returns:

the name of the inode

getMode

short getMode()

Returns:

the mode of the inode

getPersistenceState

PersistenceState getPersistenceState()

Returns:

the PersistenceState of the inode

getParentId

long getParentId()

Returns:

the id of the parent folder

getOwner

java.lang.String getOwner()

Returns:

the owner of the inode

getXAttr

@Nullable
java.util.Map<java.lang.String,byte[]> getXAttr()

Returns:

any extended attributes on the inode

isDeleted

boolean isDeleted()

Returns:

true if the inode is deleted, false otherwise

isDirectory

boolean isDirectory()

Returns:

true if the inode is a directory, false otherwise

isFile

boolean isFile()

Returns:

true if the inode is a file, false otherwise

isPinned

boolean isPinned()

Returns:

true if the inode is pinned, false otherwise

isPersisted

boolean isPersisted()

Returns:

true if the file has persisted, false otherwise

getMediumTypes

java.util.Set<java.lang.String> getMediumTypes()

Returns:

the pinned medium types set

getUfsFingerprint

java.lang.String getUfsFingerprint()

Returns:

the UFS fingerprint

getACL

AccessControlList getACL()

Returns:

the access control list

getDefaultACL

DefaultAccessControlList getDefaultACL()
                                throws java.lang.UnsupportedOperationException

Returns:

the default ACL associated with this inode

Throws:

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

generateClientFileInfo

FileInfo generateClientFileInfo(java.lang.String path)

Generates a FileInfo of the file or folder.

Parameters:

path - the path of the file

Returns:

generated FileInfo

checkPermission

boolean checkPermission(java.lang.String user,
                        java.util.List<java.lang.String> groups,
                        AclAction action)

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

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

AclActions getPermission(java.lang.String user,
                         java.util.List<java.lang.String> groups)

Gets the permitted actions for a user.

Parameters:

user - the user

groups - the groups the user belongs to

Returns:

the permitted actions

See Also:

AccessControlList.getPermission(String, List)

toProto

InodeMeta.Inode toProto()

Returns:

the protocol buffer representation of the inode

compareTo

default int compareTo(InodeView o)

Specified by:

compareTo in interface java.lang.Comparable<InodeView>