alluxio.master.meta

Class DefaultMetaMaster

java.lang.Object

alluxio.master.AbstractMaster

alluxio.master.CoreMaster

alluxio.master.meta.DefaultMetaMaster

All Implemented Interfaces:

BackupOps, Checkpointed, Journaled, JournalEntryIterable, Master, MetaMaster, Server<Boolean>

@NotThreadSafe
public final class DefaultMetaMaster
extends CoreMaster
implements MetaMaster

The default meta master.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultMetaMaster.State Journaled state for MetaMaster.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_CLUSTER_ID Value to be used for the cluster ID when not assigned.

Fields inherited from class alluxio.master.CoreMaster

mBackupManager, mJournalSystem, mPort, mPrimarySelector, mSafeModeManager, mStartTimeMs

Fields inherited from class alluxio.master.AbstractMaster

mJournal, mMasterContext

Method Summary

Modifier and Type	Method and Description
BackupStatus	backup(BackupPRequest request, StateLockOptions stateLockOptions) Takes a backup.
String	checkpoint() Creates a checkpoint in the primary master journal system.
BackupStatus	getBackupStatus(BackupStatusPRequest statusPRequest) Used to query the status of a backup.
CheckpointName	getCheckpointName()
String	getClusterID()
ConfigCheckReport	getConfigCheckReport()
ConfigHash	getConfigHash()
Configuration	getConfiguration(GetConfigurationPOptions options)
Set<Class<? extends Server>>	getDependencies()
CloseableIterator<Journal.JournalEntry>	getJournalEntryIterator()
Optional<JournalSpaceMonitor>	getJournalSpaceMonitor()
MasterInfo[]	getLostMasterInfos()
Address	getMasterAddress()
List<Address>	getMasterAddresses()
long	getMasterId(Address address) Returns a master id for the given master, creating one if the master is new.
String	getName()
boolean	getNewerVersionAvailable()
InetSocketAddress	getRpcAddress()
Map<ServiceType,GrpcService>	getServices()
MasterInfo[]	getStandbyMasterInfos()
Map<ServiceType,GrpcService>	getStandbyServices()
long	getStartTimeMs()
long	getUptimeMs()
int	getWebPort()
List<Address>	getWorkerAddresses()
boolean	isInSafeMode()
List<ProxyStatus>	listProxyStatus() Lists information of all known Proxy instances.
MetaCommand	masterHeartbeat(long masterId, MasterHeartbeatPOptions options) A standby master periodically heartbeats with the leader master.
void	masterRegister(long masterId, RegisterMasterPOptions options) A standby master registers with the leader master.
boolean	processJournalEntry(Journal.JournalEntry entry) Attempts to apply a journal entry.
void	proxyHeartbeat(ProxyHeartbeatPRequest request) A Proxy periodically heartbeats with the primary master.
void	removePathConfiguration(String path) Removes all properties for a path.
void	removePathConfiguration(String path, Set<String> keys) Removes properties for a path.
void	resetState() Resets the object's journaled state.
void	setNewerVersionAvailable(boolean available) Sets whether newer version Alluxio is available.
void	setPathConfiguration(String path, Map<PropertyKey,String> properties) Sets properties for a path.
void	start(Boolean isPrimary) Starts the Alluxio server.
void	stop() Stops the Alluxio server.
BackupStatus	takeEmergencyBackup() Overrides current backup role and forces the master to take a local backup.
Map<String,Boolean>	updateConfiguration(Map<String,String> propertiesMap)

Methods inherited from class alluxio.master.AbstractMaster

close, createJournalContext, getExecutorService, getMasterContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.master.Master

createJournalContext, getMasterContext

Methods inherited from interface alluxio.master.journal.Journaled

applyAndJournal, restoreFromCheckpoint, writeToCheckpoint

Methods inherited from interface alluxio.master.journal.checkpoint.Checkpointed

restoreFromCheckpoint, writeToCheckpoint

Methods inherited from interface alluxio.Server

close

Field Detail

INVALID_CLUSTER_ID

public static final String INVALID_CLUSTER_ID

Value to be used for the cluster ID when not assigned.

See Also:

Constant Field Values

Method Detail

getServices

public Map<ServiceType,GrpcService> getServices()

Specified by:

getServices in interface Server<Boolean>

Returns:

a map from service names to gRPC serviced that serve RPCs for this server

getStandbyServices

public Map<ServiceType,GrpcService> getStandbyServices()

Specified by:

getStandbyServices in interface Master

