alluxio.util

Class ConfigurationUtils

java.lang.Object

alluxio.util.ConfigurationUtils

public final class ConfigurationUtils
extends Object

Utilities for working with Alluxio configurations.

Method Summary

Modifier and Type	Method and Description
static float	checkRatio(AlluxioConfiguration conf, PropertyKey key) Checks that the given property key is a ratio from 0.0 and 1.0, throwing an exception if it is not.
static List<InetSocketAddress>	getEmbeddedJournalAddresses(AlluxioConfiguration conf, NetworkAddressUtils.ServiceType serviceType) Gets the embedded journal addresses to use for the given service type (either master-raft or job-master-raft).
static List<InetSocketAddress>	getJobMasterEmbeddedJournalAddresses(AlluxioConfiguration conf)
static String	getJobMasterHostNotConfiguredMessage(String serviceName) Returns a unified message for cases when the job master hostname cannot be determined.
static List<InetSocketAddress>	getJobMasterRpcAddresses(AlluxioConfiguration conf) Gets the RPC addresses of all job masters based on the configuration.
static List<InetSocketAddress>	getMasterEmbeddedJournalAddresses(AlluxioConfiguration conf)
static Set<String>	getMasterHostnames(AlluxioConfiguration conf) Gets list of masters in conf directory.
static String	getMasterHostNotConfiguredMessage(String serviceName) Returns a unified message for cases when the master hostname cannot be determined.
static List<InetSocketAddress>	getMasterRpcAddresses(AlluxioConfiguration conf) Gets the RPC addresses of all masters based on the configuration.
static String	getSchemeAuthority(AlluxioConfiguration conf)
static Set<String>	getServerHostnames(AlluxioConfiguration conf) Gets list of masters/workers in conf directory.
static Set<String>	getWorkerHostnames(AlluxioConfiguration conf) Gets list of workers in conf directory.
static boolean	isHaMode(AlluxioConfiguration conf)
static boolean	jobMasterHostConfigured(AlluxioConfiguration conf)
static boolean	masterHostConfigured(AlluxioConfiguration conf)
static List<InetSocketAddress>	overridePort(List<InetSocketAddress> addrs, int port) Overrides the port in addresses.
static List<String>	parseAsList(String value, String delimiter) Returns the input string as a list, splitting on a specified delimiter.
static List<InetSocketAddress>	parseInetSocketAddresses(List<String> addresses)
static String	valueAsString(String value)

Methods inherited from class java.lang.Object

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

Method Detail

getEmbeddedJournalAddresses

public static List<InetSocketAddress> getEmbeddedJournalAddresses(AlluxioConfiguration conf,
                                                                  NetworkAddressUtils.ServiceType serviceType)

Gets the embedded journal addresses to use for the given service type (either master-raft or job-master-raft).

Parameters:

conf - configuration

serviceType - the service to get addresses for

Returns:

the addresses

getMasterEmbeddedJournalAddresses

public static List<InetSocketAddress> getMasterEmbeddedJournalAddresses(AlluxioConfiguration conf)

Parameters:

conf - configuration

Returns:

the embedded journal addresses to use for the master

getJobMasterEmbeddedJournalAddresses

public static List<InetSocketAddress> getJobMasterEmbeddedJournalAddresses(AlluxioConfiguration conf)

Parameters:

conf - configuration

Returns:

the embedded journal addresses to use for the job master

getMasterRpcAddresses

public static List<InetSocketAddress> getMasterRpcAddresses(AlluxioConfiguration conf)

Gets the RPC addresses of all masters based on the configuration.

Parameters:

conf - the configuration to use

Returns:

the master rpc addresses

getJobMasterRpcAddresses

public static List<InetSocketAddress> getJobMasterRpcAddresses(AlluxioConfiguration conf)

Gets the RPC addresses of all job masters based on the configuration.

Parameters:

conf - the configuration to use

Returns:

the job master rpc addresses

overridePort

public static List<InetSocketAddress> overridePort(List<InetSocketAddress> addrs,
                                                   int port)

Overrides the port in addresses.

Parameters:

addrs - the addresses

port - the new port

Returns:

the updated addresses

parseInetSocketAddresses

public static List<InetSocketAddress> parseInetSocketAddresses(List<String> addresses)

Parameters:

addresses - a list of address strings in the form "hostname:port"

Returns:

a list of InetSocketAddresses representing the given address strings

jobMasterHostConfigured

public static boolean jobMasterHostConfigured(AlluxioConfiguration conf)

Parameters:

conf - the configuration to use

Returns:

whether the configuration describes how to find the job master host, either through explicit configuration or through zookeeper

getMasterHostNotConfiguredMessage

public static String getMasterHostNotConfiguredMessage(String serviceName)

Returns a unified message for cases when the master hostname cannot be determined.

Parameters:

serviceName - the name of the service that couldn't run. i.e. Alluxio worker, fsadmin shell, etc.

Returns:

a string with the message

getJobMasterHostNotConfiguredMessage

public static String getJobMasterHostNotConfiguredMessage(String serviceName)

Returns a unified message for cases when the job master hostname cannot be determined.

Parameters:

serviceName - the name of the service that couldn't run. i.e. Alluxio worker, fsadmin shell, etc.

Returns:

a string with the message

checkRatio

public static float checkRatio(AlluxioConfiguration conf,
                               PropertyKey key)

Checks that the given property key is a ratio from 0.0 and 1.0, throwing an exception if it is not.

Parameters:

conf - the configuration for looking up the property key

key - the property key

Returns:

the property value

masterHostConfigured

public static boolean masterHostConfigured(AlluxioConfiguration conf)

Parameters:

conf - the configuration to use

Returns:

whether the configuration describes how to find the master host, either through explicit configuration or through zookeeper

isHaMode

public static boolean isHaMode(AlluxioConfiguration conf)

Parameters:

conf - the configuration use

Returns:

whether the configuration specifies to run in ha mode

valueAsString

public static String valueAsString(String value)

Parameters:

value - the value or null (value is not set)

Returns:

the value or "(no value set)" when the value is not set

getSchemeAuthority

public static String getSchemeAuthority(AlluxioConfiguration conf)

Parameters:

conf - the configuration

Returns:

the alluxio scheme and authority determined by the configuration

parseAsList

public static List<String> parseAsList(String value,
                                       String delimiter)

Returns the input string as a list, splitting on a specified delimiter.

Parameters:

value - the value to split

delimiter - the delimiter to split the values

Returns:

the list of values for input string

getMasterHostnames

public static Set<String> getMasterHostnames(AlluxioConfiguration conf)

Gets list of masters in conf directory.

Parameters:

conf - configuration

Returns:

master hostnames

getWorkerHostnames

public static Set<String> getWorkerHostnames(AlluxioConfiguration conf)

Gets list of workers in conf directory.

Parameters:

conf - configuration

Returns:

workers hostnames

getServerHostnames

public static Set<String> getServerHostnames(AlluxioConfiguration conf)

Gets list of masters/workers in conf directory.

Parameters:

conf - configuration

Returns:

server hostnames