AbstractLocalAlluxioCluster (Alluxio Parent 2.9.4-SNAPSHOT API)

java.lang.Object
- alluxio.master.AbstractLocalAlluxioCluster

Direct Known Subclasses:

LocalAlluxioCluster, MultiMasterEmbeddedJournalLocalAlluxioCluster, 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 String`	`mWorkDirectory`
`protected List<WorkerProcess>`	`mWorkers`
`protected List<Thread>`	`mWorkerThreads`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`formatAndRestartMasters()` Stops the masters, formats them, and then restarts them.
`protected void`	`formatJournal()`
`abstract FileSystem`	`getClient()` Returns a `FileSystem` client.
`abstract FileSystem`	`getClient(FileSystemContext context)`
`protected abstract LocalAlluxioMaster`	`getLocalAlluxioMaster()`
`ProxyProcess`	`getProxyProcess()` Gets the proxy process.
`abstract void`	`initConfiguration(String name)` Creates a default `Configuration` for testing.
`boolean`	`isStartedWorkers()`
`void`	`killWorkerProcesses()` Kills all worker processes without forgetting them in the master, so we can validate the master mechanism handling dead workers.
`protected void`	`reset()` Resets the cluster to original state.
`protected void`	`resetClientPools()` Resets the client pools to the original state.
`void`	`restartMasters()` Restarts the master(s).
`void`	`restartWorkers(Collection<WorkerNetAddress> addresses)` Restarts workers with the addresses provided, so that the workers can restart with static addresses to simulate a worker restart in the cluster.
`protected void`	`setAlluxioWorkDirectory(String name)` 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).
`protected void`	`startProxy()` Configures and starts the proxy.
`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.
`void`	`stopWorkers()` Stops the workers.
`protected void`	`waitForMasterServing()`
`void`	`waitForWorkersRegistered(int timeoutMs)` Waits for all workers registered with master.

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
```

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
- waitForMasterServing
```
protected void waitForMasterServing()
                             throws TimeoutException,
                                    InterruptedException
```
  Throws:
  
  TimeoutException
  
  InterruptedException
- restartMasters
```
public void restartMasters()
                    throws Exception
```
  Restarts the master(s).
  
  Throws:
  
  Exception
- startProxy
```
protected void startProxy()
                   throws Exception
```
  Configures and starts the proxy.
  
  Throws:
  
  Exception
- startWorkers
```
public void startWorkers()
                  throws Exception
```
  Configures and starts the worker(s).
  
  Throws:
  
  Exception
- restartWorkers
```
public void restartWorkers(Collection<WorkerNetAddress> addresses)
                    throws Exception
```
  Restarts workers with the addresses provided, so that the workers can restart with static addresses to simulate a worker restart in the cluster.
  
  Parameters:
  
  addresses - worker addresses to use
  
  Throws:
  
  Exception
- setupTest
```
protected void setupTest()
                  throws IOException
```
  Sets up corresponding directories for tests.
  
  Throws:
  
  IOException
- formatJournal
```
protected void formatJournal()
                      throws IOException
```
  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
- formatAndRestartMasters
```
public void formatAndRestartMasters()
                             throws Exception
```
  Stops the masters, formats them, and then restarts them. This is useful if a fresh state is desired, for example when restoring from a backup.
  
  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
- killWorkerProcesses
```
public void killWorkerProcesses()
                         throws Exception
```
  Kills all worker processes without forgetting them in the master, so we can validate the master mechanism handling dead workers.
  
  Throws:
  
  Exception
- isStartedWorkers
```
public boolean isStartedWorkers()
```
  Returns:
  
  true if the workers are started, and not stopped
- initConfiguration
```
public abstract void initConfiguration(String name)
                                throws IOException
```
  Creates a default Configuration for testing.
  
  Parameters:
  
  name - the name of the test/cluster
  
  Throws:
  
  IOException
- getClient
```
public abstract FileSystem getClient()
                              throws IOException
```
  Returns a FileSystem client.
  
  Returns:
  
  a FileSystem client
  
  Throws:
  
  IOException
- getClient
```
public abstract FileSystem getClient(FileSystemContext context)
                              throws IOException
```
  Parameters:
  
  context - the FileSystemContext to use
  
  Returns:
  
  a FileSystem client, using a specific context
  
  Throws:
  
  IOException
- getLocalAlluxioMaster
```
protected abstract LocalAlluxioMaster getLocalAlluxioMaster()
```
  Returns:
  
  the local Alluxio master
- getProxyProcess
```
public ProxyProcess getProxyProcess()
```
  Gets the proxy process.
  
  Returns:
  
  the proxy
- waitForWorkersRegistered
```
public void waitForWorkersRegistered(int timeoutMs)
                              throws TimeoutException,
                                     InterruptedException,
                                     IOException
```
  Waits for all workers registered with master.
  
  Parameters:
  
  timeoutMs - the timeout to wait
  
  Throws:
  
  TimeoutException
  
  InterruptedException
  
  IOException
- reset
```
protected void reset()
```
  Resets the cluster to original state.
- resetClientPools
```
protected void resetClientPools()
```
  Resets the client pools to the original state.
- setHostname
```
protected void setHostname()
```
  Sets hostname.
- setAlluxioWorkDirectory
```
protected void setAlluxioWorkDirectory(String name)
```
  Sets Alluxio work directory.
  
  Parameters:
  
  name - the name of the test/cluster

Class AbstractLocalAlluxioCluster

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mProxyProcess

mProxyThread

mWorkers

mWorkerThreads

mWorkDirectory

mHostname

Method Detail

start

startMasters

waitForMasterServing

restartMasters

startProxy

startWorkers

restartWorkers

setupTest

formatJournal

stop

stopFS

formatAndRestartMasters

stopMasters

stopProxy

stopWorkers

killWorkerProcesses

isStartedWorkers

initConfiguration

getClient

getClient

getLocalAlluxioMaster

getProxyProcess

waitForWorkersRegistered

reset

resetClientPools

setHostname

setAlluxioWorkDirectory