org.springframework.yarn.config.annotation.builders

Class YarnEnvironmentBuilder

java.lang.Object

org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder<O>

org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>

org.springframework.yarn.config.annotation.builders.YarnEnvironmentBuilder

All Implemented Interfaces:

AnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>, PropertiesConfigurerAware, YarnEnvironmentConfigurer

public final class YarnEnvironmentBuilder
extends AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>
implements PropertiesConfigurerAware, YarnEnvironmentConfigurer

AnnotationBuilder for Yarn environment.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
YarnEnvironmentBuilder() Instantiates a new yarn environment builder.

Method Summary

Methods

Modifier and Type	Method and Description
void	addClasspathEntries(java.lang.String id, java.util.ArrayList<java.lang.String> classpathEntries) Adds the classpath entries.
void	configuration(org.apache.hadoop.conf.Configuration configuration) Sets the yarn configuration.
void	configureProperties(java.util.Properties properties) Configure Properties.
YarnEnvironmentConfigurer	entry(java.lang.String key, java.lang.String value) Specify an environment variable.
YarnEnvironmentConfigurer	entry(java.lang.String id, java.lang.String key, java.lang.String value) Specify an environment variable using an identifier.
YarnEnvironmentConfigurer	includeLocalSystemEnv(boolean includeLocalSystemEnv) Specify if existing system environment variables should be included automatically.
YarnEnvironmentConfigurer	includeLocalSystemEnv(java.lang.String id, boolean includeLocalSystemEnv) Specify if existing system environment variables should be included automatically with an identifier.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	performBuild() Subclasses must implement this method to build the object that is being returned.
YarnEnvironmentConfigurer	propertiesLocation(java.lang.String... locations) Specify properties locations.
YarnEnvironmentConfigurer	propertiesLocationId(java.lang.String id, java.lang.String[] locations) Specify properties locations with an identifier.
void	setDefaultMapreduceAppClasspath(java.lang.String id, java.lang.String defaultMapreduceAppClasspath) Sets the default mr app classpath.
void	setDefaultYarnAppClasspath(java.lang.String id, java.lang.String defaultYarnAppClasspath) Sets the default yarn app classpath.
void	setDelimiter(java.lang.String id, java.lang.String delimiter) Sets the delimiter.
void	setIncludeBaseDirectory(java.lang.String id, boolean includeBaseDirectory) Sets the include base directory.
void	setUseDefaultMapreduceClasspath(java.lang.String id, boolean useDefaultClasspath) Sets the default classpath.
void	setUseDefaultYarnClasspath(java.lang.String id, boolean useDefaultClasspath) Sets the default classpath.
EnvironmentClasspathConfigurer	withClasspath() Specify a classpath environment variable.
EnvironmentClasspathConfigurer	withClasspath(java.lang.String id) Specify a classpath environment variable using an identifier.
PropertiesConfigurer<YarnEnvironmentConfigurer>	withProperties() Specify properties with a PropertiesConfigurer.
PropertiesConfigurer<YarnEnvironmentConfigurer>	withProperties(java.lang.String id) Specify properties with a PropertiesConfigurer with an identifier.

Methods inherited from class org.springframework.data.hadoop.config.common.annotation.AbstractConfiguredAnnotationBuilder

apply, apply, beforeConfigureMains, beforeConfigurePosts, beforeInit, doBuild, getConfigurer, getConfigurers, getOrApply, getOrBuild, getSharedObject, getSharedObjects, objectPostProcessor, postProcess, removeConfigurer, removeConfigurers, setSharedObject

Methods inherited from class org.springframework.data.hadoop.config.common.annotation.AbstractAnnotationBuilder

build, getObject

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnEnvironmentBuilder

public YarnEnvironmentBuilder()

Instantiates a new yarn environment builder.

Method Detail

performBuild

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> performBuild()
                                                                                                 throws java.lang.Exception

Description copied from class: AbstractConfiguredAnnotationBuilder

Subclasses must implement this method to build the object that is being returned.

Specified by:

performBuild in class AbstractConfiguredAnnotationBuilder<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>

Returns:

Object build by this builder

Throws:

java.lang.Exception - on error

configureProperties

public void configureProperties(java.util.Properties properties)

Description copied from interface: PropertiesConfigurerAware

