alluxio.fuse

Class AlluxioFuse

java.lang.Object

alluxio.fuse.AlluxioFuse

@ThreadSafe
public class AlluxioFuse
extends Object

Main entry point to Alluxio-FUSE.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlluxioFuse()

Method Summary

Modifier and Type	Method and Description
protected FileSystem	createBaseFileSystem(FileSystemContext fsContext, FuseOptions fuseOptions)
AlluxioJniFuseFileSystem	createFuseFileSystem(FileSystemContext fsContext, FileSystem fs, FuseOptions fuseOptions) Create a FuseFileSystem instance.
protected AlluxioJniFuseFileSystem	createJniFuseSystem(FileSystemContext fsContext, FileSystem fs, FuseOptions fuseOptions)
static AlluxioJniFuseFileSystem	launchFuse(AlluxioJniFuseFileSystem fuseFs, FileSystemContext fsContext, FuseOptions fuseOptions, boolean blocking) Launches Fuse application.
static void	main(String[] args) Running this class will mount the file system according to the options passed to this function.
protected static InstancedConfiguration	parseCliOptionsAsConfig(FuseCliOptions cli) Converts command line options into Alluxio configuration.
void	setupFuseFileSystem(AlluxioJniFuseFileSystem jniFuseFileSystem) Set up the FUSE file system AlluxioJniFuseFileSystem before mounting.
void	start(AlluxioConfiguration conf) Startup the FUSE process.
protected void	startCommon(AlluxioConfiguration conf, FuseOptions fuseOptions, FileSystemContext fsContext) Start common functionalities for a fuse client.
protected static void	startJvmMonitorProcess() Starts jvm monitor process, to monitor jvm.
protected void	stopCommon()
protected static void	validateFuseConfAndOptions(AlluxioConfiguration conf, FuseOptions options)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlluxioFuse

protected AlluxioFuse()

Method Detail

startCommon

protected void startCommon(AlluxioConfiguration conf,
                           FuseOptions fuseOptions,
                           FileSystemContext fsContext)

Start common functionalities for a fuse client.

Parameters:

conf - the Alluxio configuration

fuseOptions - Fuse options from conf or command line

fsContext - the file system context for this client

stopCommon

protected void stopCommon()

start

public void start(AlluxioConfiguration conf)
           throws org.apache.commons.cli.ParseException,
                  IOException

Startup the FUSE process.

Parameters:

conf - configuration

Throws:

org.apache.commons.cli.ParseException

IOException

main

public static void main(String[] args)
                 throws org.apache.commons.cli.ParseException,
                        IOException

Running this class will mount the file system according to the options passed to this function. The user-space fuse application will stay on the foreground and keep the file system mounted. The user can unmount the file system by gracefully killing (SIGINT) the process.

Parameters:

args - arguments to run the command line

Throws:

org.apache.commons.cli.ParseException

IOException

createBaseFileSystem

protected FileSystem createBaseFileSystem(FileSystemContext fsContext,
                                          FuseOptions fuseOptions)

createFuseFileSystem

public AlluxioJniFuseFileSystem createFuseFileSystem(FileSystemContext fsContext,
                                                     FileSystem fs,
                                                     FuseOptions fuseOptions)

Create a FuseFileSystem instance.

Parameters:

fsContext - the context of the file system on which FuseFileSystem based on

fs - the file system on which FuseFileSystem based on

fuseOptions - the fuse options

Returns:

a FuseFileSystem instance

createJniFuseSystem

protected AlluxioJniFuseFileSystem createJniFuseSystem(FileSystemContext fsContext,
                                                       FileSystem fs,
                                                       FuseOptions fuseOptions)

setupFuseFileSystem

public void setupFuseFileSystem(AlluxioJniFuseFileSystem jniFuseFileSystem)

Set up the FUSE file system AlluxioJniFuseFileSystem before mounting.

Parameters:

jniFuseFileSystem - the instance of AlluxioJniFuseFileSystem

launchFuse

public static AlluxioJniFuseFileSystem launchFuse(AlluxioJniFuseFileSystem fuseFs,
                                                  FileSystemContext fsContext,
                                                  FuseOptions fuseOptions,
                                                  boolean blocking)

Launches Fuse application.

Parameters:

fuseFs - the fuse file system

fsContext - file system context for Fuse client to communicate to servers

fuseOptions - Fuse options

blocking - whether the Fuse application is blocking or not

Returns:

the Fuse application handler for future Fuse umount operation

parseCliOptionsAsConfig

protected static InstancedConfiguration parseCliOptionsAsConfig(FuseCliOptions cli)

Converts command line options into Alluxio configuration.

Parameters:

cli - the command line inputs

Returns:

configuration containing the properties parsed from cli

validateFuseConfAndOptions

protected static void validateFuseConfAndOptions(AlluxioConfiguration conf,
                                                 FuseOptions options)

startJvmMonitorProcess

protected static void startJvmMonitorProcess()

Starts jvm monitor process, to monitor jvm.