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 GrpcServer	mGrpcServer The RPC server.
protected Lock	mGrpcServerLock
protected JournalSystem	mJournalSystem The journal system for writing journal entries and restoring master state.
protected PrimarySelector	mLeaderSelector
protected Thread	mServingThread
protected long	mServingThreadTimeoutMs
protected WebServer	mWebServer The web ui server.
protected Lock	mWebServerLock

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 <T extends Master> T	getMaster(Class<T> clazz) Gets the registered class from the master registry.
abstract InetSocketAddress	getRpcAddress()
long	getStartTimeMs()
long	getUptimeMs()
abstract InetSocketAddress	getWebAddress()
boolean	isGrpcServing()
boolean	isMetricSinkServing()
boolean	isWebServing()
protected void	startRejectingServers()
protected void	startServing()
protected void	stopRejectingRpcServer()
protected void	stopRejectingServers()
protected void	stopRejectingWebServer()
boolean	waitForGrpcServerReady(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

mGrpcServer

@Nullable
protected GrpcServer mGrpcServer

The RPC server.

mGrpcServerLock

protected final Lock mGrpcServerLock

mWebServer

@Nullable
protected WebServer mWebServer

The web ui server.

mWebServerLock

protected final Lock mWebServerLock

mServingThreadTimeoutMs

protected final long mServingThreadTimeoutMs

mServingThread

protected Thread mServingThread

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

getRpcAddress

public abstract InetSocketAddress getRpcAddress()

Returns:

this master's rpc address

getMaster

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

Gets the registered class from the master registry.

Type Parameters:

T - the type of the master to get

Parameters:

clazz - the class of the master to get

Returns:

the given master

getStartTimeMs

public long getStartTimeMs()

Returns:

the start time of the master in milliseconds

startServing

protected void startServing()

getUptimeMs

public long getUptimeMs()

Returns:

the uptime of the master in milliseconds

getWebAddress

public abstract InetSocketAddress getWebAddress()

Returns:

the master's web address

isGrpcServing

public boolean isGrpcServing()

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

waitForGrpcServerReady

public boolean waitForGrpcServerReady(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

startRejectingServers

protected void startRejectingServers()

stopRejectingRpcServer

protected void stopRejectingRpcServer()

stopRejectingWebServer

protected void stopRejectingWebServer()

stopRejectingServers

protected void stopRejectingServers()