org.springframework.yarn.config.annotation.configurers
Class DefaultEnvironmentClasspathConfigurer

java.lang.Object
  org.springframework.data.hadoop.config.common.annotation.AnnotationConfigurerAdapter<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>
      org.springframework.yarn.config.annotation.configurers.DefaultEnvironmentClasspathConfigurer

All Implemented Interfaces:

AnnotationConfigurer<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentBuilder>, AnnotationConfigurerBuilder<YarnEnvironmentConfigurer>, EnvironmentClasspathConfigurer

public class DefaultEnvironmentClasspathConfigurer
extends AnnotationConfigurerAdapter<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>
implements EnvironmentClasspathConfigurer

AnnotationConfigurer which knows how to handle configuring a classpath.

Author:

Janne Valkealahti

Constructor Summary

DefaultEnvironmentClasspathConfigurer()

Method Summary

void	configure(YarnEnvironmentBuilder builder) Configure the AnnotationBuilder by setting the necessary properties on the AnnotationBuilder.
EnvironmentClasspathConfigurer	defaultYarnAppClasspath(java.lang.String... defaultClasspath) Specify a default yarn application classpath entries.
EnvironmentClasspathConfigurer	defaultYarnAppClasspath(java.lang.String defaultClasspath) Specify a default yarn application classpath.
EnvironmentClasspathConfigurer	delimiter(java.lang.String delimiter) Specify a delimiter used in a classpath.
EnvironmentClasspathConfigurer	entries(java.util.List<java.lang.String> entries) Specify a new classpath entries.
EnvironmentClasspathConfigurer	entries(java.lang.String... entries) Specify a new classpath entries.
EnvironmentClasspathConfigurer	entry(java.lang.String entry) Specify a new classpath entry.
EnvironmentClasspathConfigurer	includeBaseDirectory(boolean includeBaseDirectory) Specify if base directory should be added in classpath.
EnvironmentClasspathConfigurer	useDefaultYarnClasspath(boolean defaultClasspath) Specify if default yarn classpath entries should be added.

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

addObjectPostProcessor, and, getBuilder, init, isAssignable, setBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.hadoop.config.common.annotation.AnnotationConfigurerBuilder

and

Constructor Detail

DefaultEnvironmentClasspathConfigurer

public DefaultEnvironmentClasspathConfigurer()

Method Detail

configure

public void configure(YarnEnvironmentBuilder builder)
               throws java.lang.Exception

Description copied from interface: AnnotationConfigurer

Configure the AnnotationBuilder by setting the necessary properties on the AnnotationBuilder.

Specified by:

configure in interface AnnotationConfigurer<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentBuilder>

Overrides:

configure in class AnnotationConfigurerAdapter<java.util.Map<java.lang.String,java.lang.String>,YarnEnvironmentConfigurer,YarnEnvironmentBuilder>

Parameters:

builder - the builder

Throws:

java.lang.Exception - if error occurred

entry

public EnvironmentClasspathConfigurer entry(java.lang.String entry)

Description copied from interface: EnvironmentClasspathConfigurer

Specify a new classpath entry.

Specified by:

entry in interface EnvironmentClasspathConfigurer

Parameters:

entry - the classpath entry

Returns:

EnvironmentClasspathConfigurer for chaining

entries

public EnvironmentClasspathConfigurer entries(java.lang.String... entries)

Description copied from interface: EnvironmentClasspathConfigurer

Specify a new classpath entries.

Specified by:

entries in interface EnvironmentClasspathConfigurer

Parameters:

entries - the classpath entries

Returns:

EnvironmentClasspathConfigurer for chaining

entries

public EnvironmentClasspathConfigurer entries(java.util.List<java.lang.String> entries)

Description copied from interface: EnvironmentClasspathConfigurer

Specify a new classpath entries.

Specified by:

entries in interface EnvironmentClasspathConfigurer

Parameters:

entries - the classpath entries

Returns:

EnvironmentClasspathConfigurer for chaining

useDefaultYarnClasspath

public EnvironmentClasspathConfigurer useDefaultYarnClasspath(boolean defaultClasspath)

Description copied from interface: EnvironmentClasspathConfigurer

Specify if default yarn classpath entries should be added.

Specified by:

useDefaultYarnClasspath in interface EnvironmentClasspathConfigurer

Parameters:

defaultClasspath - the use default classpath

Returns:

EnvironmentClasspathConfigurer for chaining

defaultYarnAppClasspath

public EnvironmentClasspathConfigurer defaultYarnAppClasspath(java.lang.String defaultClasspath)

Description copied from interface: EnvironmentClasspathConfigurer

Specify a default yarn application classpath. Given classpath entry can be a comma delimited list.

Specified by:

defaultYarnAppClasspath in interface EnvironmentClasspathConfigurer

Parameters:

defaultClasspath - the default classpath

Returns:

EnvironmentClasspathConfigurer for chaining

defaultYarnAppClasspath

public EnvironmentClasspathConfigurer defaultYarnAppClasspath(java.lang.String... defaultClasspath)

Description copied from interface: EnvironmentClasspathConfigurer

Specify a default yarn application classpath entries.

Specified by:

defaultYarnAppClasspath in interface EnvironmentClasspathConfigurer

Parameters:

defaultClasspath - the default classpath entries.

Returns:

EnvironmentClasspathConfigurer for chaining

includeBaseDirectory

public EnvironmentClasspathConfigurer includeBaseDirectory(boolean includeBaseDirectory)

Description copied from interface: EnvironmentClasspathConfigurer

Specify if base directory should be added in classpath.

Specified by:

includeBaseDirectory in interface EnvironmentClasspathConfigurer

Parameters:

includeBaseDirectory - the include base directory

Returns:

EnvironmentClasspathConfigurer for chaining

delimiter

public EnvironmentClasspathConfigurer delimiter(java.lang.String delimiter)

Description copied from interface: EnvironmentClasspathConfigurer

Specify a delimiter used in a classpath.

Specified by:

delimiter in interface EnvironmentClasspathConfigurer

Parameters:

delimiter - the delimiter

Returns:

EnvironmentClasspathConfigurer for chaining