org.springframework.data.hadoop.mapreduce

Class JarRunner

java.lang.Object

org.springframework.data.hadoop.mapreduce.JarExecutor

org.springframework.data.hadoop.mapreduce.JarRunner

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Integer>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean

public class JarRunner
extends JarExecutor
implements java.util.concurrent.Callable<java.lang.Integer>, org.springframework.beans.factory.InitializingBean

Factory bean for executing Hadoop jars. Tries a best-effort in passing the configuration to the jar and preventing malicious behaviour (such as System.exit()). See the reference documentation for more details. Using the Tool interface is highly recommended in all cases.

To make the runner execute at startup, use setRunAtStartup(boolean).

Author:

Costin Leau

Constructor Summary

Constructors

Constructor and Description
JarRunner()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
java.lang.Integer	call()
protected java.lang.Class<T>	loadClass(java.lang.String className, java.lang.ClassLoader cl)
protected org.apache.hadoop.conf.Configuration	resolveConfiguration()
protected java.lang.Class<T>	resolveTargetClass(org.apache.hadoop.conf.Configuration cfg)
protected int	runCode()
void	setArchives(org.springframework.core.io.Resource... archives) Sets the archives to be unarchive to the map reduce cluster.
void	setArguments(java.lang.String... arguments) Sets the arguments.
void	setBeanClassLoader(java.lang.ClassLoader classLoader)
void	setCloseFs(boolean closeFs) Indicates whether or not to close the Hadoop file-systems resulting from the custom code execution.
void	setConfiguration(org.apache.hadoop.conf.Configuration configuration) Sets the configuration.
void	setFiles(org.springframework.core.io.Resource... files) Sets the files to be copied to the map reduce cluster.
void	setJar(org.springframework.core.io.Resource jar) Sets the target code jar.
void	setLibs(org.springframework.core.io.Resource... libJars) Sets the jar files to include in the classpath.
void	setPostAction(java.util.Collection<java.util.concurrent.Callable<?>> actions) Actions to be invoked after running the action.
void	setPreAction(java.util.Collection<java.util.concurrent.Callable<?>> actions) Actions to be invoked before running the action.
void	setProperties(java.util.Properties properties) Sets the properties.
void	setRunAtStartup(boolean runAtStartup) Indicates whether the jar should run at container startup or not (the default).
void	setUser(java.lang.String user) Sets the user impersonation (optional) for running this job.

Methods inherited from class org.springframework.data.hadoop.mapreduce.JarExecutor

createClassLoaderForJar, invokeTargetObject, postExecution, preExecution, resolveTargetObject, setMainClass

Methods inherited from class java.lang.Object

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

Constructor Detail

JarRunner

public JarRunner()

Method Detail

call

public java.lang.Integer call()
                       throws java.lang.Exception

Specified by:

call in interface java.util.concurrent.Callable<java.lang.Integer>

Throws:

java.lang.Exception

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

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

Overrides:

afterPropertiesSet in class JarExecutor

Throws:

java.lang.Exception

setRunAtStartup

public void setRunAtStartup(boolean runAtStartup)

Indicates whether the jar should run at container startup or not (the default).

Parameters:

runAtStartup - The runAtStartup to set.

setPreAction

public void setPreAction(java.util.Collection<java.util.concurrent.Callable<?>> actions)

Actions to be invoked before running the action.

Parameters:

actions - actions

setPostAction

public void setPostAction(java.util.Collection<java.util.concurrent.Callable<?>> actions)

Actions to be invoked after running the action.

Parameters:

actions - actions

runCode

protected int runCode()
               throws java.lang.Exception

Throws:

java.lang.Exception

resolveConfiguration

protected org.apache.hadoop.conf.Configuration resolveConfiguration()
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

resolveTargetClass

protected java.lang.Class<T> resolveTargetClass(org.apache.hadoop.conf.Configuration cfg)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

loadClass

protected java.lang.Class<T> loadClass(java.lang.String className,
                           java.lang.ClassLoader cl)

setJar

public void setJar(org.springframework.core.io.Resource jar)

Sets the target code jar.

Parameters:

jar - target jar

setArguments

public void setArguments(java.lang.String... arguments)

Sets the arguments.

Parameters:

arguments - The arguments to set.

setConfiguration

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

Sets the configuration.

Parameters:

configuration - The configuration to set.

setProperties

public void setProperties(java.util.Properties properties)

Sets the properties.

Parameters:

properties - The properties to set.

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:

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

setCloseFs

public void setCloseFs(boolean closeFs)

Indicates whether or not to close the Hadoop file-systems resulting from the custom code execution. Default is true. Turn this to false if the code reuses the same file-system used by the rest of the application.

Parameters:

closeFs - the new close fs

setLibs

public void setLibs(org.springframework.core.io.Resource... libJars)

Sets the jar files to include in the classpath. Note that a pattern can be used (e.g. mydir/*.jar), which the Spring container will automatically resolve.

Parameters:

libJars - The jar files to include in the classpath.

setFiles

public void setFiles(org.springframework.core.io.Resource... files)

Sets the files to be copied to the map reduce cluster. Note that a pattern can be used (e.g. mydir/*.txt), which the Spring container will automatically resolve.

Parameters:

files - The files to copy.

setArchives

public void setArchives(org.springframework.core.io.Resource... archives)

Sets the archives to be unarchive to the map reduce cluster. Note that a pattern can be used (e.g. mydir/*.zip), which the Spring container will automatically resolve.

Parameters:

archives - The archives to unarchive on the compute machines.

setUser

public void setUser(java.lang.String user)

Sets the user impersonation (optional) for running this job. Should be used when running against a Hadoop Kerberos cluster.

Parameters:

user - user/group information