alluxio.hub.agent.util.conf

Class ConfigurationEditor

java.lang.Object

alluxio.hub.agent.util.conf.ConfigurationEditor

public class ConfigurationEditor
extends Object

An object which allows the reading and writing of Alluxio configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_FILE Name of the shell script containing JVM configuration.
static String	LOG_FILE Name of the log4j properties file.
static String	SITE_PROPERTIES Name of the site properties file.

Constructor Summary

Constructors

Constructor and Description
ConfigurationEditor(String siteConfDirs) Creates a new editor.

Method Summary

Modifier and Type	Method and Description
Path	getEnvSh()
Path	getLogProps()
Path	getSiteProperties()
AlluxioConfigurationSet	readConf() Reads the Alluxio configuration given the reader's configuration.
void	writeConf(AlluxioConfigurationSet conf) Writes out the given configuration to disk.

Methods inherited from class java.lang.Object

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

Field Detail

ENV_FILE

public static final String ENV_FILE

Name of the shell script containing JVM configuration.

See Also:

Constant Field Values

LOG_FILE

public static final String LOG_FILE

Name of the log4j properties file.

See Also:

Constant Field Values

SITE_PROPERTIES

public static final String SITE_PROPERTIES

Name of the site properties file.

See Also:

Constant Field Values

Constructor Detail

ConfigurationEditor

public ConfigurationEditor(String siteConfDirs)

Creates a new editor. It will search the paths supplied (delimited by ",") for the Alluxio configuration files.

Parameters:

siteConfDirs - a comma-delimited list of paths to search for Alluxio configuration files

Method Detail

getSiteProperties

public Path getSiteProperties()

Returns:

the path that will be searched for the alluxio-site.properties file

getEnvSh

@Nullable
public Path getEnvSh()

Returns:

the path that will be searched for alluxio-env.sh

getLogProps

public Path getLogProps()

Returns:

the path that will be searched for log4j.properties

readConf

public AlluxioConfigurationSet readConf()
                                 throws IOException

Reads the Alluxio configuration given the reader's configuration.

Returns:

the corresponding AlluxioConfigurationSet

Throws:

IOException - if reading any of the configuration files fails

writeConf

public void writeConf(AlluxioConfigurationSet conf)
               throws IOException

Writes out the given configuration to disk. Upon failure, this method will throw an IOException, but will not undo or roll-back any changes made to the files over the course of this function.

Parameters:

conf - the configuration to write

Throws:

IOException - if any failures occur while writing