alluxio.master.file.meta

Class MutableInode<T extends MutableInode>

java.lang.Object

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

Type Parameters:

T - the concrete subclass of this object

All Implemented Interfaces:

InodeView, JournalEntryRepresentable, Comparable<InodeView>

Direct Known Subclasses:

MutableInodeDirectory, MutableInodeFile

@NotThreadSafe
public abstract class MutableInode<T extends MutableInode>
extends Object
implements InodeView

MutableInode is an abstract class, with information shared by all types of Inodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessControlList	mAcl
protected long	mCreationTimeMs
protected boolean	mDirectory
protected long	mId
protected long	mTtl
protected TtlAction	mTtlAction

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutableInode(long id, boolean isDirectory)

Method Summary

Modifier and Type	Method and Description
MutableInodeDirectory	asDirectory() Casts the inode as an InodeDirectory if it is one, otherwise throws an exception.
MutableInodeFile	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 o)
static MutableInode<?>	fromProto(InodeMeta.InodeOrBuilder inode)
abstract FileInfo	generateClientFileInfo(String path) Generates a FileInfo of the file or folder.
AccessControlList	getACL()
long	getCreationTimeMs()
String	getGroup()
long	getId()
long	getLastAccessTimeMs()
long	getLastModificationTimeMs()
Set<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()
protected abstract T	getThis()
long	getTtl()
TtlAction	getTtlAction()
String	getUfsFingerprint()
Map<String,byte[]>	getXAttr()
int	hashCode()
boolean	isDeleted()
boolean	isDirectory()
boolean	isFile()
boolean	isPersisted()
boolean	isPinned()
T	removeAcl(List<AclEntry> entries) Removes ACL entries.
T	removeExtendedAcl() Removes the extended ACL entries.
T	replaceAcl(List<AclEntry> entries) Replaces all existing ACL entries with a new list of entries.
T	setAcl(List<AclEntry> entries) Sets ACL entries into the internal ACL.
T	setCreationTimeMs(long creationTimeMs)
abstract T	setDefaultACL(DefaultAccessControlList acl)
T	setDeleted(boolean deleted)
T	setGroup(String group)
T	setInternalAcl(AccessControlList acl) Sets the internal ACL to a specified ACL.
T	setLastAccessTimeMs(long lastAccessTimeMs)
T	setLastAccessTimeMs(long lastAccessTimeMs, boolean override)
T	setLastModificationTimeMs(long lastModificationTimeMs) Sets the last modification time of the inode to the new time if the new time is more recent.
T	setLastModificationTimeMs(long lastModificationTimeMs, boolean override)
T	setMediumTypes(Set<String> mediumTypes)
T	setMode(short mode)
T	setName(String name)
T	setOwner(String owner)
T	setParentId(long parentId)
T	setPersistenceState(PersistenceState persistenceState)
T	setPinned(boolean pinned)
T	setTtl(long ttl)
T	setTtlAction(TtlAction ttlAction)
T	setUfsFingerprint(String ufsFingerprint)
T	setXAttr(Map<String,byte[]> xAttr)
abstract Journal.JournalEntry	toJournalEntry(String path)
protected InodeMeta.Inode.Builder	toProtoBuilder()
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()
void	updateFromEntry(File.UpdateInodeEntry entry) Updates this inode's state from the given entry.
T	updateMask(List<AclEntry> entries) Update Mask for the Inode.

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, getDefaultACL, toProto

Methods inherited from interface alluxio.master.journal.JournalEntryRepresentable

toJournalEntry

Field Detail

mCreationTimeMs

protected long mCreationTimeMs

mDirectory

protected final boolean mDirectory

mId

protected final long mId

mTtl

protected long mTtl

mTtlAction

protected TtlAction mTtlAction

mAcl

protected AccessControlList mAcl

Constructor Detail

MutableInode

protected MutableInode(long id,
                       boolean isDirectory)

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

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

getXAttr

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

Specified by:

getXAttr in interface InodeView

Returns:

any extended attributes on the inode

getMediumTypes

public Set<String> getMediumTypes()

Specified by:

getMediumTypes in interface InodeView

Returns:

the pinned medium types set

removeExtendedAcl

public T removeExtendedAcl()

Removes the extended ACL entries. The base entries are retained.

Returns:

the updated object

removeAcl

public T removeAcl(List<AclEntry> entries)

Removes ACL entries.

Parameters:

entries - the ACL entries to remove

Returns:

the updated object

replaceAcl

public T replaceAcl(List<AclEntry> entries)

Replaces all existing ACL entries with a new list of entries.

Parameters:

entries - the new list of ACL entries

Returns:

the updated object

updateMask

public T updateMask(List<AclEntry> entries)

