nablarch.fw.launcher

クラス Main

java.lang.Object

nablarch.fw.HandlerQueueManager<Main>

nablarch.fw.launcher.Main

すべての実装されたインタフェース:

Handler<CommandLine,java.lang.Integer>

直系の既知のサブクラス:

MainForRequestTesting

public class Main
extends HandlerQueueManager<Main>
implements Handler<CommandLine,java.lang.Integer>

本フレームワークの起動シーケンスの起点となるクラス。

本クラスをjavaコマンドから直接起動することで、以下の処理を行う。

 1. コマンドライン引数のパース。
 2. コンポーネント設定ファイル（xml)の読み込みとハンドラー構成の初期化
 3. ハンドラーキューに対する後続処理の委譲。
 4. 終了/エラー処理。
    (結果コードはハンドラキューの戻り値、または送出された例外をもとに設定する。)
 

以下は、本クラスの使用例である。 (起動オプションに設定した値は、CommandLineオブジェクトから取得できる。)

起動コマンドの例

 java                                                 \
     -server                                          \
     -Xmx128m                                         \
     -Dsample=100                                     \
 nablarch.fw.launcher.Main                            \
     -diConfig    file:./batch-config.xml             \
     -requestPath admin.DataUnloadBatchAction/BC0012  \
     -userId      testUser                            \
     -namedParam  value                               \
     value1
 

起動コマンドの説明

 アプリケーション引数（JVMへの設定である起動コマンドの説明は行わない）

           -Dsample      コンポーネント設定ファイル中の埋め込みパラメータの値。例では、${sample}に100が設定される。

 Mainクラスへの引数

   (必須)  -diConfig     コンポーネント設定ファイルのファイルパス。クラスパス配下のxmlファイルを指定。
   (必須)  -requestPath  実行対象のアクションハンドラクラス名/リクエストIDを指定。
   (必須)  -userId       プロセスの実行権限ユーザID。セッション変数とスレッドコンテキストに保持される。
           -namedParam   名前付きパラメータ。CommandLineに使用される属性値を指定。
           value1        無名パラメータ。CommandLineに使用される属性値を指定。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Main()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static int	execute(CommandLine commandLine) バッチを実行する。
java.util.List<Handler>	getHandlerQueue() 現在のハンドラキューの内容を返す。
java.lang.Integer	handle(CommandLine commandLine, ExecutionContext context) 入力データに対する処理を実行する。
protected void	initializeLog() 各種ログの初期化を行う。
static void	main(java.lang.String... args) メインメソッド。
protected Main	setupExecutionContext(CommandLine commandLine, ExecutionContext context) バッチコントローラ起動前準備を行う。
protected void	setUpSystemRepository(java.lang.String configFilePath) コンポーネント設定ファイルの設定にしたがって、システムリポジトリの初期化を行う。

クラスから継承されたメソッド nablarch.fw.HandlerQueueManager

addHandler, addHandler, addHandler, addHandler, addHandler, addHandlers, clearHandlers, getHandlerOf, getMethodBinder, setHandlerQueue, setMethodBinder

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

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

コンストラクタの詳細

Main

public Main()

メソッドの詳細

getHandlerQueue

public java.util.List<Handler> getHandlerQueue()

クラスからコピーされた説明: HandlerQueueManager

現在のハンドラキューの内容を返す。

定義:

getHandlerQueue クラス内 HandlerQueueManager<Main>

戻り値:

現在のハンドラキューの内容

main

public static void main(java.lang.String... args)

メインメソッド。

本メソッドでは、以下の内容をログ出力する。

• 起動時
起動オプションや、起動引数(詳細は、LauncherLogUtil.getStartLogMsg(CommandLine)を参照)
• 終了時
終了コードや処理時間(詳細は、LauncherLogUtil.getEndLogMsg(int, long)を参照})

及び処理終了時

パラメータ:

args - コマンドライン引数

handle

public java.lang.Integer handle(CommandLine commandLine,
                                ExecutionContext context)

入力データに対する処理を実行する。 この実装では、ハンドラキューに後続処理を委譲し、その処理結果から このプロセスの終了コードを算出して返す。

定義:

handle インタフェース内 Handler<CommandLine,java.lang.Integer>

パラメータ:

commandLine - 入力データ

context - 実行コンテキスト

戻り値:

処理結果データ

execute

@Published(tag="architect")
public static int execute(CommandLine commandLine)

バッチを実行する。

handle(CommandLine, ExecutionContext)に処理を委譲して結果を返す。

パラメータ:

commandLine - 起動オプション

戻り値:

終了コード

setupExecutionContext

protected Main setupExecutionContext(CommandLine commandLine,
                                     ExecutionContext context)

バッチコントローラ起動前準備を行う。
実行コンテキストを生成し、以下の処理を行う。

• コンポーネント設定ファイルに定義したハンドラキューの設定
• DataReaderの設定
• DataReaderFactoryの設定
• ディスパッチハンドラの設定
• セッションスコープにプロセスの実行権限ユーザIDと、起動オプションのマップを設定

パラメータ:

commandLine - 起動オプション

context - 実行コンテキスト

戻り値:

初期化されたコントローラ

setUpSystemRepository

protected void setUpSystemRepository(java.lang.String configFilePath)

コンポーネント設定ファイルの設定にしたがって、システムリポジトリの初期化を行う。

パラメータ:

configFilePath - コンポーネント設定ファイルのパス

initializeLog

protected void initializeLog()

各種ログの初期化を行う。