Configure Properties.

Specified by:

configureProperties in interface PropertiesConfigurerAware

Parameters:

properties - the properties

withClasspath

public EnvironmentClasspathConfigurer withClasspath()
                                             throws java.lang.Exception

Description copied from interface: YarnEnvironmentConfigurer

Specify a classpath environment variable.

Applies a new DefaultEnvironmentClasspathConfigurer into current builder. Equivalents between JavaConfig and XML are shown below.
JavaConfig:

 public void configure(YarnEnvironmentBuilder environment) throws Exception {
   environment
     .withClasspath()
       .entry("cpEntry1")
       .entry("cpEntry2")
       .useDefaultYarnClasspath(true);
 }
 

XML:

 <yarn:environment>
   <yarn:classpath use-yarn-app-classpath="true" delimiter=":">
     cpEntry1
     cpEntry2
   </yarn:classpath>
 </yarn:environment>
 

Specified by:

withClasspath in interface YarnEnvironmentConfigurer

Returns:

EnvironmentClasspathConfigurer for classpath

Throws:

java.lang.Exception - if error occurred

withClasspath

public EnvironmentClasspathConfigurer withClasspath(java.lang.String id)
                                             throws java.lang.Exception

Description copied from interface: YarnEnvironmentConfigurer

Specify a classpath environment variable using an identifier.

Specified by:

withClasspath in interface YarnEnvironmentConfigurer

Parameters:

id - the identifier

Returns:

EnvironmentClasspathConfigurer for classpath

Throws:

java.lang.Exception - if error occurred

See Also:

YarnEnvironmentConfigurer.withClasspath()

entry

public YarnEnvironmentConfigurer entry(java.lang.String key,
                              java.lang.String value)

Description copied from interface: YarnEnvironmentConfigurer

Specify an environment variable.
JavaConfig:

 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .entry("myKey1","myValue1")
     .entry("myKey2","myValue2");
 }
 

XML:

 <yarn:environment>
   myKey1=myValue1
   myKey2=myValue2
 </yarn:environment>
 

Specified by:

entry in interface YarnEnvironmentConfigurer

Parameters:

key - The environment key

value - The environment value

Returns:

YarnEnvironmentConfigurer for chaining

entry

public YarnEnvironmentConfigurer entry(java.lang.String id,
                              java.lang.String key,
                              java.lang.String value)

Description copied from interface: YarnEnvironmentConfigurer

Specify an environment variable using an identifier.

Specified by:

entry in interface YarnEnvironmentConfigurer

Parameters:

id - the identifier

key - The environment key

value - The environment value

Returns:

YarnEnvironmentConfigurer for chaining

See Also:

YarnEnvironmentConfigurer.entry(String, String)

propertiesLocation

public YarnEnvironmentConfigurer propertiesLocation(java.lang.String... locations)
                                             throws java.io.IOException

Description copied from interface: YarnEnvironmentConfigurer

Specify properties locations.
JavaConfig:

 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .entry("myKey1","myValue1")
     .entry("myKey2","myValue2")
     .propertiesLocation("cfg-1.properties", "cfg-2.properties");
 }
 

XML:

 <yarn:environment properties-location="cfg-1.properties, cfg-2.properties">
   myKey1=myValue1
   myKey2=myValue2
 </yarn:environment>
 

Specified by:

propertiesLocation in interface YarnEnvironmentConfigurer

Parameters:

locations - The properties file locations

Returns:

YarnEnvironmentConfigurer for chaining

Throws:

java.io.IOException - if error occurred

propertiesLocationId

public YarnEnvironmentConfigurer propertiesLocationId(java.lang.String id,
                                             java.lang.String[] locations)
                                               throws java.io.IOException

Description copied from interface: YarnEnvironmentConfigurer

Specify properties locations with an identifier.

Specified by:

propertiesLocationId in interface YarnEnvironmentConfigurer

Parameters:

id - the identifier

locations - the properties file locations

Returns:

YarnEnvironmentConfigurer for chaining

Throws:

java.io.IOException - if error occurred

See Also:

YarnEnvironmentConfigurer.propertiesLocation(String...)

includeLocalSystemEnv

public YarnEnvironmentConfigurer includeLocalSystemEnv(boolean includeLocalSystemEnv)

