public abstract class AbstractGenericJob extends Object implements jp.co.intra_mart.foundation.job_scheduler.Job
汎用ジョブ抽象のクラスです。
isCompanyProcess()
の返却結果により、次の2つのモード別処理を行います。
本クラス(AbstractGenericJob )で追加指定可能なパラメータ | |||
---|---|---|---|
キー | 値 | 設定 | 省略時 |
error_skip | 会社別処理エラー時の後続処理スキップ | 任意 | スキップしない(false) |
lock_wait | ロック待ち時間 | 任意 | 10(秒) |
company_group_set_cd | 会社グループセットコード | 任意 | 会社グループの絞り込みを行わない |
company_group_cd | 会社グループコード | 任意 | 会社グループの絞り込みを行わない |
company_cd | 会社コード(カンマ区切りで複数指定可) | 任意 | 会社の絞り込みを行わない |
conductor | ジョブの各処理間で実行されるコンダクター(カンマ区切りで複数指定可)AbstractGenericJobConductor を継承したクラスのコンポーネント名を指定してください。 |
任意 | コンダクターを使用しない |
修飾子とタイプ | クラスと説明 |
---|---|
static class |
AbstractGenericJob.FileProcessType
ファイル処理タイプ.
|
class |
AbstractGenericJob.IllegalJobParametersException
IllegalJobParametersException.
|
class |
AbstractGenericJob.ProcessFile
ファイル処理.
|
修飾子とタイプ | フィールドと説明 |
---|---|
protected ContextHelper |
contextHelper
ContextHelper.
|
protected DateHelper |
dateHelper
DateHelper.
|
protected DateValidator |
dateValidator
DateValidator.
|
protected FormatHelper |
formatHelper
FormatHelper.
|
protected IdentifierHelper |
identifierHelper
IdentifierHelper.
|
static String |
JOBPARAM_COMPANY_CD
ジョブパラメータキー:会社コード(company_cd).
|
static String |
JOBPARAM_COMPANY_GROUP_CD
ジョブパラメータキー:会社グループコード(company_group_cd).
|
static String |
JOBPARAM_COMPANY_GROUP_SET_CD
ジョブパラメータキー:会社グループセットコード(company_group_set_cd).
|
static String |
JOBPARAM_CONDUCTOR
ジョブパラメータキー:ジョブの各処理間で実行されるコンダクター(conductor).
|
static String |
JOBPARAM_ERROR_SKIP
ジョブパラメータキー:後続処理スキップ(error_skip).
|
static String |
JOBPARAM_JOB_ID
ジョブパラメータキー:ジョブID(jobId).
|
static String |
JOBPARAM_JOB_NAME
ジョブパラメータキー:ジョブ名(jobName).
|
static String |
JOBPARAM_JOB_NET_ID
ジョブパラメータキー:ジョブネットID(jobNetId).
|
static String |
JOBPARAM_JOB_NET_NAME
ジョブパラメータキー:ジョブネット名(jobNetName).
|
static String |
JOBPARAM_LOCK_WAIT
ジョブパラメータキー:ロック待ち時間(lock_wait).
|
static String |
JOBPARAM_MONITOR_ID
ジョブパラメータキー:モニタID(monitorId).
|
static String |
JOBPARAM_OUTPUT_LOG
ジョブパラメータキー:ログ出力有無(outputLog).
|
static String |
JOBPARAM_PROCESS_COMPANY
ジョブパラメータキー:ジョブ名(processCompany).
|
static String |
JOBPARAM_PROCESS_DATE
ジョブパラメータキー:ジョブ名(processDate).
|
static String |
JOBPARAM_TASK_ID
ジョブパラメータキー:タスクID(taskId).
|
static String |
JOBPARAM_TENANT_ID
ジョブパラメータキー:テナントID(tenantId).
|
List<GenericJobResult> |
jobResultList
処理結果格納用のリスト.
|
protected LocaleValidator |
localeValidator
LocaleValidator.
|
protected Map<String,String> |
parameters
ジョブパラメータ.
|
protected String |
processCompany
会社コード.
|
protected Timestamp |
processDate
検索基準日.
|
List<AbstractGenericJob.ProcessFile> |
processFiles
処理ファイルのリスト.
|
protected PropertyHelper |
propertyHelper
PropertyHelper.
|
protected GenericJobResult |
result
処理結果.
|
protected SystemLocaleHelper |
systemLocaleHelper
SystemLocaleHelper.
|
protected TransactionHelper |
transactionHelper
TransactionHelper.
|
protected XmlOutputHelper |
xmlOutputHelper
XmlOutputHelper.
|
コンストラクタと説明 |
---|
AbstractGenericJob()
コンストラクタ.
|
AbstractGenericJob(Map<String,String> parameters)
コンストラクタ.
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected void |
addArchiveFile(String frPath,
String toPath)
アーカイブしたファイルを追加.
|
protected void |
addDeleteFile(String path)
削除したファイルを追加.
|
protected void |
addReadFile(String path)
読み込んだファイルを追加.
|
protected void |
addWriteFile(String path)
書き込んだファイルを追加.
|
jp.co.intra_mart.foundation.job_scheduler.JobResult |
execute()
ジョブ実行時に起動されるメソッド.
|
protected List<String> |
getCompanyCdList()
処理対象会社のコードリストを返却.
|
protected List<AbstractGenericJobConductor> |
getConductor()
AbstractGenericJobConductor を継承したコンダクターのリストを返却. |
protected String |
getEndMessage()
ジョブ終了時メッセージを返却.
|
protected jp.co.intra_mart.foundation.job_scheduler.JobResult |
getJobResult()
ジョブの結果を返却します。
|
protected String |
getLockKey()
ロックキーを返却.
|
protected Long |
getLockWait()
ロック待機時間を返却.
|
protected String |
getMessage(String key,
Object... args)
プロパティからメッセージを返却.
|
protected String |
getParameter(String key)
文字列パラメータを返却.
|
protected Map<String,String> |
getParameters()
パラメータを返却.
|
protected KaidenJobProcessType |
getProcessType()
ジョブスケジューラーの処理種類を返却.
|
protected String |
getStartMessage()
ジョブ開始時メッセージを返却.
|
protected String |
getSurface(String key,
Object... args)
プロパティからラベルを返却.
|
protected void |
initializeJobResult()
ジョブ処理結果の初期化.
|
protected boolean |
isCompanyProcess()
会社別処理の利用有無を返却.
|
protected boolean |
isOutputLog()
ログ出力有無を返却.
|
protected void |
outputJobProcessResult(GenericJobResult jobProcessResult)
処理結果XMLを出力.
|
protected void |
postExecute()
ジョブ全体の後処理.
|
protected void |
postProcess()
後処理.
|
protected void |
preExecute()
ジョブ全体の前処理.
|
protected void |
preProcess()
前処理.
|
protected void |
process()
本処理.
|
protected String |
replace(String target)
文字列変換.
|
protected GenericJobResult |
run()
処理実行.
|
protected void |
validateParameters()
パラメータバリデート.
|
protected PropertyHelper propertyHelper
protected ContextHelper contextHelper
protected SystemLocaleHelper systemLocaleHelper
protected DateHelper dateHelper
protected IdentifierHelper identifierHelper
protected XmlOutputHelper xmlOutputHelper
protected FormatHelper formatHelper
protected DateValidator dateValidator
protected LocaleValidator localeValidator
public static final String JOBPARAM_ERROR_SKIP
public static final String JOBPARAM_LOCK_WAIT
public static final String JOBPARAM_COMPANY_GROUP_SET_CD
public static final String JOBPARAM_COMPANY_GROUP_CD
public static final String JOBPARAM_COMPANY_CD
public static final String JOBPARAM_CONDUCTOR
public static final String JOBPARAM_TENANT_ID
public static final String JOBPARAM_MONITOR_ID
public static final String JOBPARAM_TASK_ID
public static final String JOBPARAM_JOB_NET_ID
public static final String JOBPARAM_JOB_NET_NAME
public static final String JOBPARAM_JOB_NAME
public static final String JOBPARAM_PROCESS_DATE
public static final String JOBPARAM_PROCESS_COMPANY
public static final String JOBPARAM_OUTPUT_LOG
protected Timestamp processDate
protected String processCompany
public List<GenericJobResult> jobResultList
public List<AbstractGenericJob.ProcessFile> processFiles
protected TransactionHelper transactionHelper
protected GenericJobResult result
protected void validateParameters() throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
ジョブパラメータなどで必須の場合は本メソッドでバリデートを実施してください。
本メソッドでバリデートエラーとなった内容はジョブネットモニターに表示され、ログファイルに出力されません。
jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
- JobExecuteException
protected boolean isCompanyProcess()
未継承の場合は、「false(会社別処理を利用しない)」を返却します。
public jp.co.intra_mart.foundation.job_scheduler.JobResult execute() throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
本メソッドでは、テナント全体/会社別処理の分岐やトランザクション制御、処理後の結果XML出力を行います。
execute
インタフェース内 jp.co.intra_mart.foundation.job_scheduler.Job
jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
- ジョブの実行に失敗protected void preExecute() throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
- JobExecuteException
protected void postExecute() throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
- JobExecuteException
protected jp.co.intra_mart.foundation.job_scheduler.JobResult getJobResult()
protected void outputJobProcessResult(GenericJobResult jobProcessResult) throws KaidenSystemException
jobProcessResult
- 処理結果KaidenSystemException
- システムエラー@Transactional(rollbackFor=java.lang.Exception.class) protected GenericJobResult run()
@Transactional(rollbackFor=java.lang.Exception.class) protected void preProcess() throws KaidenSystemException, KaidenApplicationException
@Transactional(rollbackFor=java.lang.Exception.class) protected void process() throws KaidenSystemException, KaidenApplicationException
@Transactional(rollbackFor=java.lang.Exception.class) protected void postProcess() throws KaidenSystemException, KaidenApplicationException
protected void initializeJobResult()
処理結果用DTOに、次のパラメータを設定します。
protected KaidenJobProcessType getProcessType()
protected String getStartMessage()
protected String getEndMessage()
protected String getLockKey()
protected Long getLockWait()
protected boolean isOutputLog()
protected String getMessage(String key, Object... args)
key
- キーargs
- 置換文字列の配列protected String getSurface(String key, Object... args)
key
- キーargs
- 置換文字列の配列protected String getParameter(String key)
パラメータが文字列以外の場合はnullを返却します。
key
- パラメータ取得用のキーprotected List<AbstractGenericJobConductor> getConductor()
AbstractGenericJobConductor
を継承したコンダクターのリストを返却.AbstractGenericJobConductor
を継承したコンダクターのリストprotected String replace(String target)
次の文字列を変換します。
変換対象 | 変換内容 | 補足 |
---|---|---|
{COMPANY_CD} | 会社コード | 会社別処理ではない場合は変換しません。 |
{YMD} | ジョブの実行日 | 「yyyyMMdd」形式 |
{YMDHMSN} | ジョブの実行日 | 「yyyyMMddHHmmssSSS」形式 |
{JOB_NET_ID} | ジョブネットID | ジョブネットIDが設定されていない場合は変換しません。 |
{JOB_NET_NAME} | ジョブネット名 | ジョブネット名が設定されていない場合は変換しません。 |
{JOB_ID} | ジョブID | ジョブIDが設定されていない場合は変換しません。 |
{JOB_NAME} | ジョブ名 | ジョブ名が設定されていない場合は変換しません。 |
target
- 変換対象の文字列protected void addReadFile(String path)
path
- 読み込んだファイルのパスprotected void addWriteFile(String path)
path
- 書き込んだファイルのパスprotected void addArchiveFile(String frPath, String toPath)
frPath
- アーカイブ元ファイルパスtoPath
- アーカイブ先ファイルパスprotected void addDeleteFile(String path)
path
- 削除を実行したファイルのパスCopyright © 2024 Sumitomo Life Information Systems Co., Ltd. All Rights Reserved.