ToolRunner (Spring for Apache Hadoop 2.5.0.RELEASE API)

java.lang.Object
- org.springframework.data.hadoop.mapreduce.ToolExecutor
- - org.springframework.data.hadoop.mapreduce.ToolRunner

実装されたすべてのインターフェース:
java.util.concurrent.Callable<java.lang.Integer>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean
```
public class ToolRunner
extends ToolExecutor
implements java.util.concurrent.Callable<java.lang.Integer>, org.springframework.beans.factory.InitializingBean
```
ToolRunner のラッパーにより、Spring 内での Tool インスタンスの設定と実行が容易になります。オプションで実行結果を返します (Tool.run(String[]) ごとに int として)。
ランナーを起動時に実行させるには、setRunAtStartup(boolean) を使用します。
作成者:
Costin Leau

コンストラクターの概要
コンストラクター
コンストラクターと説明
ToolRunner()

コンストラクター
コンストラクターと説明
`ToolRunner()`

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()`
`java.lang.Integer`	`call()`
`protected java.lang.ClassLoader`	`createClassLoaderForJar(org.springframework.core.io.Resource jar, java.lang.ClassLoader parentCL, org.apache.hadoop.conf.Configuration cfg)`
`protected void`	`postExecution(org.apache.hadoop.conf.Configuration cfg)`
`protected void`	`preExecution(org.apache.hadoop.conf.Configuration cfg)`
`protected org.apache.hadoop.conf.Configuration`	`resolveConfiguration()`
`protected java.lang.Class<T>`	`resolveTargetClass(org.apache.hadoop.conf.Configuration cfg)`
`protected T`	`resolveTargetObject(java.lang.Class<T> type)`
`protected int`	`runCode()`
`void`	`setArchives(org.springframework.core.io.Resource... archives)` マップ削減クラスターにアーカイブ解除するアーカイブを設定します。
`void`	`setArguments(java.lang.String... arguments)` 引数を設定します。
`void`	`setBeanClassLoader(java.lang.ClassLoader classLoader)`
`void`	`setCloseFs(boolean closeFs)` カスタムコードの実行の結果として生成された Hadoop ファイルシステムを閉じるかどうかを示します。
`void`	`setConfiguration(org.apache.hadoop.conf.Configuration configuration)` 構成を設定します。
`void`	`setFiles(org.springframework.core.io.Resource... files)` マップ削減クラスターにコピーするファイルを設定します。
`void`	`setJar(org.springframework.core.io.Resource jar)` ターゲットコードを jar に設定します。
`void`	`setLibs(org.springframework.core.io.Resource... libJars)` クラスパスに含める jar ファイルを設定します。
`void`	`setPostAction(java.util.Collection<java.util.concurrent.Callable<?>> actions)` アクションを実行した後に呼び出されるアクション。
`void`	`setPreAction(java.util.Collection<java.util.concurrent.Callable<?>> actions)` アクションを実行する前に呼び出されるアクション。
`void`	`setProperties(java.util.Properties properties)` プロパティを設定します。
`void`	`setRunAtStartup(boolean runAtStartup)` コンテナーの起動時にツールを実行するかどうか (デフォルト) を示します。
`void`	`setUser(java.lang.String user)` このジョブを実行するためのユーザーの偽装 (オプション) を設定します。

クラス org.springframework.data.hadoop.mapreduce.ToolExecutor から継承されたメソッド
invokeTargetObject, loadClass, setTool, setToolClass

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - ToolRunner
```
public ToolRunner()
```
- メソッドの詳細
  - call
```
public java.lang.Integer call()
                       throws java.lang.Exception
```
    次で指定:
    インターフェース java.util.concurrent.Callable<java.lang.Integer> の call
    例外:
    java.lang.Exception
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    例外:
    java.lang.Exception
  - setRunAtStartup
```
public void setRunAtStartup(boolean runAtStartup)
```
    コンテナーの起動時にツールを実行するかどうか (デフォルト) を示します。
    パラメーター:
    runAtStartup - 設定する runAtStartup。
  - setPreAction
```
public void setPreAction(java.util.Collection<java.util.concurrent.Callable<?>> actions)
```
    アクションを実行する前に呼び出されるアクション。
    パラメーター:
    actions - アクション
  - setPostAction
```
public void setPostAction(java.util.Collection<java.util.concurrent.Callable<?>> actions)
```
    アクションを実行した後に呼び出されるアクション。
    パラメーター:
    actions - アクション
  - runCode
```
protected int runCode()
               throws java.lang.Exception
