概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## okuyama.base.job
クラス AbstractHelper

    java.lang.Object
      okuyama.base.job.AbstractHelper

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

直系の既知のサブクラス:
  AbstractMasterManagerHelper, HttpGatewayServerHelper, KeyManagerAcceptHelper, KeyManagerConnectHelper, KeyManagerHelper, QueueClientPutTestHelper, QueueClientTakeTestHelper, ServerTimerHelper, TransactionManagerHelper

    public abstract class AbstractHelper

extends java.lang.Object
implements java.lang.Runnable

JobHelperの基底クラス.

作成者:
  T.Okuyama

フィールドの概要
`static java.lang.String` | `END`
`static java.lang.String` | `ERR`
`protected static java.lang.String` | `ERROR`
`protected HelperConfigMap` | `helperConfigMap`
`protected static java.util.concurrent.ConcurrentHashMap` | `helperParamShareMap` Helper同士で値やり取りを行う領域.
`static java.lang.String` | `RUN`
`protected java.lang.String` | `status`
`protected static java.lang.String` | `SUCCESS`
`static java.lang.String` | `WAIT`

コンストラクタの概要
`AbstractHelper()` コンストラクタ

メソッドの概要
`void` | `addParameterQueue(java.lang.Object[] params)` Helper用のパラメータQueueに追加
`void` | `addSmallSizeParameterQueue(java.lang.String[] helperNames, java.lang.Object[] params)` 最もサイズの小さいQueueに追加する
`void` | `addSpecificationParameterQueue(java.lang.String helperName, java.lang.Object[] params)` Helper用のパラメータQueueに追加
`void` | `addSpecificationParameterQueue(java.lang.String helperName, java.lang.Object[] params, boolean debug)` Helper用のパラメータQueueに追加
`abstract void` | `endHelper()` endHelper.
`abstract java.lang.String` | `executeHelper(java.lang.String optionParam)` executeHelper.
`HelperConfigMap` | `getConfig()` 自身の設定情報を返す
`java.lang.Object` | `getHelperShareParam(java.lang.Object key)` Helper間で共有する値を取得する.
`java.lang.String` | `getName()`
`int` | `getParameterQueueSize(java.lang.String helperName)` Queueの現在のサイズを返す
`java.lang.Object[]` | `getParameters()` Helper用のパラメータ取得.
`protected java.lang.String` | `getPropertiesValue(java.lang.String key)` Job設定ファイルの自由に設定出来る値を取得する.
`boolean` | `getReboot()`
`java.lang.Object` | `getReturnParameter()` Helperが終了した際に外部に伝播したいパラメータを取得.
`java.lang.String` | `getStatus()` 自身のステータスを返す.
`boolean` | `getThreadEnd()`
`int` | `getUseCount()`
`abstract void` | `initHelper(java.lang.String initValue)` initHelper.
`void` | `initialize()` 初期化メソッド.
`protected boolean` | `isJobFileChange()` Job設定ファイルの変更をチェック.
`java.lang.Object[]` | `pollParameterQueue()` Helper用のパラメータQueueから取得
`java.lang.Object[]` | `pollSpecificationParameterQueue(java.lang.String helperName)` Helper用のパラメータQueueから取得
`protected void` | `reloadJobFileParameter(java.lang.String[] keys)` Job設定ファイルの指定のキー値を再読み込みする.
`java.lang.Object` | `removeHelperShareParam(java.lang.Object key)` Helper間で共有する値を削除する.
`void` | `run()` メイン実行部分.
`void` | `setConfig(HelperConfigMap helperConfigMap)` 自身の設定情報格納
`void` | `setHelperShareParam(java.lang.Object key, java.lang.Object val)` Helper間で共有する値をセットする.
`void` | `setName(java.lang.String name)`
`void` | `setParameters(java.lang.Object[] parameters)` Helper用のパラメータ設定.
`void` | `setReboot(boolean reboot)`
`void` | `setReturnParameter(java.lang.Object value)` Helperが終了した際に外部に伝播したいパラメータをセット.
`int` | `sizeHelperShareParam()` Helper間で共有する値の現在の総数を返す.

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

フィールドの詳細

### WAIT

    public static java.lang.String WAIT

### RUN

    public static java.lang.String RUN

### ERR

    public static java.lang.String ERR

### END

    public static java.lang.String END

### SUCCESS

    protected static java.lang.String SUCCESS

### ERROR

    protected static java.lang.String ERROR

### status

    protected java.lang.String status

### helperConfigMap

    protected HelperConfigMap helperConfigMap

### helperParamShareMap

    protected static java.util.concurrent.ConcurrentHashMap helperParamShareMap

  Helper同士で値やり取りを行う領域.
  一度登録した値はHelperが終了するまで維持される.

コンストラクタの詳細

### AbstractHelper

    public AbstractHelper()

  コンストラクタ

メソッドの詳細

### getParameterQueueSize

    public int getParameterQueueSize(java.lang.String helperName)
                              throws java.lang.Exception

  Queueの現在のサイズを返す

  パラメータ:
    `params` - パラメータ
  戻り値:
    int
  例外:
    `java.lang.Exception`

