alluxio.fuse

Class AlluxioFuseUtils

java.lang.Object

alluxio.fuse.AlluxioFuseUtils

@ThreadSafe
public final class AlluxioFuseUtils
extends Object

Utility methods for Alluxio-FUSE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlluxioFuseUtils.CloseableFuseFileInfo Creates a closeable fuse file info.
static interface	AlluxioFuseUtils.FuseCallable An interface representing a callable for FUSE APIs.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ID_NOT_SET_VALUE
static long	ID_NOT_SET_VALUE_UNSIGNED
static String	MACFUSE_SUPPORT_MINIMUM_OS_VERSION
static int	MAX_NAME_LENGTH Most FileSystems on linux limit the length of file name beyond 255 characters.
static long	MODE_NOT_SET_VALUE

Method Summary

Modifier and Type	Method and Description
static int	call(org.slf4j.Logger logger, AlluxioFuseUtils.FuseCallable callable, String methodName, String description, Object... args) Calls the given AlluxioFuseUtils.FuseCallable and returns its result.
static int	checkNameLength(AlluxioURI uri) Checks the input file length.
static int	compareVersion(String version1, String version2) Compares two version.
static FileOutStream	createFile(FileSystem fileSystem, AuthPolicy authPolicy, AlluxioURI uri, CreateFileStatus fileStatus) Creates a file in alluxio namespace.
static void	deletePath(FileSystem fileSystem, AlluxioURI uri) Deletes a file or a directory in alluxio namespace.
static void	fillStat(AuthPolicy policy, FileStat stat, URIStatus status) Fills the path status.
static void	fillStat(FileStat stat, CreateFileStatus status) Fills the path status.
static int	getErrorCode(Throwable t) Gets the corresponding error code of a throwable.
static Optional<Long>	getGidFromGroupName(String groupName) Retrieves the gid of the given group.
static Optional<Long>	getGidFromUserName(String userName) Retrieves the primary gid of the given user.
static Optional<String>	getGroupName(long gid) Gets the group name from the group id.
static Optional<String>	getGroupName(String userName) Gets the primary group name from the user name.
static LibfuseVersion	getLibfuseVersion(AlluxioConfiguration conf) Gets the libjnifuse version preference set by user.
static String	getMountedRootPath(AlluxioConfiguration conf, FuseOptions fuseOptions) Gets the path be mounted to local fuse mount point.
static com.google.common.cache.LoadingCache<String,AlluxioURI>	getPathResolverCache(AlluxioConfiguration conf, FuseOptions options) Gets the cache for resolving FUSE path into AlluxioURI.
static Optional<URIStatus>	getPathStatus(FileSystem fileSystem, AlluxioURI uri) Gets the path status.
static long	getSystemGid()
static long	getSystemUid()
static Optional<Long>	getUid(String userName) Retrieves the uid of the given user.
static Optional<String>	getUserName(long uid) Gets the user name from the user id.
static boolean	isFuseInstalled() Checks whether fuse is installed in local file system.
static boolean	isMacFuse()
static void	setAttribute(FileSystem fileSystem, AlluxioURI uri, SetAttributePOptions options) Sets attribute for a file.
static AlluxioConfiguration	tryLoadingConfigFromMaster(FileSystemContext fsContext) Tries to laod Alluxio config from Alluxio Master through Grpc.
static void	updateDefaultCreateFilePOptionBuilderSupplier(java.util.function.Supplier<CreateFilePOptions.Builder> supplier)
static void	updateStatSize(FileStat stat, long size) Updates file status size.
static Optional<URIStatus>	waitForFileCompleted(FileSystem fileSystem, AlluxioURI uri) Waits for the file to complete.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

Most FileSystems on linux limit the length of file name beyond 255 characters.

See Also:

Constant Field Values

ID_NOT_SET_VALUE

public static final long ID_NOT_SET_VALUE

See Also:

Constant Field Values

ID_NOT_SET_VALUE_UNSIGNED

public static final long ID_NOT_SET_VALUE_UNSIGNED

See Also:

Constant Field Values

MODE_NOT_SET_VALUE

public static final long MODE_NOT_SET_VALUE

See Also:

Constant Field Values

MACFUSE_SUPPORT_MINIMUM_OS_VERSION

public static final String MACFUSE_SUPPORT_MINIMUM_OS_VERSION

See Also:

Constant Field Values

Method Detail

updateDefaultCreateFilePOptionBuilderSupplier

public static void updateDefaultCreateFilePOptionBuilderSupplier(java.util.function.Supplier<CreateFilePOptions.Builder> supplier)

Parameters:

supplier - the new supplier

checkNameLength

public static int checkNameLength(AlluxioURI uri)

Checks the input file length.

Parameters:

uri - the Alluxio URI

Returns:

error code if file length is not allowed, 0 otherwise

createFile

public static FileOutStream createFile(FileSystem fileSystem,
                                       AuthPolicy authPolicy,
                                       AlluxioURI uri,
                                       CreateFileStatus fileStatus)

Creates a file in alluxio namespace.

Parameters:

fileSystem - the file system

authPolicy - the authentication policy

