alluxio.underfs

Class UnderFileSystemConfiguration

java.lang.Object

alluxio.conf.InstancedConfiguration

alluxio.underfs.UnderFileSystemConfiguration

All Implemented Interfaces:

AlluxioConfiguration

@NotThreadSafe
 @PublicApi
public final class UnderFileSystemConfiguration
extends InstancedConfiguration

Ufs configuration properties, including ufs specific configuration and global configuration.

The order of precedence for properties is:

1. Ufs specific properties
2. Global configuration properties

This class extends InstancedConfiguration. Variable substitution and aliases are supported.

Field Summary

Fields inherited from class alluxio.conf.InstancedConfiguration

mProperties

Method Summary

Modifier and Type	Method and Description
UnderFileSystemConfiguration	createMountSpecificConf(Map<String,String> mountConf) Creates a new instance from the current configuration and adds in new properties.
static UnderFileSystemConfiguration	defaults(AlluxioConfiguration alluxioConf)
Map<String,String>	getMountSpecificConf()
boolean	isReadOnly()
boolean	isShared()
UnderFileSystemConfiguration	setReadOnly(boolean readOnly)
UnderFileSystemConfiguration	setShared(boolean shared)
Map<String,String>	toUserPropertyMap(ConfigurationValueOptions options)

Methods inherited from class alluxio.conf.InstancedConfiguration

clusterDefaultsLoaded, copyProperties, defaults, get, get, getBoolean, getBytes, getClass, getDouble, getDuration, getEnum, getFloat, getInt, getList, getLong, getMs, getNestedProperties, getSource, hash, isSet, isSetByUser, keySet, merge, set, set, toMap, unset, userKeySet, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.conf.AlluxioConfiguration

getOrDefault, getOrDefault, toMap

Method Detail

defaults

public static UnderFileSystemConfiguration defaults(AlluxioConfiguration alluxioConf)

Parameters:

alluxioConf - Alluxio configuration

Returns:

ufs configuration from a given alluxio configuration

getMountSpecificConf

public Map<String,String> getMountSpecificConf()

Returns:

the map of resolved mount specific configuration

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

createMountSpecificConf

public UnderFileSystemConfiguration createMountSpecificConf(Map<String,String> mountConf)

Creates a new instance from the current configuration and adds in new properties.

Parameters:

mountConf - the mount specific configuration 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