MultiProcessCluster (Alluxio Parent 1.8.3-SNAPSHOT API)

java.lang.Object
- alluxio.multi.process.MultiProcessCluster

```
@ThreadSafe
public final class MultiProcessCluster
extends Object
```
Class for starting, stopping, and interacting with an Alluxio cluster where each master and worker runs in its own process. Compared to LocalAlluxioCluster, MultiProcessCluster is - Slower - Black box testing only (No access to master/worker internals) - Destructible (You can kill -9 masters/workers) - More realistic of real deployments Due to the slower speed, [@link LocalAlluxioCluster} should generally be preferred. MultiProcessCluster is primarily for tests which want to stop or restart servers. The synchronization strategy for this class is to synchronize all public methods.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MultiProcessCluster.Builder` Builder for `MultiProcessCluster`.
`static class`	`MultiProcessCluster.DeployMode` Deploy mode for the cluster.

Field Summary

Fields
Modifier and Type Field and Description

static String ALLUXIO_USE_FIXED_TEST_PORTS

static int PORTS_PER_MASTER

static int PORTS_PER_WORKER

Fields
Modifier and Type	Field and Description
`static String`	`ALLUXIO_USE_FIXED_TEST_PORTS`
`static int`	`PORTS_PER_MASTER`
`static int`	`PORTS_PER_WORKER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroys the cluster.
`void`	`formatJournal()` Formats the cluster journal.
`FileSystem`	`getFileSystemClient()`
`List<MasterNetAddress>`	`getMasterAddresses()`
`MasterInquireClient`	`getMasterInquireClient()`
`MetaMasterClient`	`getMetaMasterClient()`
`int`	`getPrimaryMasterIndex(int timeoutMs)` Gets the index of the primary master.
`static MultiProcessCluster.Builder`	`newBuilder(List<PortCoordination.ReservedPort> reservedPorts)`
`void`	`notifySuccess()` Informs the cluster that the test succeeded.
`void`	`restartZk()` Restarts the Zookeeper cluster.
`void`	`saveWorkdir()` Copies the work directory to the artifacts folder.
`void`	`start()` Starts the cluster, launching all server processes.
`void`	`startMaster(int i)` Starts the specified master.
`void`	`startMasters()` Starts all masters.
`void`	`startWorker(int i)` Starts the specified worker.
`void`	`stopMaster(int i)`
`void`	`stopMasters()` Stops all masters.
`void`	`stopWorker(int i)`
`void`	`stopZk()` Stops the Zookeeper cluster.
`void`	`updateDeployMode(MultiProcessCluster.DeployMode mode)` Updates the cluster's deploy mode.
`void`	`updateMasterConf(PropertyKey key, String value)` Updates master configuration for all masters.
`void`	`waitForAllNodesRegistered(int timeoutMs)` Waits for the number of live nodes in server configuration store reached the number of nodes in this cluster and gets meta master client.
`int`	`waitForAndKillPrimaryMaster(int timeoutMs)` Kills the primary master.

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

- Field Detail
  - ALLUXIO_USE_FIXED_TEST_PORTS
```
public static final String ALLUXIO_USE_FIXED_TEST_PORTS
```
    See Also:
    
    Constant Field Values
  - PORTS_PER_MASTER
```
public static final int PORTS_PER_MASTER
```
    See Also:
    
    Constant Field Values
  - PORTS_PER_WORKER
```
public static final int PORTS_PER_WORKER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - start
```
public void start()
           throws Exception