Update Mask for the Inode. This method should be called after updates to ACL and defaultACL.

Parameters:

entries - the list of ACL entries

Returns:

the updated object

setCreationTimeMs

public T setCreationTimeMs(long creationTimeMs)

Parameters:

creationTimeMs - the creation time to use (in milliseconds)

Returns:

the updated object

setDeleted

public T setDeleted(boolean deleted)

Parameters:

deleted - the deleted flag to use

Returns:

the updated object

setGroup

public T setGroup(String group)

Parameters:

group - the group of the inode

Returns:

the updated object

setLastModificationTimeMs

public T setLastModificationTimeMs(long lastModificationTimeMs)

Sets the last modification time of the inode to the new time if the new time is more recent. This method can be called concurrently with deterministic results.

Parameters:

lastModificationTimeMs - the last modification time to use

Returns:

the updated object

setLastModificationTimeMs

public T setLastModificationTimeMs(long lastModificationTimeMs,
                                   boolean override)

Parameters:

lastModificationTimeMs - the last modification time to use

override - if true, sets the value regardless of the previous last modified time, should be set to true for journal replay

Returns:

the updated object

setLastAccessTimeMs

public T setLastAccessTimeMs(long lastAccessTimeMs)

Parameters:

lastAccessTimeMs - the last access time to use

Returns:

the updated object

setLastAccessTimeMs

public T setLastAccessTimeMs(long lastAccessTimeMs,
                             boolean override)

Parameters:

lastAccessTimeMs - the last access time to use

override - if true, sets the value regardless of the previous last access time, should be set to true for journal replay

Returns:

the updated object

setName

public T setName(String name)

Parameters:

name - the name to use

Returns:

the updated object

setParentId

public T setParentId(long parentId)

Parameters:

parentId - the parent id to use

Returns:

the updated object

setTtl

public T setTtl(long ttl)

Parameters:

ttl - the TTL to use, in milliseconds

Returns:

the updated object

setTtlAction

public T setTtlAction(TtlAction ttlAction)

Parameters:

ttlAction - the TtlAction to use

Returns:

the updated options object

setPersistenceState

public T setPersistenceState(PersistenceState persistenceState)

Parameters:

persistenceState - the PersistenceState to use

Returns:

the updated object

setPinned

public T setPinned(boolean pinned)

Parameters:

pinned - the pinned flag value to use

Returns:

the updated object

setOwner

public T setOwner(String owner)

Parameters:

owner - the owner name of the inode

Returns:

the updated object

setMode

public T setMode(short mode)

Parameters:

mode - the mode of the inode

Returns:

the updated object

setDefaultACL

public abstract T setDefaultACL(DefaultAccessControlList acl)
                         throws UnsupportedOperationException

Parameters:

acl - set the default ACL associated with this inode

Returns:

the updated object

Throws:

UnsupportedOperationException - if the inode is a file

setAcl

public T setAcl(List<AclEntry> entries)

Sets ACL entries into the internal ACL. The entries will overwrite any existing correspondent entries in the internal ACL.

Parameters:

entries - the ACL entries

Returns:

the updated object

setInternalAcl

public T setInternalAcl(AccessControlList acl)

Sets the internal ACL to a specified ACL.

Parameters:

acl - the specified ACL

Returns:

the updated object

setUfsFingerprint

public T setUfsFingerprint(String ufsFingerprint)

Parameters:

ufsFingerprint - the ufs fingerprint to use

Returns:

the updated object

setXAttr

public T setXAttr(Map<String,byte[]> xAttr)

Parameters:

xAttr - The new set of extended attributes

Returns:

the updated object

setMediumTypes

public T setMediumTypes(Set<String> mediumTypes)

Parameters:

mediumTypes - the medium types to pin to

Returns:

the updated object

generateClientFileInfo

public abstract 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

getThis

protected abstract T getThis()

Returns:

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

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)

asDirectory

public MutableInodeDirectory 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 ((MutableInodeDirectory) inode).getChildren()

Returns:

the inode as an inode directory

asFile

public MutableInodeFile asFile()

Returns:

the inode as an inode file

updateFromEntry

public void updateFromEntry(File.UpdateInodeEntry entry)

Updates this inode's state from the given entry.

Parameters:

entry - the entry

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toJournalEntry

public abstract Journal.JournalEntry toJournalEntry(String path)

Parameters:

path - path of the inode

Returns:

the journal entry representing the inode

toStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()

toProtoBuilder

protected InodeMeta.Inode.Builder toProtoBuilder()

fromProto

public static MutableInode<?> fromProto(InodeMeta.InodeOrBuilder inode)

Parameters:

inode - a protocol buffer inode

Returns:

the MutableInode representation for the inode