alluxio.master.file

Class DefaultPermissionChecker

java.lang.Object

alluxio.master.file.DefaultPermissionChecker

All Implemented Interfaces:

PermissionChecker

@NotThreadSafe
public class DefaultPermissionChecker
extends java.lang.Object
implements PermissionChecker

Default implementation of permission checker.

Constructor Summary

Constructors

Constructor and Description
DefaultPermissionChecker(InodeTree inodeTree) Constructs a PermissionChecker instance for Alluxio file system.

Method Summary

Modifier and Type	Method and Description
protected void	checkInodeList(java.lang.String user, java.util.List<java.lang.String> groups, Mode.Bits bits, java.lang.String path, java.util.List<InodeView> inodeList, boolean checkIsOwner) This method provides basic permission checking logic on a list of inodes.
void	checkParentPermission(Mode.Bits bits, LockedInodePath inodePath) Checks whether a user has permission to perform a specific action on the parent of the given path; if parent directory does not exist, treats the closest ancestor directory of the path as its parent and checks permission on it.
void	checkPermission(Mode.Bits bits, LockedInodePath inodePath) Checks whether a user has permission to perform a specific action on a path.
void	checkSetAttributePermission(LockedInodePath inodePath, boolean superuserRequired, boolean ownerRequired, boolean writeRequired) Checks whether a user has permission to edit the attribute of a given path.
Mode.Bits	getPermission(LockedInodePath inodePath) Gets the permission to access inodePath for the current client user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPermissionChecker

public DefaultPermissionChecker(InodeTree inodeTree)

Constructs a PermissionChecker instance for Alluxio file system.

Parameters:

inodeTree - inode tree of the file system master

Method Detail

checkParentPermission

public void checkParentPermission(Mode.Bits bits,
                                  LockedInodePath inodePath)
                           throws AccessControlException,
                                  InvalidPathException

Description copied from interface: PermissionChecker

Checks whether a user has permission to perform a specific action on the parent of the given path; if parent directory does not exist, treats the closest ancestor directory of the path as its parent and checks permission on it. This check will pass if the path is invalid, or path has no parent (e.g., root).

Specified by:

checkParentPermission in interface PermissionChecker

Parameters:

bits - bits that capture the action Mode.Bits by user

inodePath - the path to check permission on

Throws:

AccessControlException - if permission checking fails

InvalidPathException - if the path is invalid

checkPermission

public void checkPermission(Mode.Bits bits,
                            LockedInodePath inodePath)
                     throws AccessControlException

Description copied from interface: PermissionChecker

Checks whether a user has permission to perform a specific action on a path. This check will pass if the path is invalid.

Specified by:

checkPermission in interface PermissionChecker

Parameters:

bits - bits that capture the action Mode.Bits by user

inodePath - the path to check permission on

Throws:

AccessControlException - if permission checking fails

getPermission

public Mode.Bits getPermission(LockedInodePath inodePath)

Description copied from interface: PermissionChecker

Gets the permission to access inodePath for the current client user.

Specified by:

getPermission in interface PermissionChecker

Parameters:

inodePath - the inode path

Returns:

the permission

checkSetAttributePermission

public void checkSetAttributePermission(LockedInodePath inodePath,
                                        boolean superuserRequired,
                                        boolean ownerRequired,
                                        boolean writeRequired)
                                 throws AccessControlException,
                                        InvalidPathException

Description copied from interface: PermissionChecker

Checks whether a user has permission to edit the attribute of a given path.

Specified by:

checkSetAttributePermission in interface PermissionChecker

Parameters:

inodePath - the path to check permission on

superuserRequired - indicates whether it requires to be the superuser

ownerRequired - indicates whether it requires to be the owner of this path

writeRequired - indicates whether it requires to have write permissions

Throws:

AccessControlException - if permission checking fails

InvalidPathException - if the path is invalid

checkInodeList

protected void checkInodeList(java.lang.String user,
                              java.util.List<java.lang.String> groups,
                              Mode.Bits bits,
                              java.lang.String path,
                              java.util.List<InodeView> inodeList,
                              boolean checkIsOwner)
                       throws AccessControlException

This method provides basic permission checking logic on a list of inodes. The input includes user and its group, requested action and inode list (by traversing the path). Then user, group, and the requested action will be evaluated on each of the inodes. It will return if check passed, and throw exception if check failed.

Parameters:

user - who requests access permission

groups - in which user belongs to

bits - bits that capture the action Mode.Bits by user

path - the path to check permission on

inodeList - file info list of all the inodes retrieved by traversing the path

checkIsOwner - indicates whether to check the user is the owner of the path

Throws:

AccessControlException - if permission checking fails