jp.co.intra_mart.foundation.job_scheduler

クラス BaseJob

java.lang.Object

jp.co.intra_mart.foundation.job_scheduler.BaseJob

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

Job

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

AuthzExportJob, AuthzImportJob, BaseCrawlingJob, IMBoxAllCrawlingJob, OptimizeJob

public abstract class BaseJob
extends Object
implements Job

ジョブスケジューラサービスから実行されるジョブ実装のための基底クラスです。
JobSchedulerContextからパラメータを取得するためのユーティリティメソッドが用意されています。

バージョン:

8.0

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected boolean	canParseToBoolean(String value) 与えられた文字列がbooleanに変換可能か判別します。
abstract JobResult	execute() ジョブの実行処理を行います。
protected JobSchedulerContext	getJobContext() ジョブコンテキストを取得します。
protected String	getParameter(String key) 与えられたキーでJobSchedulerContextから取得したパラメータを返します。
protected String	getParameter(String key, String defaultValue) 与えられたキーでJobSchedulerContextから取得したパラメータをintに変換して返します。
protected boolean	getParameterAsBoolean(String key) 与えられたキーでJobSchedulerContextから取得したパラメータをbooleanに変換して返します。
protected boolean	getParameterAsBoolean(String key, boolean defaultValue) 与えられたキーでJobSchedulerContextから取得したパラメータをbooleanに変換して返します。
protected int	getParameterAsInteger(String key) 与えられたキーでJobSchedulerContextから取得したパラメータをintに変換して返します。
protected int	getParameterAsInteger(String key, int defaultValue) 与えられたキーでJobSchedulerContextから取得したパラメータをintに変換して返します。

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

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

コンストラクタの詳細

BaseJob

public BaseJob()

メソッドの詳細

execute

public abstract JobResult execute()
                           throws JobExecuteException

ジョブの実行処理を行います。

定義:

execute インタフェース内 Job

戻り値:

この実行処理の結果を返却します。null値が返却された場合は、正常終了として扱います。

例外:

JobExecuteException - ジョブ実行中に例外がスローされた場合、 実行処理の結果がエラーとして扱います。メッセージにはスローされた例外のローカライズメッセージが使用されます。

関連項目:

Job.execute()

getJobContext

protected JobSchedulerContext getJobContext()

ジョブコンテキストを取得します。

戻り値:

ジョブコンテキスト

getParameter

protected String getParameter(String key)
                       throws InvalidParameterException

与えられたキーでJobSchedulerContextから取得したパラメータを返します。

パラメータ:

key - キー

戻り値:

パラメータ

例外:

InvalidParameterException - 取得したパラメータがnullだった場合

getParameter

protected String getParameter(String key,
                              String defaultValue)

与えられたキーでJobSchedulerContextから取得したパラメータをintに変換して返します。
パラメータ取得が取得出来なかった場合は、デフォルト値を返します。

パラメータ:

key - キー

defaultValue - デフォルト値

戻り値:

パラメータ

getParameterAsInteger

protected int getParameterAsInteger(String key)
                             throws InvalidParameterException

与えられたキーでJobSchedulerContextから取得したパラメータをintに変換して返します。

パラメータ:

key - キー

戻り値:

intに変換されたパラメータ

例外:

InvalidParameterException - 取得したパラメータがnullもしくはintとして不正な値だった場合

getParameterAsInteger

protected int getParameterAsInteger(String key,
                                    int defaultValue)

与えられたキーでJobSchedulerContextから取得したパラメータをintに変換して返します。
パラメータ取得が取得出来なかった場合およびintに変換出来なかった場合は、デフォルト値を返します。

パラメータ:

key - キー

defaultValue - デフォルト値

戻り値:

intに変換されたパラメータ

getParameterAsBoolean

protected boolean getParameterAsBoolean(String key)
                                 throws InvalidParameterException

与えられたキーでJobSchedulerContextから取得したパラメータをbooleanに変換して返します。 変換時に大文字、小文字は区別しません。次のいずれの値もtrueとして変換されます。

パラメータ:

key - キー

戻り値:

booleanに変換されたパラメータ

例外:

InvalidParameterException - 取得したパラメータがnullもしくはbooleanとして不正な値だった場合

getParameterAsBoolean

protected boolean getParameterAsBoolean(String key,
                                        boolean defaultValue)

与えられたキーでJobSchedulerContextから取得したパラメータをbooleanに変換して返します。
変換時に大文字、小文字は区別しません。次のいずれの値もtrueとして変換されます。
パラメータ取得が取得出来なかった場合およびbooleanに変換出来なかった場合は、デフォルト値を返します。
tRue, TRUE, TruE, tRuE

パラメータ:

key - キー

defaultValue - デフォルト値

戻り値:

booleanに変換されたパラメータ

canParseToBoolean

protected boolean canParseToBoolean(String value)

与えられた文字列がbooleanに変換可能か判別します。

パラメータ:

value - チェックする文字列

戻り値:

変換可能な場合 true, 変換不可能な場合 false