alluxio.master.meta

Interface MetaMaster

All Superinterfaces:

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

All Known Implementing Classes:

DefaultMetaMaster

public interface MetaMaster
extends BackupOps, Master

The interface of meta master.

Method Summary

Modifier and Type	Method and Description
String	checkpoint() Creates a checkpoint in the primary master journal system.
String	getClusterID()
ConfigCheckReport	getConfigCheckReport()
ConfigHash	getConfigHash()
Configuration	getConfiguration(GetConfigurationPOptions options)
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.
boolean	getNewerVersionAvailable()
InetSocketAddress	getRpcAddress()
MasterInfo[]	getStandbyMasterInfos()
long	getStartTimeMs()
long	getUptimeMs()
int	getWebPort()
List<Address>	getWorkerAddresses()
boolean	isInSafeMode()
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.
void	removePathConfiguration(String path) Removes all properties for a path.
void	removePathConfiguration(String path, Set<String> keys) Removes properties for a path.
void	setNewerVersionAvailable(boolean available) Sets whether newer version Alluxio is available.
void	setPathConfiguration(String path, Map<PropertyKey,String> properties) Sets properties for a path.
Map<String,Boolean>	updateConfiguration(Map<String,String> propertiesMap)

Methods inherited from interface alluxio.master.backup.BackupOps

backup, getBackupStatus

Methods inherited from interface alluxio.master.Master

createJournalContext, getMasterContext, getStandbyServices

Methods inherited from interface alluxio.master.journal.Journaled

applyAndJournal, processJournalEntry, resetState, restoreFromCheckpoint, writeToCheckpoint

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

getCheckpointName

Methods inherited from interface alluxio.master.journal.JournalEntryIterable

getJournalEntryIterator

Methods inherited from interface alluxio.Server

close, getDependencies, getName, getServices, start, stop

Method Detail

getClusterID

String getClusterID()

Returns:

the cluster ID

getConfigCheckReport

ConfigCheckReport getConfigCheckReport()

Returns:

the server-side configuration checker report

getConfiguration

Configuration getConfiguration(GetConfigurationPOptions options)

Parameters:

options - method options

Returns:

configuration information list

getConfigHash

ConfigHash getConfigHash()

Returns:

hashes of cluster and path level configuration

getJournalSpaceMonitor

Optional<JournalSpaceMonitor> getJournalSpaceMonitor()

Returns:

the journal space monitor if supported by the current configuration

setPathConfiguration

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

Sets properties for a path.

Parameters:

path - the path

properties - the properties for path

Throws:

UnavailableException

removePathConfiguration

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

Removes properties for a path.

Parameters:

path - the path

keys - the property keys

Throws:

UnavailableException

removePathConfiguration

void removePathConfiguration(String path)
                      throws UnavailableException

Removes all properties for a path.

Parameters:

path - the path

Throws:

UnavailableException

setNewerVersionAvailable

void setNewerVersionAvailable(boolean available)

Sets whether newer version Alluxio is available.

Parameters:

available - new version is available

getNewerVersionAvailable

boolean getNewerVersionAvailable()

Returns:

true if newer version is available, false otherwise

getMasterAddress

Address getMasterAddress()

Returns:

the address of this master

getMasterAddresses

List<Address> getMasterAddresses()

Returns:

the addresses of live masters

getMasterId

long getMasterId(Address address)

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

Parameters:

address - the master hostname

Returns:

the master id for this master

getRpcAddress

InetSocketAddress getRpcAddress()

Returns:

this master's rpc address

getStartTimeMs

long getStartTimeMs()

Returns:

the start time of the master in milliseconds

getUptimeMs

long getUptimeMs()

Returns:

the uptime of the master in milliseconds

getWebPort

int getWebPort()

Returns:

the master's web port

getStandbyMasterInfos

MasterInfo[] getStandbyMasterInfos()

Returns:

an array of MasterInfo of standby masters

getLostMasterInfos

MasterInfo[] getLostMasterInfos()

Returns:

an array of MasterInfo of lost masters

getWorkerAddresses

List<Address> getWorkerAddresses()

Returns:

the addresses of live workers

isInSafeMode

boolean isInSafeMode()

Returns:

true if Alluxio is running in safe mode, false otherwise

masterHeartbeat

MetaCommand masterHeartbeat(long masterId,
                            MasterHeartbeatPOptions options)

A standby master periodically heartbeats with the leader master.

Parameters:

masterId - the master id

options - the options that contains optional master info

Returns:

an optional command for the standby master to execute

masterRegister

void masterRegister(long masterId,
                    RegisterMasterPOptions options)
             throws NotFoundException

A standby master registers with the leader master.

Parameters:

masterId - the master id of the standby master registering

options - the options that contains master configuration

Throws:

NotFoundException - if masterId cannot be found

checkpoint

String checkpoint()
           throws IOException

Creates a checkpoint in the primary master journal system.

Returns:

the hostname of the master that did the checkpoint

Throws:

IOException

updateConfiguration

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

Parameters:

propertiesMap - properties to update

Returns:

the update properties status map