```
    例外:
    java.lang.Exception
  - resolveConfiguration
```
protected org.apache.hadoop.conf.Configuration resolveConfiguration()
                                                             throws java.lang.Exception
```
    例外:
    java.lang.Exception
  - resolveTargetClass
```
protected java.lang.Class<T> resolveTargetClass(org.apache.hadoop.conf.Configuration cfg)
                                         throws java.lang.Exception
```
    例外:
    java.lang.Exception
  - resolveTargetObject
```
protected T resolveTargetObject(java.lang.Class<T> type)
```
  - createClassLoaderForJar
```
protected java.lang.ClassLoader createClassLoaderForJar(org.springframework.core.io.Resource jar,
                                            java.lang.ClassLoader parentCL,
                                            org.apache.hadoop.conf.Configuration cfg)
```
  - preExecution
```
protected void preExecution(org.apache.hadoop.conf.Configuration cfg)
```
  - postExecution
```
protected void postExecution(org.apache.hadoop.conf.Configuration cfg)
```
  - setJar
```
public void setJar(org.springframework.core.io.Resource jar)
```
    ターゲットコードを jar に設定します。
    パラメーター:
    jar - ターゲット jar
  - setArguments
```
public void setArguments(java.lang.String... arguments)
```
    引数を設定します。
    パラメーター:
    arguments - 設定する引数。
  - setConfiguration
```
public void setConfiguration(org.apache.hadoop.conf.Configuration configuration)
```
    構成を設定します。
    パラメーター:
    configuration - 設定する構成。
  - setProperties
```
public void setProperties(java.util.Properties properties)
```
    プロパティを設定します。
    パラメーター:
    properties - 設定するプロパティ。
  - setBeanClassLoader
```
public void setBeanClassLoader(java.lang.ClassLoader classLoader)
```
    次で指定:
    インターフェース org.springframework.beans.factory.BeanClassLoaderAware の setBeanClassLoader
  - setCloseFs
```
public void setCloseFs(boolean closeFs)
```
    カスタムコードの実行によって生成された Hadoop ファイルシステムを閉じるかどうかを示します。デフォルトは true です。コードがアプリケーションの他の部分で使用されているのと同じファイルシステムを再利用する場合は、これを false に設定します。
    パラメーター:
    closeFs - 新しいクローズ FS
  - setLibs
```
public void setLibs(org.springframework.core.io.Resource... libJars)
```
    クラスパスに含める jar ファイルを設定します。パターン (例: mydir/*.jar) を使用できることに注意してください。これは、Spring コンテナーによって自動的に解決されます。
    パラメーター:
    libJars - クラスパスに含める jar ファイル。
  - setFiles
```
public void setFiles(org.springframework.core.io.Resource... files)
```
    マップリデュースクラスターにコピーするファイルを設定します。パターン (例: mydir/*.txt) を使用できることに注意してください。これは、Spring コンテナーによって自動的に解決されます。
    パラメーター:
    files - コピーするファイル。
  - setArchives
```
public void setArchives(org.springframework.core.io.Resource... archives)
```
    アーカイブをマップリデュースクラスターにアーカイブ解除するように設定します。パターン (例: mydir/*.zip) を使用できることに注意してください。これは、Spring コンテナーによって自動的に解決されます。
    パラメーター:
    archives - コンピューティングマシン上でアーカイブ解除するアーカイブ。
  - setUser
```
public void setUser(java.lang.String user)
```
    このジョブを実行するためのユーザー偽装 (オプション) を設定します。Hadoop Kerberos クラスターに対して実行する場合に使用する必要があります。
    パラメーター:
    user - ユーザー / グループ情報

クラス ToolRunner

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.data.hadoop.mapreduce.ToolExecutor から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

ToolRunner

メソッドの詳細

call

afterPropertiesSet

setRunAtStartup

setPreAction

setPostAction

runCode

resolveConfiguration

resolveTargetClass

resolveTargetObject

createClassLoaderForJar

preExecution

postExecution

setJar

setArguments

setConfiguration

setProperties

setBeanClassLoader

setCloseFs

setLibs

setFiles

setArchives

setUser