```
    Starts the cluster, launching all server processes.
    
    Throws:
    
    Exception
  - waitForAndKillPrimaryMaster
```
public int waitForAndKillPrimaryMaster(int timeoutMs)
```
    Kills the primary master. If no master is currently primary, this method blocks until a primary has been elected, then kills it.
    
    Parameters:
    
    timeoutMs - maximum amount of time to wait, in milliseconds
    
    Returns:
    
    the ID of the killed master
  - getPrimaryMasterIndex
```
public int getPrimaryMasterIndex(int timeoutMs)
```
    Gets the index of the primary master.
    
    Parameters:
    
    timeoutMs - maximum amount of time to wait, in milliseconds
    
    Returns:
    
    the index of the primary master
  - waitForAllNodesRegistered
```
public void waitForAllNodesRegistered(int timeoutMs)
```
    Waits for the number of live nodes in server configuration store reached the number of nodes in this cluster and gets meta master client.
    
    Parameters:
    
    timeoutMs - maximum amount of time to wait, in milliseconds
  - getFileSystemClient
```
public FileSystem getFileSystemClient()
```
    Returns:
    
    a client for interacting with the cluster
  - getMetaMasterClient
```
public MetaMasterClient getMetaMasterClient()
```
    Returns:
    
    a meta master client
  - notifySuccess
```
public void notifySuccess()
```
    Informs the cluster that the test succeeded. If this method is never called, the cluster will save a copy of its state during teardown.
  - saveWorkdir
```
public void saveWorkdir()
                 throws IOException
```
    Copies the work directory to the artifacts folder.
    
    Throws:
    
    IOException
  - destroy
```
public void destroy()
             throws IOException
```
    Destroys the cluster. It may not be re-started after being destroyed.
    
    Throws:
    
    IOException
  - startMasters
```
public void startMasters()
```
    Starts all masters.
  - startMaster
```
public void startMaster(int i)
                 throws IOException
```
    Starts the specified master.
    
    Parameters:
    
    i - the index of the master to start
    
    Throws:
    
    IOException
  - startWorker
```
public void startWorker(int i)
                 throws IOException
```
    Starts the specified worker.
    
    Parameters:
    
    i - the index of the worker to start
    
    Throws:
    
    IOException
  - stopMasters
```
public void stopMasters()
```
    Stops all masters.
  - stopMaster
```
public void stopMaster(int i)
                throws IOException
```
    Parameters:
    
    i - the index of the master to stop
    
    Throws:
    
    IOException
  - updateMasterConf
```
public void updateMasterConf(PropertyKey key,
                             @Nullable
                             String value)
```
    Updates master configuration for all masters. This will take effect on a master the next time the master is started.
    
    Parameters:
    
    key - the key to update
    
    value - the value to set, or null to unset the key
  - updateDeployMode
```
public void updateDeployMode(MultiProcessCluster.DeployMode mode)
```
    Updates the cluster's deploy mode.
    
    Parameters:
    
    mode - the mode to set
  - stopWorker
```
public void stopWorker(int i)
                throws IOException
```
    Parameters:
    
    i - the index of the worker to stop
    
    Throws:
    
    IOException
  - getMasterAddresses
```
public List<MasterNetAddress> getMasterAddresses()
```
    Returns:
    
    return the list of master addresses
  - stopZk
```
public void stopZk()
            throws IOException
```
    Stops the Zookeeper cluster.
    
    Throws:
    
    IOException
  - restartZk
```
public void restartZk()
               throws Exception
```
    Restarts the Zookeeper cluster.
    
    Throws:
    
    Exception
  - formatJournal
```
public void formatJournal()
                   throws IOException
```
    Formats the cluster journal.
    
    Throws:
    
    IOException
  - getMasterInquireClient
```
public MasterInquireClient getMasterInquireClient()
```
    Returns:
    
    a client for determining the serving master
  - newBuilder
```
public static MultiProcessCluster.Builder newBuilder(List<PortCoordination.ReservedPort> reservedPorts)
```
    Parameters:
    
    reservedPorts - ports reserved for usage by this cluster
    
    Returns:
    
    a new builder for an MultiProcessCluster

Class MultiProcessCluster

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALLUXIO_USE_FIXED_TEST_PORTS

PORTS_PER_MASTER

PORTS_PER_WORKER

Method Detail

start

waitForAndKillPrimaryMaster

getPrimaryMasterIndex

waitForAllNodesRegistered

getFileSystemClient

getMetaMasterClient

notifySuccess

saveWorkdir

destroy

startMasters

startMaster

startWorker

stopMasters

stopMaster

updateMasterConf

updateDeployMode

stopWorker

getMasterAddresses

stopZk

restartZk

formatJournal

getMasterInquireClient

newBuilder