alluxio.master.file

Interface PermissionChecker

All Known Implementing Classes:

DefaultPermissionChecker

public interface PermissionChecker

interface to provide permission check logic.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

checkParentPermission

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

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).

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

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

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

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

getPermission

Mode.Bits getPermission(LockedInodePath inodePath)

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

Parameters:

inodePath - the inode path

Returns:

the permission

checkSetAttributePermission

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

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

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