AbstractLocalAlluxioCluster (Alluxio MiniCluster 311 API)

java.lang.Object
- alluxio.master.AbstractLocalAlluxioCluster

Direct Known Subclasses:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`mHostname`
`protected int`	`mNumWorkers`
`protected ProxyProcess`	`mProxyProcess`
`protected java.lang.Thread`	`mProxyThread`
`protected java.lang.String`	`mWorkDirectory`
`protected java.util.List<WorkerProcess>`	`mWorkers`
`protected java.util.List<java.lang.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(java.lang.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(java.util.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(java.lang.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.
`protected void`	`waitForWorkersServing()`

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 java.lang.Thread mProxyThread

mWorkers

protected java.util.List<WorkerProcess> mWorkers

mWorkerThreads

protected java.util.List<java.lang.Thread> mWorkerThreads

mWorkDirectory

protected java.lang.String mWorkDirectory

mHostname
```
protected java.lang.String mHostname
```

mNumWorkers
```
protected int mNumWorkers
```

Method Detail
- start
```
public void start()
           throws java.lang.Exception
```
  Starts both master and a worker using the configurations in test conf respectively.
  
  Throws:
  
  java.lang.Exception
- startMasters
```
protected abstract void startMasters()
                              throws java.lang.Exception
```
  Configures and starts the master(s).
  
  Throws:
  
  java.lang.Exception
- waitForWorkersServing
```
protected void waitForWorkersServing()
                              throws java.util.concurrent.TimeoutException,
                                     java.lang.InterruptedException
```
  Throws:
  
  java.util.concurrent.TimeoutException
  
  java.lang.InterruptedException
- waitForMasterServing
```
protected void waitForMasterServing()
                             throws java.util.concurrent.TimeoutException,
                                    java.lang.InterruptedException
```
  Throws:
  
  java.util.concurrent.TimeoutException
  
  java.lang.InterruptedException
- restartMasters
```
public void restartMasters()
                    throws java.lang.Exception
```
  Restarts the master(s).
  
  Throws:
  
  java.lang.Exception
- startProxy
```
protected void startProxy()
                   throws java.lang.Exception
```
  Configures and starts the proxy.
  
  Throws:
  
  java.lang.Exception
- startWorkers
```
public void startWorkers()
                  throws java.lang.Exception
```
  Configures and starts the worker(s).
  
  Throws:
  
  java.lang.Exception
- restartWorkers
```
public void restartWorkers(java.util.Collection<WorkerNetAddress> addresses)
                    throws java.lang.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:
  
  java.lang.Exception
- setupTest
```
protected void setupTest()
                  throws java.io.IOException
```
  Sets up corresponding directories for tests.
  
  Throws:
  
  java.io.IOException
- formatJournal
```
protected void formatJournal()
                      throws java.io.IOException
```
  Throws:
  
  java.io.IOException
- stop
```
public void stop()
          throws java.lang.Exception
```
  Stops both the alluxio and underfs service threads.
  
  Throws:
  
  java.lang.Exception
- stopFS
```
public void stopFS()
            throws java.lang.Exception
```
  Stops the alluxio filesystem's service thread only.
  
  Throws:
  
  java.lang.Exception
- formatAndRestartMasters
```
public void formatAndRestartMasters()
                             throws java.lang.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:
  
  java.lang.Exception
- stopMasters
```
protected abstract void stopMasters()
                             throws java.lang.Exception
```
  Stops the masters.
  
  Throws:
  
  java.lang.Exception
- stopProxy
```
protected void stopProxy()
                  throws java.lang.Exception
```
  Stops the proxy.
  
  Throws:
  
  java.lang.Exception
- stopWorkers
```
public void stopWorkers()
                 throws java.lang.Exception
```
  Stops the workers.
  
  Throws:
  
  java.lang.Exception
- killWorkerProcesses
```
public void killWorkerProcesses()
                         throws java.lang.Exception
```
  Kills all worker processes without forgetting them in the master, so we can validate the master mechanism handling dead workers.
  
  Throws:
  
  java.lang.Exception
- isStartedWorkers
```
public boolean isStartedWorkers()
```
  Returns:
  
  true if the workers are started, and not stopped
- initConfiguration
```
public abstract void initConfiguration(java.lang.String name)
                                throws java.io.IOException
```
  Creates a default Configuration for testing.
  
  Parameters:
  
  name - the name of the test/cluster
  
  Throws:
  
  java.io.IOException
- getClient
```
public abstract FileSystem getClient()
                              throws java.io.IOException
```
  Returns a FileSystem client.
  
  Returns:
  
  a FileSystem client
  
  Throws:
  
  java.io.IOException
- getClient
```
public abstract FileSystem getClient(FileSystemContext context)
                              throws java.io.IOException
```
  Parameters:
  
  context - the FileSystemContext to use
  
  Returns:
  
  a FileSystem client, using a specific context
  
  Throws:
  
  java.io.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 java.util.concurrent.TimeoutException,
                                     java.lang.InterruptedException,
                                     java.io.IOException
```
  Waits for all workers registered with master.
  
  Parameters:
  
  timeoutMs - the timeout to wait
  
  Throws:
  
  java.util.concurrent.TimeoutException
  
  java.lang.InterruptedException
  
  java.io.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(java.lang.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

mNumWorkers

Method Detail

start

startMasters

waitForWorkersServing

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