alluxio.underfs

Class MasterUfsManager

java.lang.Object

alluxio.underfs.AbstractUfsManager

alluxio.underfs.MasterUfsManager

All Implemented Interfaces:

Checkpointed, DelegatingJournaled, Journaled, JournalEntryIterable, UfsManager, Closeable, AutoCloseable

@ThreadSafe
public final class MasterUfsManager
extends AbstractUfsManager
implements DelegatingJournaled

A class that manages the UFS for master servers.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.underfs.AbstractUfsManager

AbstractUfsManager.Key

Nested classes/interfaces inherited from interface alluxio.underfs.UfsManager

UfsManager.UfsClient

Field Summary

Fields inherited from class alluxio.underfs.AbstractUfsManager

mCloser, mUnderFileSystemMap

Constructor Summary

Constructors

Constructor and Description
MasterUfsManager()

Method Summary

Modifier and Type	Method and Description
void	addMount(long mountId, AlluxioURI ufsUri, UnderFileSystemConfiguration ufsConf) Keeps track of a mount id and maps it to its URI in Alluxio and configuration.
void	addMountWithRecorder(long mountId, AlluxioURI ufsUri, UnderFileSystemConfiguration ufsConf, Recorder recorder) Keeps track of a mount id and maps it to its URI in Alluxio and configuration and records the execution process.
protected void	connectUfs(UnderFileSystem fs) Takes any necessary actions required to establish a connection to the under file system.
Journaled	getDelegate()
CloseableIterator<Journal.JournalEntry>	getJournalEntryIterator()
Map<String,UfsMode>	getPhysicalUfsState(List<String> physicalStores) Get the physical ufs operation modes for the UnderFileSystem under the given Mount table resolution.
boolean	hasMount(long mountId) Checks if a mountId exists.
void	removeMount(long mountId) Removes the association from a mount id to a UFS instance.
void	setUfsMode(java.util.function.Supplier<JournalContext> journalContext, AlluxioURI ufsPath, UfsMode ufsMode) Set the operation mode the given physical ufs.

Methods inherited from class alluxio.underfs.AbstractUfsManager

close, get, getJournal, getRoot

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.master.journal.DelegatingJournaled

applyAndJournal, getCheckpointName, processJournalEntry, resetState, restoreFromCheckpoint, writeToCheckpoint

Constructor Detail

MasterUfsManager

public MasterUfsManager()

Method Detail

connectUfs

protected void connectUfs(UnderFileSystem fs)
                   throws IOException

Description copied from class: AbstractUfsManager

Takes any necessary actions required to establish a connection to the under file system. The implementation will either call UnderFileSystem.connectFromMaster(String) or UnderFileSystem.connectFromWorker(String) depending on the running process.

Specified by:

connectUfs in class AbstractUfsManager

Throws:

IOException

addMount

public void addMount(long mountId,
                     AlluxioURI ufsUri,
                     UnderFileSystemConfiguration ufsConf)

Description copied from interface: UfsManager

Keeps track of a mount id and maps it to its URI in Alluxio and configuration. This is an Alluxio-only operation and no interaction to UFS will be made.

Specified by:

addMount in interface UfsManager

Overrides:

addMount in class AbstractUfsManager

Parameters:

mountId - the mount id

ufsUri - the UFS path

ufsConf - the UFS configuration

addMountWithRecorder

public void addMountWithRecorder(long mountId,
                                 AlluxioURI ufsUri,
                                 UnderFileSystemConfiguration ufsConf,
                                 Recorder recorder)

Description copied from interface: UfsManager

Keeps track of a mount id and maps it to its URI in Alluxio and configuration and records the execution process. This is an Alluxio-only operation and no interaction to UFS will be made.

Specified by:

addMountWithRecorder in interface UfsManager

Overrides:

addMountWithRecorder in class AbstractUfsManager

Parameters:

mountId - the mount id

ufsUri - the UFS path

ufsConf - the UFS configuration

recorder - recorder used to record the detailed execution process

removeMount

public void removeMount(long mountId)

Description copied from interface: UfsManager

Removes the association from a mount id to a UFS instance. If the mount id is not known, this is a noop.

Specified by:

removeMount in interface UfsManager

Overrides:

removeMount in class AbstractUfsManager

Parameters:

mountId - the mount id

hasMount

public boolean hasMount(long mountId)

Description copied from interface: UfsManager

Checks if a mountId exists.

Specified by:

hasMount in interface UfsManager

Overrides:

hasMount in class AbstractUfsManager

Parameters:

mountId - the mountId to check

Returns:

whether the mountId has been occupied

getPhysicalUfsState

public Map<String,UfsMode> getPhysicalUfsState(List<String> physicalStores)

Get the physical ufs operation modes for the UnderFileSystem under the given Mount table resolution.

Parameters:

physicalStores - the physical stores for the mount resolution

Returns:

the state of physical UFS for given mount resolution

setUfsMode

public void setUfsMode(java.util.function.Supplier<JournalContext> journalContext,
                       AlluxioURI ufsPath,
                       UfsMode ufsMode)
                throws InvalidPathException

Set the operation mode the given physical ufs.

Parameters:

journalContext - the journal context

ufsPath - the physical ufs path (scheme and authority only)

ufsMode - the ufs operation mode

Throws:

InvalidPathException - if no managed ufs covers the given path

getDelegate

public Journaled getDelegate()

Specified by:

getDelegate in interface DelegatingJournaled

Returns:

the object to delegate to

getJournalEntryIterator

public CloseableIterator<Journal.JournalEntry> getJournalEntryIterator()

Specified by:

getJournalEntryIterator in interface DelegatingJournaled

Specified by:

getJournalEntryIterator in interface JournalEntryIterable

Returns:

an CloseableIterator that iterates all the journal entries