Description copied from interface: YarnEnvironmentConfigurer

Specify if existing system environment variables should be included automatically.
JavaConfig:

 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   environment
     .includeLocalSystemEnv(false);
 }
 

XML:

 <yarn:environment include-local-system-env="false"/>
 

Specified by:

includeLocalSystemEnv in interface YarnEnvironmentConfigurer

Parameters:

includeLocalSystemEnv - if system env variables should be included

Returns:

YarnEnvironmentConfigurer for chaining

includeLocalSystemEnv

public YarnEnvironmentConfigurer includeLocalSystemEnv(java.lang.String id,
                                              boolean includeLocalSystemEnv)

Description copied from interface: YarnEnvironmentConfigurer

Specify if existing system environment variables should be included automatically with an identifier.

Specified by:

includeLocalSystemEnv in interface YarnEnvironmentConfigurer

Parameters:

id - the identifier

includeLocalSystemEnv - if system env variables should be included

Returns:

YarnEnvironmentConfigurer for chaining

See Also:

YarnEnvironmentConfigurer.includeLocalSystemEnv(boolean)

withProperties

public PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties()
                                                               throws java.lang.Exception

Description copied from interface: YarnEnvironmentConfigurer

Specify properties with a PropertiesConfigurer.
JavaConfig:

 public void configure(YarnEnvironmentConfigure environment) throws Exception {
   Properties props = new Properties();
   environment
     .withProperties()
       .properties(props)
       .property("myKey1", ",myValue1")
       .and();
 }
 

XML:

 <util:properties id="props" location="props.properties"/>
   <prop key="myKey1">myValue1</prop>
 </util:properties>
 <yarn:environment properties-ref="props"/>
 

Specified by:

withProperties in interface YarnEnvironmentConfigurer

Returns:

PropertiesConfigurer for chaining

Throws:

java.lang.Exception - if error occurred

withProperties

public PropertiesConfigurer<YarnEnvironmentConfigurer> withProperties(java.lang.String id)
                                                               throws java.lang.Exception

Description copied from interface: YarnEnvironmentConfigurer

Specify properties with a PropertiesConfigurer with an identifier.

Specified by:

withProperties in interface YarnEnvironmentConfigurer

Parameters:

id - the identifier

Returns:

PropertiesConfigurer for chaining

Throws:

java.lang.Exception - if error occurred

See Also:

YarnEnvironmentConfigurer.withProperties()

addClasspathEntries

public void addClasspathEntries(java.lang.String id,
                       java.util.ArrayList<java.lang.String> classpathEntries)

Adds the classpath entries.

Parameters:

id - the id

classpathEntries - the classpath entries

configuration

public void configuration(org.apache.hadoop.conf.Configuration configuration)

Sets the yarn configuration.

Parameters:

configuration - the yarn configuration

setUseDefaultYarnClasspath

public void setUseDefaultYarnClasspath(java.lang.String id,
                              boolean useDefaultClasspath)

Sets the default classpath.

Parameters:

id - the id

useDefaultClasspath - the new default classpath

setUseDefaultMapreduceClasspath

public void setUseDefaultMapreduceClasspath(java.lang.String id,
                                   boolean useDefaultClasspath)

Sets the default classpath.

Parameters:

id - the id

useDefaultClasspath - the new default classpath

setIncludeBaseDirectory

public void setIncludeBaseDirectory(java.lang.String id,
                           boolean includeBaseDirectory)

Sets the include base directory.

Parameters:

id - the id

includeBaseDirectory - the new include base directory

setDelimiter

public void setDelimiter(java.lang.String id,
                java.lang.String delimiter)

Sets the delimiter.

Parameters:

id - the id

delimiter - the new delimiter

setDefaultYarnAppClasspath

public void setDefaultYarnAppClasspath(java.lang.String id,
                              java.lang.String defaultYarnAppClasspath)

Sets the default yarn app classpath.

Parameters:

id - the id

defaultYarnAppClasspath - the new default yarn app classpath

setDefaultMapreduceAppClasspath

public void setDefaultMapreduceAppClasspath(java.lang.String id,
                                   java.lang.String defaultMapreduceAppClasspath)

Sets the default mr app classpath.

Parameters:

id - the id

defaultMapreduceAppClasspath - the new default mr app classpath