AbstractLocalAlluxioCluster (Alluxio MiniCluster 1.5.0 API)

java.lang.Object
- alluxio.master.AbstractLocalAlluxioCluster

Direct Known Subclasses:

LocalAlluxioCluster, MultiMasterLocalAlluxioCluster
```
@NotThreadSafe
public abstract class AbstractLocalAlluxioCluster
extends Object
```
Local Alluxio cluster.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`mHostname`
`protected ProxyProcess`	`mProxyProcess`
`protected Thread`	`mProxyThread`
`protected UnderFileSystemCluster`	`mUfsCluster`
`protected String`	`mWorkDirectory`
`protected List<WorkerProcess>`	`mWorkers`
`protected List<Thread>`	`mWorkerThreads`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract FileSystem`	`getClient()` Returns a `FileSystem` client.
`protected abstract LocalAlluxioMaster`	`getLocalAlluxioMaster()`
`ProxyProcess`	`getProxyProcess()` Gets the proxy process.
`void`	`initConfiguration()` Creates a default `Configuration` for testing.
`protected void`	`reset()` Resets the cluster to original state.
`protected void`	`resetClientPools()` Resets the client pools to the original state.
`protected void`	`setAlluxioWorkDirectory()` Sets Alluxio work directory.
`protected void`	`setHostname()` Sets hostname.
`protected void`	`setupTest()` Sets up corresponding directories for tests.
`void`	`start()` Starts both master and a worker using the configurations in test conf respectively.
`protected abstract void`	`startMasters()` Configures and starts the master(s).
`void`	`startWorkers()` Configures and starts the worker(s).
`void`	`stop()` Stops both the alluxio and underfs service threads.
`void`	`stopFS()` Stops the alluxio filesystem's service thread only.
`protected abstract void`	`stopMasters()` Stops the masters.
`protected void`	`stopProxy()` Stops the proxy.
`protected void`	`stopUFS()` Cleans up the underfs cluster test folder only.
`void`	`stopWorkers()` Stops the workers.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mProxyProcess
```
protected ProxyProcess mProxyProcess
```

mProxyThread
```
protected Thread mProxyThread
```

mWorkers
```
protected List<WorkerProcess> mWorkers
```

mWorkerThreads
```
protected List<Thread> mWorkerThreads
```

mUfsCluster

protected UnderFileSystemCluster mUfsCluster

mWorkDirectory
```
protected String mWorkDirectory
```

mHostname
```
protected String mHostname
```

Method Detail
- start
```
public void start()
           throws Exception
```
  Starts both master and a worker using the configurations in test conf respectively.
  
  Throws:
  
  Exception
- startMasters
```
protected abstract void startMasters()
                              throws Exception
```
  Configures and starts the master(s).
  
  Throws:
  
  Exception
- startWorkers
```
public void startWorkers()
                  throws Exception
```
  Configures and starts the worker(s).
  
  Throws:
  
  Exception
- setupTest
```
protected void setupTest()
                  throws IOException
```
  Sets up corresponding directories for tests.
  
  Throws:
  
  IOException
- stop
```
public void stop()
          throws Exception
```
  Stops both the alluxio and underfs service threads.
  
  Throws:
  
  Exception
- stopFS
```
public void stopFS()
            throws Exception
```
  Stops the alluxio filesystem's service thread only.
  
  Throws:
  
  Exception
- stopUFS
```
protected void stopUFS()
                throws Exception
```
  Cleans up the underfs cluster test folder only.
  
  Throws:
  
  Exception
- stopMasters
```
protected abstract void stopMasters()
                             throws Exception
```
  Stops the masters.
  
  Throws:
  
  Exception
- stopProxy
```
protected void stopProxy()
                  throws Exception
```
  Stops the proxy.
  
  Throws:
  
  Exception
- stopWorkers
```
public void stopWorkers()
                 throws Exception
```
  Stops the workers.
  
  Throws:
  
  Exception
- initConfiguration
```
public void initConfiguration()
                       throws IOException
```
  Creates a default Configuration for testing.
  
  Throws:
  
  IOException
- getClient
```
public abstract FileSystem getClient()
                              throws IOException
```
  Returns a FileSystem client.
  
  Returns:
  a FileSystem client
  
  Throws:
  
  IOException
- getLocalAlluxioMaster
```
protected abstract LocalAlluxioMaster getLocalAlluxioMaster()
```
  Returns:
  the local Alluxio master
- getProxyProcess
```
public ProxyProcess getProxyProcess()
```
  Gets the proxy process.
  
  Returns:
  the proxy
- reset
```
protected void reset()
```
  Resets the cluster to original state.
- resetClientPools
```
protected void resetClientPools()
                         throws IOException
```
  Resets the client pools to the original state.
  
  Throws:
  
  IOException
- setHostname
```
protected void setHostname()
```
  Sets hostname.
- setAlluxioWorkDirectory
```
protected void setAlluxioWorkDirectory()
```
  Sets Alluxio work directory.

Class AbstractLocalAlluxioCluster

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mProxyProcess

mProxyThread

mWorkers

mWorkerThreads

mUfsCluster

mWorkDirectory

mHostname

Method Detail

start

startMasters

startWorkers

setupTest

stop

stopFS

stopUFS

stopMasters

stopProxy

stopWorkers

initConfiguration

getClient

getLocalAlluxioMaster

getProxyProcess

reset

resetClientPools

setHostname

setAlluxioWorkDirectory