alluxio.underfs

Class UnderFileSystemConfiguration

java.lang.Object

alluxio.underfs.UnderFileSystemConfiguration

public final class UnderFileSystemConfiguration
extends Object

A class that gets the value of the given key in the given UFS configuration or the global configuration (in case the key is not found in the UFS configuration), throw RuntimeException if the key is not found in both configurations..

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(PropertyKey key)
static UnderFileSystemConfiguration	defaults()
Map<String,String>	getUserSpecifiedConf()
String	getValue(PropertyKey key) Gets the value of the given key in the given UFS configuration or the global configuration (in case the key is not found in the UFS configuration), throw RuntimeException if the key is not found in both configurations.
boolean	isReadOnly()
boolean	isShared()
UnderFileSystemConfiguration	setReadOnly(boolean readOnly)
UnderFileSystemConfiguration	setShared(boolean shared)
UnderFileSystemConfiguration	setUserSpecifiedConf(Map<String,String> ufsConf)
Map<String,String>	toMap()
Map<String,String>	toUserPropertyMap(ConfigurationValueOptions options)

Methods inherited from class java.lang.Object

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

Method Detail

defaults

public static UnderFileSystemConfiguration defaults()

Returns:

default UFS configuration

containsKey

public boolean containsKey(PropertyKey key)

Parameters:

key - property key

Returns:

true if the key is contained in the given UFS configuration or global configuration

getValue

public String getValue(PropertyKey key)

Gets the value of the given key in the given UFS configuration or the global configuration (in case the key is not found in the UFS configuration), throw RuntimeException if the key is not found in both configurations.

Parameters:

key - property key

Returns:

the value associated with the given key

getUserSpecifiedConf

public Map<String,String> getUserSpecifiedConf()

Returns:

the map of user-customized configuration

toMap

public Map<String,String> toMap()

Returns:

all the global and mount specific properties as an immutable map

isReadOnly

public boolean isReadOnly()

Returns:

whether only read operations are permitted to the UnderFileSystem

isShared

public boolean isShared()

Returns:

whether the mounted UFS is shared with all Alluxio users

setReadOnly

public UnderFileSystemConfiguration setReadOnly(boolean readOnly)

Parameters:

readOnly - whether only read operations are permitted

Returns:

the updated configuration object

setShared

public UnderFileSystemConfiguration setShared(boolean shared)

Parameters:

shared - whether the mounted UFS is shared with all Alluxio users

Returns:

the updated configuration object

setUserSpecifiedConf

public UnderFileSystemConfiguration setUserSpecifiedConf(Map<String,String> ufsConf)

Parameters:

ufsConf - the user-specified UFS configuration as a map

Returns:

the updated configuration object

toUserPropertyMap

public Map<String,String> toUserPropertyMap(ConfigurationValueOptions options)

Parameters:

options - options for formatting the configuration values

Returns:

a map from all user configuration property names to their values; values may potentially be null