Spring for Apache Hadoop

org.springframework.yarn.configuration
Class ConfigurationUtils

java.lang.Object
  extended by org.springframework.yarn.configuration.ConfigurationUtils

public abstract class ConfigurationUtils
extends java.lang.Object

Reusable utility class for common Configuration operations.

Author:
Costin Leau, Janne Valkealahti

Constructor Summary
ConfigurationUtils()
           
 
Method Summary
static void addArchives(org.apache.hadoop.conf.Configuration configuration, org.springframework.core.io.Resource... archives)
           
static void addFiles(org.apache.hadoop.conf.Configuration configuration, org.springframework.core.io.Resource... files)
           
static void addLibs(org.apache.hadoop.conf.Configuration configuration, org.springframework.core.io.Resource... libs)
           
static void addProperties(org.apache.hadoop.conf.Configuration configuration, java.util.Properties properties)
          Adds the specified properties to the given Configuration object.
static java.util.Properties asProperties(org.apache.hadoop.conf.Configuration configuration)
          Returns a static Properties copy of the given configuration.
static org.apache.hadoop.conf.Configuration createFrom(org.apache.hadoop.conf.Configuration original, java.util.Properties properties)
          Creates a new Configuration based on the given arguments.
static org.apache.hadoop.yarn.conf.YarnConfiguration createFrom(org.apache.hadoop.yarn.conf.YarnConfiguration original, java.util.Properties properties)
          Creates a new YarnConfiguration based on the given arguments.
static org.apache.hadoop.conf.Configuration merge(org.apache.hadoop.conf.Configuration one, org.apache.hadoop.conf.Configuration two)
          Creates a new Configuration by merging the given configurations.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigurationUtils

public ConfigurationUtils()
Method Detail

addProperties

public static void addProperties(org.apache.hadoop.conf.Configuration configuration,
                                 java.util.Properties properties)
Adds the specified properties to the given Configuration object.

Parameters:
configuration - configuration to manipulate. Should not be null.
properties - properties to add to the configuration. May be null.

createFrom

public static org.apache.hadoop.conf.Configuration createFrom(org.apache.hadoop.conf.Configuration original,
                                                              java.util.Properties properties)
Creates a new Configuration based on the given arguments.

Parameters:
original - initial configuration to read from. May be null.
properties - properties object to add to the newly created configuration. May be null.
Returns:
newly created configuration based on the input parameters.

createFrom

public static org.apache.hadoop.yarn.conf.YarnConfiguration createFrom(org.apache.hadoop.yarn.conf.YarnConfiguration original,
                                                                       java.util.Properties properties)
Creates a new YarnConfiguration based on the given arguments. Identical to createFrom(Configuration, Properties) but forces the use of YarnConfiguration.

Parameters:
original - initial configuration to read from. May be null.
properties - properties object to add to the newly created configuration. May be null.
Returns:
newly created configuration based on the input parameters.

asProperties

public static java.util.Properties asProperties(org.apache.hadoop.conf.Configuration configuration)
Returns a static Properties copy of the given configuration.

Parameters:
configuration - Hadoop configuration

merge

public static org.apache.hadoop.conf.Configuration merge(org.apache.hadoop.conf.Configuration one,
                                                         org.apache.hadoop.conf.Configuration two)
Creates a new Configuration by merging the given configurations. Ordering is important - the second configuration overriding values in the first.

Parameters:
one - configuration to read from. May be null.
two - configuration to read from. May be null.
Returns:
the result of merging the two configurations.

addLibs

public static void addLibs(org.apache.hadoop.conf.Configuration configuration,
                           org.springframework.core.io.Resource... libs)

addFiles

public static void addFiles(org.apache.hadoop.conf.Configuration configuration,
                            org.springframework.core.io.Resource... files)

addArchives

public static void addArchives(org.apache.hadoop.conf.Configuration configuration,
                               org.springframework.core.io.Resource... archives)

Spring for Apache Hadoop