Returns:

a map from service names to gRPC services that serve RPCs for this master, if the master is a standby master.

getName

public String getName()

Specified by:

getName in interface Server<Boolean>

Returns:

the server's name

getDependencies

public Set<Class<? extends Server>> getDependencies()

Specified by:

getDependencies in interface Server<Boolean>

Overrides:

getDependencies in class AbstractMaster

Returns:

the server dependencies

start

public void start(Boolean isPrimary)
           throws IOException

Description copied from interface: Server

Starts the Alluxio server.

Specified by:

start in interface Server<Boolean>

Overrides:

start in class AbstractMaster

Parameters:

isPrimary - the start options

Throws:

IOException

stop

public void stop()
          throws IOException

Description copied from interface: Server

Stops the Alluxio server. Here, anything created or started in #start(T) should be cleaned up and shutdown.

Specified by:

stop in interface Server<Boolean>

Overrides:

stop in class AbstractMaster

Throws:

IOException

takeEmergencyBackup

public BackupStatus takeEmergencyBackup()
                                 throws AlluxioException

Overrides current backup role and forces the master to take a local backup.

Returns:

the BackupStatus

Throws:

AlluxioException - if it encounters issues triggering the backup

backup

public BackupStatus backup(BackupPRequest request,
                           StateLockOptions stateLockOptions)
                    throws AlluxioException

Description copied from interface: BackupOps

Takes a backup. Note: If backup request ask for async execution, it will return after initiating the backup. Status for the in-progress backup will be returned. BackupOps.getBackupStatus(alluxio.grpc.BackupStatusPRequest) should be called for querying the status of the on-going backup. Note: When leader has no standby in an HA cluster, it will reject backup. This could be allowed by passing "AllowLeader" option in the request.

Specified by:

backup in interface BackupOps

Parameters:

request - the backup request

stateLockOptions - the state lock options during the backup

Returns:

the backup status response

Throws:

AlluxioException - if backup fails

getBackupStatus

public BackupStatus getBackupStatus(BackupStatusPRequest statusPRequest)
                             throws AlluxioException

Description copied from interface: BackupOps

Used to query the status of a backup.

Specified by:

getBackupStatus in interface BackupOps

Parameters:

statusPRequest - status request

Returns:

the status of the latest backup

Throws:

AlluxioException - if request fails

checkpoint

public String checkpoint()
                  throws IOException

Description copied from interface: MetaMaster

Creates a checkpoint in the primary master journal system.

Specified by:

checkpoint in interface MetaMaster

Returns:

the hostname of the master that did the checkpoint

Throws:

IOException

getConfigCheckReport

public ConfigCheckReport getConfigCheckReport()

Specified by:

getConfigCheckReport in interface MetaMaster

Returns:

the server-side configuration checker report

getConfiguration

public Configuration getConfiguration(GetConfigurationPOptions options)

Specified by:

getConfiguration in interface MetaMaster

Parameters:

options - method options

Returns:

configuration information list

getConfigHash

public ConfigHash getConfigHash()

Specified by:

getConfigHash in interface MetaMaster

Returns:

hashes of cluster and path level configuration

getJournalSpaceMonitor

public Optional<JournalSpaceMonitor> getJournalSpaceMonitor()

Specified by:

getJournalSpaceMonitor in interface MetaMaster

Returns:

the journal space monitor if supported by the current configuration

setPathConfiguration

public void setPathConfiguration(String path,
                                 Map<PropertyKey,String> properties)
                          throws UnavailableException

Description copied from interface: MetaMaster

Sets properties for a path.

Specified by:

setPathConfiguration in interface MetaMaster

Parameters:

path - the path

properties - the properties for path

Throws:

UnavailableException

removePathConfiguration

public void removePathConfiguration(String path,
                                    Set<String> keys)
                             throws UnavailableException

Description copied from interface: MetaMaster

Removes properties for a path.

Specified by:

removePathConfiguration in interface MetaMaster

Parameters:

path - the path

keys - the property keys

Throws:

UnavailableException

removePathConfiguration

public void removePathConfiguration(String path)
                             throws UnavailableException

Description copied from interface: MetaMaster

Removes all properties for a path.

Specified by:

removePathConfiguration in interface MetaMaster

Parameters:

path - the path

Throws:

UnavailableException

setNewerVersionAvailable

public void setNewerVersionAvailable(boolean available)

Description copied from interface: MetaMaster

Sets whether newer version Alluxio is available.

Specified by:

