alluxio.master

Class MasterProcess

java.lang.Object

alluxio.master.MasterProcess

All Implemented Interfaces:

Process

Direct Known Subclasses:

AlluxioMasterProcess, AlluxioSimpleMasterProcess

public abstract class MasterProcess
extends Object
implements Process

Defines a set of methods which any MasterProcess should implement. This class serves as a common implementation for functions that both the AlluxioMasterProcess and AlluxioJobMasterProcess use. Each master should have an RPC server, web server, and journaling system which can serve client requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected JournalSystem	mJournalSystem The journal system for writing journal entries and restoring master state.
protected PrimarySelector	mLeaderSelector
protected MasterRegistry	mRegistry The master registry.

Constructor Summary

Constructors

Constructor and Description
MasterProcess(JournalSystem journalSystem, PrimarySelector leaderSelector, NetworkAddressUtils.ServiceType webService, NetworkAddressUtils.ServiceType rpcService) Prepares a MasterProcess journal, rpc and web server using the given sockets.

Method Summary

Modifier and Type	Method and Description
abstract GrpcServerBuilder	createBaseRpcServer()
Optional<AlluxioExecutorService>	createRpcExecutorService() This method is decoupled from createBaseRpcServer() because the AlluxioExecutorService needs to be managed (i.e.
abstract WebServer	createWebServer()
<T extends Master> T	getMaster(Class<T> clazz)
PrimarySelector	getPrimarySelector()
MasterRegistry	getRegistry() Use only to instantiate SimpleServices.
InetSocketAddress	getRpcAddress()
InetSocketAddress	getRpcBindAddress()
Optional<SafeModeManager>	getSafeModeManager()
long	getStartTimeMs()
long	getUptimeMs()
InetSocketAddress	getWebAddress()
InetSocketAddress	getWebBindAddress()
boolean	isGrpcServingAsLeader()
boolean	isMetricSinkServing()
boolean	isWebServing()
void	registerService(SimpleService service) Used in master factory after instantiating the master process and before starting the master process.
boolean	waitForLeaderGrpcServerReady(int timeoutMs) Waits until the grpc server is ready to serve requests.
boolean	waitForMetricSinkServing(int timeoutMs) Wait until the metrics sinks have been started.
boolean	waitForReady(int timeoutMs) Waits until the process is ready to serve requests.
boolean	waitForWebServerReady(int timeoutMs) Waits until the web server is ready to serve requests.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.Process

start, stop

Field Detail

mJournalSystem

protected final JournalSystem mJournalSystem

The journal system for writing journal entries and restoring master state.

mLeaderSelector

protected final PrimarySelector mLeaderSelector

mRegistry

protected final MasterRegistry mRegistry

The master registry.

Constructor Detail

MasterProcess

public MasterProcess(JournalSystem journalSystem,
                     PrimarySelector leaderSelector,
                     NetworkAddressUtils.ServiceType webService,
                     NetworkAddressUtils.ServiceType rpcService)

Prepares a MasterProcess journal, rpc and web server using the given sockets.

Parameters:

journalSystem - the journaling system

leaderSelector - the leader selector

webService - the web service type

rpcService - the rpc service type

Method Detail

registerService

public void registerService(SimpleService service)

Used in master factory after instantiating the master process and before starting the master process. This allows you to define with services are necessary for the operation of the master process.

Parameters:

service - a service to register for the functioning of the master process

createBaseRpcServer

public abstract GrpcServerBuilder createBaseRpcServer()

Returns:

a fully configured rpc server except for the executor option (provided by the createRpcExecutorService()) and the rpc services (provided by mRegistry

createRpcExecutorService

public Optional<AlluxioExecutorService> createRpcExecutorService()

This method is decoupled from createBaseRpcServer() because the AlluxioExecutorService needs to be managed (i.e. started and stopped) independently of the rpc server that uses it

Returns:

a custom executor service to be used in the rpc server

getSafeModeManager

public Optional<SafeModeManager> getSafeModeManager()

Returns:

the SafeModeManager if you have one

getRpcBindAddress

public final InetSocketAddress getRpcBindAddress()

Returns:

this master's rpc bind address

getRpcAddress

public final InetSocketAddress getRpcAddress()

Returns:

this master's rpc connect address

getMaster

public final <T extends Master> T getMaster(Class<T> clazz)

Type Parameters:

T - parameterized class of the desired master

Parameters:

clazz - the class of the master to retrieve

Returns:

the desired master from the registry if it exists

getRegistry

public final MasterRegistry getRegistry()

Use only to instantiate SimpleServices.

Returns:

the master registry

getStartTimeMs

public long getStartTimeMs()

Returns:

the start time of the master in milliseconds

getUptimeMs

public long getUptimeMs()

Returns:

the uptime of the master in milliseconds

createWebServer

public abstract WebServer createWebServer()

Returns:

a newly created web server for this master

getWebBindAddress

public final InetSocketAddress getWebBindAddress()

Returns:

the master's web bind address

getWebAddress

public final InetSocketAddress getWebAddress()

Returns:

the master's web connect address

isGrpcServingAsLeader

public boolean isGrpcServingAsLeader()

Returns:

true if the system is the leader (serving the rpc server), false otherwise

isWebServing

public boolean isWebServing()

Returns:

true if the system is serving the web server, false otherwise

isMetricSinkServing

public boolean isMetricSinkServing()

Returns:

true if the system is serving the metric sink, false otherwise

waitForLeaderGrpcServerReady

public boolean waitForLeaderGrpcServerReady(int timeoutMs)

Waits until the grpc server is ready to serve requests.

Parameters:

timeoutMs - how long to wait in milliseconds

Returns:

whether the grpc server became ready before the specified timeout

waitForWebServerReady

public boolean waitForWebServerReady(int timeoutMs)

Waits until the web server is ready to serve requests.

Parameters:

timeoutMs - how long to wait in milliseconds

Returns:

whether the web server became ready before the specified timeout

waitForMetricSinkServing

public boolean waitForMetricSinkServing(int timeoutMs)

Wait until the metrics sinks have been started.

Parameters:

timeoutMs - how long to wait in milliseconds

Returns:

whether the metrics sinks have begun serving before the specified timeout

waitForReady

public boolean waitForReady(int timeoutMs)

Description copied from interface: Process

Waits until the process is ready to serve requests.

Specified by:

waitForReady in interface Process

Parameters:

timeoutMs - how long to wait in milliseconds

Returns:

whether the process became ready before the specified timeout

getPrimarySelector

public PrimarySelector getPrimarySelector()

Returns:

the primary selector