org.springframework.data.hadoop.configuration

Class ConfigurationFactoryBean

java.lang.Object

org.springframework.data.hadoop.configuration.ConfigurationFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.FactoryBean<org.apache.hadoop.conf.Configuration>, org.springframework.beans.factory.InitializingBean

public class ConfigurationFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.FactoryBean<org.apache.hadoop.conf.Configuration>

FactoryBean for creating Configuration instances.

Author:

Costin Leau, Janne Valkealahti

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	USERKEYTAB
static java.lang.String	USERPRINCIPAL

Constructor Summary

Constructors

Constructor and Description
ConfigurationFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected org.apache.hadoop.conf.Configuration	createConfiguration(org.apache.hadoop.conf.Configuration existing) Creates a configuration instance potentially using the existing one (passed as an argument - which can be null).
org.apache.hadoop.conf.Configuration	getObject()
java.lang.Class<?>	getObjectType()
boolean	isSingleton()
protected void	postProcessConfiguration(org.apache.hadoop.conf.Configuration configuration)
void	setBeanClassLoader(java.lang.ClassLoader classLoader)
void	setConfiguration(org.apache.hadoop.conf.Configuration configuration) Sets the parent configuration.
void	setFileSystemUri(java.lang.String fsUri) Sets the File System ('fs.defaultFS') URI
void	setInitialize(boolean initialize) Indicates whether the configuration object should be initialized (true) or not.
void	setJobHistoryUri(java.lang.String jhUri) Sets the Job Tracker ('mapreduce.jobhistory.address') URI.
void	setLoadDefaults(boolean loadDefaults) Indicates whether to load the defaults (the default) or not for this configuration.
void	setNamenodePrincipal(java.lang.String namenodePrincipal) Sets the used namenode principal.
void	setProperties(java.util.Properties properties) Sets the configuration properties.
void	setRegisterUrlHandler(boolean register) Indicates whether the configuration should register an URL handler (for allowing urls to understand HDFS prefixes, such as hdfs) or not.
void	setResources(java.util.Set<org.springframework.core.io.Resource> resources) Sets the configuration resources.
void	setRmManagerPrincipal(java.lang.String rmManagerPrincipal) Sets the used resource manager principal.
void	setRmManagerUri(java.lang.String rmUri) Sets the Yarn resource manager ('yarn.resourcemanager.address') URI.
void	setSecurityMethod(java.lang.String securityMethod) Sets the used security method.
void	setUserKeytab(java.lang.String userKeytab) Sets a path to a keytab file.
void	setUserPrincipal(java.lang.String userPrincipal) Sets the the user login principal.

Methods inherited from class java.lang.Object

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

Field Detail

USERKEYTAB

public static final java.lang.String USERKEYTAB

See Also:

Constant Field Values

USERPRINCIPAL

public static final java.lang.String USERPRINCIPAL

See Also:

Constant Field Values

Constructor Detail

ConfigurationFactoryBean

public ConfigurationFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

setSecurityMethod

public void setSecurityMethod(java.lang.String securityMethod)

Sets the used security method.

Parameters:

securityMethod - the security method

getObject

public org.apache.hadoop.conf.Configuration getObject()

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<org.apache.hadoop.conf.Configuration>

getObjectType

public java.lang.Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<org.apache.hadoop.conf.Configuration>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<org.apache.hadoop.conf.Configuration>

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

setUserKeytab

public void setUserKeytab(java.lang.String userKeytab)

Sets a path to a keytab file.

Parameters:

userKeytab - the path to a keytab file

setUserPrincipal

public void setUserPrincipal(java.lang.String userPrincipal)

Sets the the user login principal.

Parameters:

userPrincipal - the user login principal

setNamenodePrincipal

public void setNamenodePrincipal(java.lang.String namenodePrincipal)

Sets the used namenode principal.

Parameters:

namenodePrincipal - the namenode principal.

setRmManagerPrincipal

public void setRmManagerPrincipal(java.lang.String rmManagerPrincipal)

Sets the used resource manager principal.

Parameters:

rmManagerPrincipal - the resource manager principal

createConfiguration

protected org.apache.hadoop.conf.Configuration createConfiguration(org.apache.hadoop.conf.Configuration existing)

Creates a configuration instance potentially using the existing one (passed as an argument - which can be null).

Parameters:

existing - existing configuration

Returns:

configuration instance

postProcessConfiguration

protected void postProcessConfiguration(org.apache.hadoop.conf.Configuration configuration)

setConfiguration

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

Sets the parent configuration.

Parameters:

configuration - The configuration to set.

setLoadDefaults

public void setLoadDefaults(boolean loadDefaults)

Indicates whether to load the defaults (the default) or not for this configuration.

Parameters:

loadDefaults - The loadDefaults to set.

setResources

public void setResources(java.util.Set<org.springframework.core.io.Resource> resources)

Sets the configuration resources.

Parameters:

resources - The resources to set.

setProperties

public void setProperties(java.util.Properties properties)

Sets the configuration properties.

Parameters:

properties - The properties to set.

setInitialize

public void setInitialize(boolean initialize)

Indicates whether the configuration object should be initialized (true) or not. This option should normally be set to true (the default) as it causes the jars, streams and resources set to be loaded - postponing the initializing might cause these to become unreadable.

Parameters:

initialize - whether to initialize or not.

setRegisterUrlHandler

public void setRegisterUrlHandler(boolean register)

Indicates whether the configuration should register an URL handler (for allowing urls to understand HDFS prefixes, such as hdfs) or not. As this operation impacts an entire VM and can be invoked at most once per JVM, by default it is false.

Parameters:

register - whether to register an URL handler or not

setFileSystemUri

public void setFileSystemUri(java.lang.String fsUri)

Sets the File System ('fs.defaultFS') URI

Parameters:

fsUri - the default file system uri

setRmManagerUri

public void setRmManagerUri(java.lang.String rmUri)

Sets the Yarn resource manager ('yarn.resourcemanager.address') URI.

Parameters:

rmUri - the resource manager uri

setJobHistoryUri

public void setJobHistoryUri(java.lang.String jhUri)

Sets the Job Tracker ('mapreduce.jobhistory.address') URI.

Parameters:

jhUri - the job tracker uri