D
- 伝搬機能から受け取るデータのクラスタイプR
- 伝搬機能へ返却する処理結果のクラスタイプ。 特に返却する値がない場合は EmptyObject
クラスを使用するpublic abstract class AbstractSessionableProcedure<D,R extends Serializable> extends Object implements Procedure<D,R>
AbstractProcedure
クラスを継承することができます。D
には、マッピング設定でペアとなっている Decoder
(データ変換クラス) の型パラメータ
D
と同じクラスタイプを指定してください。R
に指定するクラスタイプは、データ送信側が送信するデータのクラスと OperationType
(データ操作の種別) に依存します。制約
がありますのでご注意ください。null
を返却する場合や、このデータ処理クラスにおいて特に処理結果を返却しない場合は、
EmptyObject
を指定できます。Procedure
コンストラクタと説明 |
---|
AbstractSessionableProcedure() |
修飾子とタイプ | メソッドと説明 |
---|---|
protected void |
checkInSession(ReceiveParameter parameter)
現在のセッションが有効かどうかを判定します。
|
protected Set<String> |
getParamKeys()
このクラスに設定された独自パラメータのキーを全て取得します。
|
protected String |
getParamValue(String key)
このクラスに設定された独自パラメータのキーに割り当てられた値を 1 つ取得します。
|
protected List<String> |
getParamValues(String key)
このクラスに設定された独自パラメータのキーに割り当てられた値を全て取得します。
|
abstract AbortResult |
onAbort(AbortParameter parameter)
伝搬機能でセッションが中断されたときに呼び出されるイベントです。
|
abstract DecideResult |
onDecide(DecideParameter parameter)
伝搬機能でセッションが確定されたときに呼び出されるイベントです。
|
abstract InitializeResult |
onInitialize(InitializeParameter parameter)
伝搬機能でセッションが開始されたときに呼び出されるイベントです。
|
abstract PrepareResult |
onPrepare(PrepareParameter parameter)
伝搬機能でセッションの確定準備を要求されたときに呼び出されるイベントです。
|
abstract ReceiveResult<R> |
onReceive(ReceiveParameter parameter,
D data)
伝搬機能からデータを受け取ったときに呼び出されるイベントです。
|
void |
setParamValuesMap(Map<String,List<String>> map)
伝搬機能からこのクラスに設定された独自パラメータのマップを受け取ります。
|
public abstract AbortResult onAbort(AbortParameter parameter) throws ProcedureException
onInitialize
メソッドが呼び出された時点から行われたデータの変更を破棄してください。SUCCEEDED
、失敗した場合は
FAILED
を返却してください。ProcedureException
例外をスローした場合は、 FAILED
を返却した場合と同じ効果です。ProcedureException
クラスを継承した例外クラスをスローしてください。ProcedureException
例外をスローしてください。onAbort
インタフェース内 Procedure<D,R extends Serializable>
parameter
- イベントのパラメータProcedureException
- イベント処理中に例外が発生した場合EventStatus
,
Procedure.onAbort(AbortParameter)
public abstract DecideResult onDecide(DecideParameter parameter) throws ProcedureException, PropagationManagerException
onPrepare
メソッドが呼び出された時点で変更されたデータを確定して、本更新をかけてください。SUCCEEDED
、失敗した場合は
FAILED
を返却してください。ProcedureException
例外をスローした場合は、 FAILED
を返却した場合と同じ効果です。ProcedureException
クラスを継承した例外クラスをスローしてください。ProcedureException
例外をスローしてください。PropagationManagerException
例外と、これを継承した例外クラスは、伝搬機能で使用される例外クラスのため、明示的にスローしないてください。onDecide
インタフェース内 Procedure<D,R extends Serializable>
parameter
- イベントのパラメータProcedureException
- イベント処理中に例外が発生した場合PropagationManagerException
- 伝搬機能の処理中に例外が発生した場合EventStatus
,
Procedure.onDecide(DecideParameter)
public abstract InitializeResult onInitialize(InitializeParameter parameter) throws ProcedureException, PropagationManagerException
SUCCEEDED
、失敗した場合は
FAILED
を返却してください。NOT_AFFECTED
を返却してください。ProcedureException
例外をスローした場合は、 FAILED
を返却した場合と同じ効果です。ProcedureException
クラスを継承した例外クラスをスローしてください。ProcedureException
例外をスローしてください。PropagationManagerException
例外と、これを継承した例外クラスは、伝搬機能で使用される例外クラスのため、明示的にスローしないてください。onInitialize
インタフェース内 Procedure<D,R extends Serializable>
parameter
- イベントのパラメータProcedureException
- イベント処理中に例外が発生した場合PropagationManagerException
- 伝搬機能の処理中に例外が発生した場合EventStatus
,
Procedure.onInitialize(InitializeParameter)
public abstract PrepareResult onPrepare(PrepareParameter parameter) throws ProcedureException, PropagationManagerException
SUCCEEDED
、できない場合は
FAILED
を返却してください。SUCCEEDED
を返す場合は、次に onDecide
または
onAbort
メソッドが呼び出されるまでデータの衝突を回避して、 onDecide
メソッドが呼び出された際に変更されたデータが確定されることを保証する必要があります。NOT_AFFECTED
を返却してください。ProcedureException
例外をスローした場合は、 FAILED
を返却した場合と同じ効果です。ProcedureException
クラスを継承した例外クラスをスローしてください。ProcedureException
例外をスローしてください。PropagationManagerException
例外と、これを継承した例外クラスは、伝搬機能で使用される例外クラスのため、明示的にスローしないてください。onPrepare
インタフェース内 Procedure<D,R extends Serializable>
parameter
- イベントのパラメータProcedureException
- イベント処理中に例外が発生した場合PropagationManagerException
- 伝搬機能の処理中に例外が発生した場合EventStatus
,
Procedure.onPrepare(PrepareParameter)
public abstract ReceiveResult<R> onReceive(ReceiveParameter parameter, D data) throws ProcedureException, PropagationManagerException
onInitialize
メソッドが呼び出された時点からの変更を記録して、いつでも元に戻せる状態にしてください。SUCCEEDED
、処理を中断する場合は
FAILED
を返却してください。NOT_AFFECTED
を返却してください。ProcedureException
例外をスローした場合は、 FAILED
を返却した場合と同じ効果です。ProcedureException
クラスを継承した例外クラスをスローしてください。ProcedureException
例外をスローしてください。PropagationManagerException
例外と、これを継承した例外クラスは、伝搬機能で使用される例外クラスのため、明示的にスローしないてください。R
で指定されたクラスのインスタンスと、メッセージを設定することができます。null
以外の明示的な値を設定すると、データの送信側に対して任意の処理結果を返却することができます。onReceive
インタフェース内 Procedure<D,R extends Serializable>
parameter
- イベントのパラメータdata
- 伝搬機能から受け取るデータProcedureException
- イベント処理中に例外が発生した場合PropagationManagerException
- 伝搬機能の処理中に例外が発生した場合EventStatus
,
Procedure.onReceive(ReceiveParameter, Object)
public void setParamValuesMap(Map<String,List<String>> map)
setParamValuesMap
インタフェース内 Procedure<D,R extends Serializable>
map
- 独自パラメータのマップProcedure.setParamValuesMap(Map)
protected void checkInSession(ReceiveParameter parameter) throws ProcedureException
parameter
の isInSession
メソッドを呼び出して、セッションの状態を確認します。ProcedureException
例外をスローします。parameter
- データ受信イベントのパラメータProcedureException
- セッション中でない場合protected String getParamValue(String key)
null
を返します。getParamValues
メソッドを呼び出してください。key
- 独自パラメータのキーCopyright © 2012 NTT DATA INTRAMART CORPORATION