### addSmallSizeParameterQueue

    public void addSmallSizeParameterQueue(java.lang.String[] helperNames,
                                           java.lang.Object[] params)
                                    throws java.lang.Exception

  最もサイズの小さいQueueに追加する

  パラメータ:
    `params` - パラメータ
  例外:
    `java.lang.Exception`

### addSpecificationParameterQueue

    public void addSpecificationParameterQueue(java.lang.String helperName,
                                               java.lang.Object[] params)
                                        throws java.lang.Exception

  Helper用のパラメータQueueに追加

  パラメータ:
    `params` - パラメータ
  例外:
    `java.lang.Exception`

### addSpecificationParameterQueue

    public void addSpecificationParameterQueue(java.lang.String helperName,
                                               java.lang.Object[] params,
                                               boolean debug)
                                        throws java.lang.Exception

  Helper用のパラメータQueueに追加

  パラメータ:
    `params` - パラメータ
  例外:
    `java.lang.Exception`

### addParameterQueue

    public void addParameterQueue(java.lang.Object[] params)
                           throws java.lang.Exception

  Helper用のパラメータQueueに追加

  パラメータ:
    `params` - パラメータ
  例外:
    `java.lang.Exception`

### pollSpecificationParameterQueue

    public java.lang.Object[] pollSpecificationParameterQueue(java.lang.String helperName)

  Helper用のパラメータQueueから取得

  戻り値:
    Object[] パラメータ

### pollParameterQueue

    public java.lang.Object[] pollParameterQueue()

  Helper用のパラメータQueueから取得

  戻り値:
    Object[] パラメータ

### initialize

    public void initialize()

  初期化メソッド.

### setConfig

    public void setConfig(HelperConfigMap helperConfigMap)

  自身の設定情報格納

  パラメータ:
    `helperConfigMap` - Job設定情報

### getConfig

    public HelperConfigMap getConfig()

  自身の設定情報を返す

  戻り値:
    HelperConfigMap Job設定情報

### initHelper

    public abstract void initHelper(java.lang.String initValue)

  initHelper.
  ユーザHelper実装部分.

  パラメータ:
    `initValue` -

### executeHelper

    public abstract java.lang.String executeHelper(java.lang.String optionParam)
                                            throws BatchException

  executeHelper.
  ユーザHelper実装部分.

  パラメータ:
    `optionParam` -
  戻り値:
    String 実行結果
  例外:
    `BatchException`

### endHelper

    public abstract void endHelper()

  endHelper.
  ユーザHelper終了処理部分.

### run

    public void run()

  メイン実行部分.
  自身のサブクラスを実行.
  実行順序はinitHelper - executeHelper.

  定義:
    インタフェース `java.lang.Runnable` 内の `run`

### getStatus

    public java.lang.String getStatus()

  自身のステータスを返す.

  戻り値:
    String ステータス文字列

### getPropertiesValue

    protected java.lang.String getPropertiesValue(java.lang.String key)

  Job設定ファイルの自由に設定出来る値を取得する.
  設定情報が存在しない場合はnullを返す.

  パラメータ:
    `key` - 設定情報のキー名
  戻り値:
    String ユーザ設定パラメータ

### isJobFileChange

    protected boolean isJobFileChange()
                               throws BatchException

  Job設定ファイルの変更をチェック.

  戻り値:
    boolean 変更有無
  例外:
    `BatchException`

### reloadJobFileParameter

    protected void reloadJobFileParameter(java.lang.String[] keys)
                                   throws BatchException

  Job設定ファイルの指定のキー値を再読み込みする.

  パラメータ:
    `String[]` - キー値
  例外:
    `BatchException`

### setHelperShareParam

    public void setHelperShareParam(java.lang.Object key,
                                    java.lang.Object val)

  Helper間で共有する値をセットする.

  パラメータ:
    `key` - キー値
    `val` - 値

### getHelperShareParam

    public java.lang.Object getHelperShareParam(java.lang.Object key)

  Helper間で共有する値を取得する.
  存在しない場合はNullを返す.

  パラメータ:
    `key` - キー値
  戻り値:
    Object 値

### removeHelperShareParam

    public java.lang.Object removeHelperShareParam(java.lang.Object key)

  Helper間で共有する値を削除する.

  パラメータ:
    `key` - キー値
  戻り値:
    Objet 値

### sizeHelperShareParam

    public int sizeHelperShareParam()

  Helper間で共有する値の現在の総数を返す.

  戻り値:
    int 値

### setParameters

    public void setParameters(java.lang.Object[] parameters)

  Helper用のパラメータ設定.

  パラメータ:
    `parameters` - パラメータ値

### getParameters

    public java.lang.Object[] getParameters()

  Helper用のパラメータ取得.

  戻り値:
    Object[] パラメータ値

### setReturnParameter

    public void setReturnParameter(java.lang.Object value)

  Helperが終了した際に外部に伝播したいパラメータをセット.

  パラメータ:
    `Object` - パラメータ値

### getReturnParameter

    public java.lang.Object getReturnParameter()

  Helperが終了した際に外部に伝播したいパラメータを取得.

  戻り値:
    Object パラメータ値

### getUseCount

    public int getUseCount()

### setReboot

    public void setReboot(boolean reboot)

### getReboot

    public boolean getReboot()

### setName

    public void setName(java.lang.String name)

### getName

    public java.lang.String getName()

### getThreadEnd

    public boolean getThreadEnd()

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド