alluxio.underfs

Class UnderFileSystemCluster

java.lang.Object

alluxio.underfs.UnderFileSystemCluster

Direct Known Subclasses:

LocalFileSystemCluster

@NotThreadSafe
public abstract class UnderFileSystemCluster
extends Object

Base class for a UFS cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mBaseDir

Constructor Summary

Constructors

Constructor and Description
UnderFileSystemCluster(String baseDir)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Cleans up the test environment over underfs cluster system, so that we can re-use the running system for the next test round instead of turning on/off it from time to time.
static UnderFileSystemCluster	get()
static UnderFileSystemCluster	get(String baseDir) Creates an underfs test bed and register the shutdown hook.
abstract String	getUnderFilesystemAddress()
static UnderFileSystemCluster	getUnderFilesystemCluster(String baseDir) Gets the UnderFileSystemCluster.
static String	getUnderFSClass()
abstract boolean	isStarted()
void	registerJVMOnExistHook() Adds a shutdown hook.
abstract void	shutdown() Stops the underfs cluster system.
abstract void	start() Starts the underfs cluster system.

Methods inherited from class java.lang.Object

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

Field Detail

mBaseDir

protected String mBaseDir

Constructor Detail

UnderFileSystemCluster

public UnderFileSystemCluster(String baseDir)

Parameters:

baseDir - the base directory

Method Detail

get

public static UnderFileSystemCluster get()

Returns:

the existing underfs, throwing IllegalStateException if it hasn't been initialized yet

get

public static UnderFileSystemCluster get(String baseDir)
                                  throws IOException

Creates an underfs test bed and register the shutdown hook.

Parameters:

baseDir - base directory

Returns:

an instance of the UnderFileSystemCluster class

Throws:

IOException - when the operation fails

getUnderFilesystemCluster

public static UnderFileSystemCluster getUnderFilesystemCluster(String baseDir)

Gets the UnderFileSystemCluster.

Parameters:

baseDir - the base directory

Returns:

the UnderFileSystemCluster

getUnderFSClass

public static String getUnderFSClass()

Returns:

the UnderFileSystem class name

cleanup

public void cleanup()
             throws IOException

Cleans up the test environment over underfs cluster system, so that we can re-use the running system for the next test round instead of turning on/off it from time to time. This function is expected to be called either before or after each test case which avoids certain overhead from the bootstrap.

Throws:

IOException - when the operation fails

getUnderFilesystemAddress

public abstract String getUnderFilesystemAddress()

Returns:

the address of the UFS

isStarted

public abstract boolean isStarted()

Returns:

if the cluster has started

registerJVMOnExistHook

public void registerJVMOnExistHook()
                            throws IOException

Adds a shutdown hook. The shutdown() phase will be automatically called while the process exists.

Throws:

IOException - when the operation fails

shutdown

public abstract void shutdown()
                       throws IOException

Stops the underfs cluster system.

Throws:

IOException - when the operation fails

start

public abstract void start()
                    throws IOException

Starts the underfs cluster system.

Throws:

IOException - when the operation fails