setNewerVersionAvailable in interface MetaMaster

Parameters:

available - new version is available

getNewerVersionAvailable

public boolean getNewerVersionAvailable()

Specified by:

getNewerVersionAvailable in interface MetaMaster

Returns:

true if newer version is available, false otherwise

getMasterAddress

public Address getMasterAddress()

Specified by:

getMasterAddress in interface MetaMaster

Returns:

the address of this master

getMasterAddresses

public List<Address> getMasterAddresses()

Specified by:

getMasterAddresses in interface MetaMaster

Returns:

the addresses of live masters

getWorkerAddresses

public List<Address> getWorkerAddresses()

Specified by:

getWorkerAddresses in interface MetaMaster

Returns:

the addresses of live workers

getStandbyMasterInfos

public MasterInfo[] getStandbyMasterInfos()

Specified by:

getStandbyMasterInfos in interface MetaMaster

Returns:

an array of MasterInfo of standby masters

getLostMasterInfos

public MasterInfo[] getLostMasterInfos()

Specified by:

getLostMasterInfos in interface MetaMaster

Returns:

an array of MasterInfo of lost masters

getMasterId

public long getMasterId(Address address)

Description copied from interface: MetaMaster

Returns a master id for the given master, creating one if the master is new.

Specified by:

getMasterId in interface MetaMaster

Parameters:

address - the master hostname

Returns:

the master id for this master

getRpcAddress

public InetSocketAddress getRpcAddress()

Specified by:

getRpcAddress in interface MetaMaster

Returns:

this master's rpc address

getStartTimeMs

public long getStartTimeMs()

Specified by:

getStartTimeMs in interface MetaMaster

Returns:

the start time of the master in milliseconds

getUptimeMs

public long getUptimeMs()

Specified by:

getUptimeMs in interface MetaMaster

Returns:

the uptime of the master in milliseconds

getWebPort

public int getWebPort()

Specified by:

getWebPort in interface MetaMaster

Returns:

the master's web port

isInSafeMode

public boolean isInSafeMode()

Specified by:

isInSafeMode in interface MetaMaster

Returns:

true if Alluxio is running in safe mode, false otherwise

masterHeartbeat

public MetaCommand masterHeartbeat(long masterId,
                                   MasterHeartbeatPOptions options)

Description copied from interface: MetaMaster

A standby master periodically heartbeats with the leader master.

Specified by:

masterHeartbeat in interface MetaMaster

Parameters:

masterId - the master id

options - the options that contains optional master info

Returns:

an optional command for the standby master to execute

masterRegister

public void masterRegister(long masterId,
                           RegisterMasterPOptions options)
                    throws NotFoundException

Description copied from interface: MetaMaster

A standby master registers with the leader master.

Specified by:

masterRegister in interface MetaMaster

Parameters:

masterId - the master id of the standby master registering

options - the options that contains master configuration

Throws:

NotFoundException - if masterId cannot be found

proxyHeartbeat

public void proxyHeartbeat(ProxyHeartbeatPRequest request)

Description copied from interface: MetaMaster

A Proxy periodically heartbeats with the primary master.

Specified by:

proxyHeartbeat in interface MetaMaster

Parameters:

request - the heartbeat message

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class

getClusterID

public String getClusterID()

Specified by:

getClusterID in interface MetaMaster

Returns:

the cluster ID

getJournalEntryIterator

public CloseableIterator<Journal.JournalEntry> getJournalEntryIterator()

Specified by:

getJournalEntryIterator in interface JournalEntryIterable

Returns:

an CloseableIterator that iterates all the journal entries

processJournalEntry

public boolean processJournalEntry(Journal.JournalEntry entry)

Description copied from interface: Journaled

Attempts to apply a journal entry.

Specified by:

processJournalEntry in interface Journaled

Parameters:

entry - the entry to apply

Returns:

whether the entry type is supported by this journaled object

resetState

public void resetState()

Description copied from interface: Journaled

Resets the object's journaled state.

Specified by:

resetState in interface Journaled

updateConfiguration

public Map<String,Boolean> updateConfiguration(Map<String,String> propertiesMap)

Specified by:

updateConfiguration in interface MetaMaster

Parameters:

propertiesMap - properties to update

Returns:

the update properties status map

listProxyStatus

public List<ProxyStatus> listProxyStatus()

Description copied from interface: MetaMaster

Lists information of all known Proxy instances.

Specified by:

listProxyStatus in interface MetaMaster

Returns:

a list of status