uri - the alluxio uri

fileStatus - the create file status

Returns:

a file out stream

deletePath

public static void deletePath(FileSystem fileSystem,
                              AlluxioURI uri)

Deletes a file or a directory in alluxio namespace.

Parameters:

fileSystem - the file system

uri - the alluxio uri

setAttribute

public static void setAttribute(FileSystem fileSystem,
                                AlluxioURI uri,
                                SetAttributePOptions options)

Sets attribute for a file.

Parameters:

fileSystem - the file system

uri - the alluxio uri

options - the set attribute options

getLibfuseVersion

public static LibfuseVersion getLibfuseVersion(AlluxioConfiguration conf)

Gets the libjnifuse version preference set by user.

Parameters:

conf - the configuration object

Returns:

the version preference

tryLoadingConfigFromMaster

public static AlluxioConfiguration tryLoadingConfigFromMaster(FileSystemContext fsContext)

Tries to laod Alluxio config from Alluxio Master through Grpc.

Parameters:

fsContext - for communicating with master

Returns:

the Alluxio config if loaded successfully; the unmodified conf otherwise

fillStat

public static void fillStat(AuthPolicy policy,
                            FileStat stat,
                            URIStatus status)

Fills the path status.

Parameters:

policy - auth policy

stat - file stat to fill

status - status

fillStat

public static void fillStat(FileStat stat,
                            CreateFileStatus status)

Fills the path status.

Parameters:

stat - file stat to fill

status - the create file status

updateStatSize

public static void updateStatSize(FileStat stat,
                                  long size)

Updates file status size.

Parameters:

stat - stat to file

size - size

getSystemUid

public static long getSystemUid()

Returns:

the system uid

getSystemGid

public static long getSystemGid()

Returns:

the system gid

getUid

public static Optional<Long> getUid(String userName)

Retrieves the uid of the given user.

Parameters:

userName - the user name

Returns:

uid

getGidFromUserName

public static Optional<Long> getGidFromUserName(String userName)

Retrieves the primary gid of the given user.

Parameters:

userName - the user name

Returns:

gid

getGidFromGroupName

public static Optional<Long> getGidFromGroupName(String groupName)

Retrieves the gid of the given group.

Parameters:

groupName - the group name

Returns:

gid

getUserName

public static Optional<String> getUserName(long uid)

Gets the user name from the user id.

Parameters:

uid - user id

Returns:

user name

getGroupName

public static Optional<String> getGroupName(String userName)

Gets the primary group name from the user name.

Parameters:

userName - the user name

Returns:

group name

getGroupName

public static Optional<String> getGroupName(long gid)

Gets the group name from the group id.

Parameters:

gid - the group id

Returns:

group name

isFuseInstalled

public static boolean isFuseInstalled()

Checks whether fuse is installed in local file system. Alluxio-Fuse only support mac and linux.

Returns:

true if fuse is installed, false otherwise

isMacFuse

public static boolean isMacFuse()

Returns:

true if os version is matched to use macFuse

compareVersion

public static int compareVersion(String version1,
                                 String version2)

Compares two version.

Parameters:

version1 - the first os version to compare

version2 - the second os version to compare

Returns:

the value 0 if version1 == version2; a value less than 0 if version1 < version2; and a value greater than 0 if version1 > version2

getErrorCode

public static int getErrorCode(Throwable t)

Gets the corresponding error code of a throwable.

Parameters:

t - throwable

Returns:

the corresponding error code

getPathStatus

public static Optional<URIStatus> getPathStatus(FileSystem fileSystem,
                                                AlluxioURI uri)

Gets the path status.

Parameters:

fileSystem - the file system

uri - the Alluxio uri to get status of

Returns:

the file status

waitForFileCompleted

public static Optional<URIStatus> waitForFileCompleted(FileSystem fileSystem,
                                                       AlluxioURI uri)

Waits for the file to complete. This method is mainly added to make sure the async release() when writing a file finished before getting status of the file or opening the file for read().

Parameters:

fileSystem - the file system to get file status

uri - the file path to check

Returns:

uri status if file is completed and empty otherwise

call

public static int call(org.slf4j.Logger logger,
                       AlluxioFuseUtils.FuseCallable callable,
                       String methodName,
                       String description,
                       Object... args)

Calls the given AlluxioFuseUtils.FuseCallable and returns its result.

Parameters:

logger - the logger to use for this call

callable - the callable to call

methodName - the name of the method, used for metrics

description - the format string of the description, used for logging

args - the arguments for the description

Returns:

the result

getMountedRootPath

public static String getMountedRootPath(AlluxioConfiguration conf,
                                        FuseOptions fuseOptions)

Gets the path be mounted to local fuse mount point.

Parameters:

conf - the configuration to get path from

fuseOptions - the fuse options

Returns:

the mounted root path

getPathResolverCache

public static com.google.common.cache.LoadingCache<String,AlluxioURI> getPathResolverCache(AlluxioConfiguration conf,
                                                                                           FuseOptions options)

Gets the cache for resolving FUSE path into AlluxioURI.

Parameters:

conf - the configuration

options - the FUSE options

Returns:

the cache