Package alluxio.master

Class LocalAlluxioCluster

java.lang.Object

alluxio.master.AbstractLocalAlluxioCluster

alluxio.master.LocalAlluxioCluster

@NotThreadSafe
public final class LocalAlluxioCluster
extends AbstractLocalAlluxioCluster

Local Alluxio cluster for integration tests. Example to use

 // Create a cluster instance
 localAlluxioCluster = new LocalAlluxioCluster(WORKER_CAPACITY_BYTES, BLOCK_SIZE_BYTES);
 // If you have special conf parameter to set for integration tests:
 AlluxioConfiguration testConf = localAlluxioCluster.newTestConf();
 testConf.set(Constants.USER_FILE_BUFFER_BYTES, String.valueOf(BUFFER_BYTES));
 // After setting up the test conf, start this local cluster:
 localAlluxioCluster.start(testConf);
 

Field Summary

Fields inherited from class alluxio.master.AbstractLocalAlluxioCluster

mHostname, mProxyProcess, mProxyThread, mWorkDirectory, mWorkers, mWorkerThreads

Constructor Summary

Constructors

Constructor	Description
LocalAlluxioCluster()	Runs a test Alluxio cluster with a single Alluxio worker.
LocalAlluxioCluster(int numWorkers, boolean includeSecondary)
LocalAlluxioCluster(int numWorkers, boolean includeSecondary, boolean includeProxy)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAlluxioHome()
alluxio.client.file.FileSystem	getClient()	Returns a FileSystem client.
alluxio.client.file.FileSystem	getClient(alluxio.client.file.FileSystemContext context)
java.lang.String	getHostname()
LocalAlluxioMaster	getLocalAlluxioMaster()
int	getMasterRpcPort()
java.lang.String	getMasterURI()
alluxio.wire.WorkerNetAddress	getWorkerAddress()
alluxio.worker.WorkerProcess	getWorkerProcess()
void	initConfiguration(java.lang.String name)	Creates a default Configuration for testing.
void	startMasters()	Configures and starts the master(s).
protected void	startProxy()	Configures and starts the proxy.
void	stop()	Stops both the alluxio and underfs service threads.
void	stopMasters()	Stops the masters.

Methods inherited from class alluxio.master.AbstractLocalAlluxioCluster

formatAndRestartMasters, getProxyProcess, isStartedWorkers, reset, resetClientPools, restartMasters, setAlluxioWorkDirectory, setHostname, setupTest, start, startWorkers, stopFS, stopProxy, stopWorkers, waitForMasterServing, waitForWorkersRegistered

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalAlluxioCluster

public LocalAlluxioCluster()

Runs a test Alluxio cluster with a single Alluxio worker.

LocalAlluxioCluster

public LocalAlluxioCluster(int numWorkers,
                           boolean includeSecondary,
                           boolean includeProxy)

Parameters:

numWorkers - the number of workers to run

includeSecondary - weather to include the secondary master

includeProxy - weather to include the proxy

LocalAlluxioCluster

public LocalAlluxioCluster(int numWorkers,
                           boolean includeSecondary)

Parameters:

numWorkers - the number of workers to run

includeSecondary - weather to include the secondary master

Method Detail

getClient

public alluxio.client.file.FileSystem getClient()
                                         throws java.io.IOException

Description copied from class: AbstractLocalAlluxioCluster

Returns a FileSystem client.

Specified by:

getClient in class AbstractLocalAlluxioCluster

Returns:

a FileSystem client

Throws:

java.io.IOException

getClient

public alluxio.client.file.FileSystem getClient(alluxio.client.file.FileSystemContext context)
                                         throws java.io.IOException

Specified by:

getClient in class AbstractLocalAlluxioCluster

Parameters:

context - the FileSystemContext to use

Returns:

a FileSystem client, using a specific context

Throws:

java.io.IOException

getLocalAlluxioMaster

public LocalAlluxioMaster getLocalAlluxioMaster()

Specified by:

getLocalAlluxioMaster in class AbstractLocalAlluxioCluster

Returns:

the local Alluxio master

getHostname

public java.lang.String getHostname()

Returns:

the hostname of the cluster

getMasterURI

public java.lang.String getMasterURI()

Returns:

the URI of the master

getMasterRpcPort

public int getMasterRpcPort()

Returns:

the RPC port of the master

getAlluxioHome

public java.lang.String getAlluxioHome()

Returns:

the home path to Alluxio

getWorkerProcess

public alluxio.worker.WorkerProcess getWorkerProcess()

Returns:

the first worker

getWorkerAddress

public alluxio.wire.WorkerNetAddress getWorkerAddress()

Returns:

the address of the first worker

initConfiguration

public void initConfiguration(java.lang.String name)
                       throws java.io.IOException

Description copied from class: AbstractLocalAlluxioCluster

Creates a default Configuration for testing.

Specified by:

initConfiguration in class AbstractLocalAlluxioCluster

Parameters:

name - the name of the test/cluster

Throws:

java.io.IOException

startMasters

public void startMasters()
                  throws java.lang.Exception

Description copied from class: AbstractLocalAlluxioCluster

Configures and starts the master(s).

Specified by:

startMasters in class AbstractLocalAlluxioCluster

Throws:

java.lang.Exception

startProxy

protected void startProxy()
                   throws java.lang.Exception

Description copied from class: AbstractLocalAlluxioCluster

Configures and starts the proxy.

Overrides:

startProxy in class AbstractLocalAlluxioCluster

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Description copied from class: AbstractLocalAlluxioCluster

Stops both the alluxio and underfs service threads.

Overrides:

stop in class AbstractLocalAlluxioCluster

Throws:

java.lang.Exception

stopMasters

public void stopMasters()
                 throws java.lang.Exception

Description copied from class: AbstractLocalAlluxioCluster

Stops the masters.

Specified by:

stopMasters in class AbstractLocalAlluxioCluster

Throws:

java.lang.Exception