TransactionalApplicationListener (Spring Framework API)

型パラメーター:
E - 待機する特定の ApplicationEvent サブクラス
すべてのスーパーインターフェース:
ApplicationListener<E>, EventListenerSE, Ordered
すべての既知の実装クラス:
TransactionalApplicationListenerAdapter, TransactionalApplicationListenerMethodAdapter
```
public interface TransactionalApplicationListener<E extends ApplicationEvent>
extends ApplicationListener<E>, Ordered
```
TransactionPhase に従って呼び出される ApplicationListener。これは、TransactionalEventListener アノテーションとプログラム的に同等です。
リスナーの実装に Ordered を追加すると、トランザクションの補完前または完了後に実行されている他のリスナーの中で、そのリスナーに優先順位を付けることができます。
注: トランザクションイベントリスナーは、PlatformTransactionManager によって管理されるスレッドバウンドトランザクションでのみ機能します。ReactiveTransactionManager によって管理されるリアクティブトランザクションは、スレッドローカル変数の代わりに Reactor コンテキストを使用するため、イベントリスナーの観点からは、参加できる互換性のあるアクティブトランザクションはありません。
導入:
5.3
作成者:
Juergen Hoeller, Oliver Drotbohm
関連事項:
TransactionalEventListener, TransactionalApplicationListenerAdapter, forPayload(java.util.function.Consumer<T>)

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	インターフェースと説明
`static interface`	`TransactionalApplicationListener.SynchronizationCallback` 同期駆動型イベント処理で呼び出されるコールバック。ターゲットリスナーの呼び出しをラップします（`processEvent(E)`）。

フィールドサマリー
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`void`	`addCallback(TransactionalApplicationListener.SynchronizationCallback callback)` トランザクション同期内の処理時に呼び出されるコールバックを追加します。
`static <T> TransactionalApplicationListener<PayloadApplicationEvent<T>>`	`forPayload(ConsumerSE<T> consumer)` 指定されたペイロードコンシューマー用に新しい `TransactionalApplicationListener` を作成し、デフォルトのフェーズ `TransactionPhase.AFTER_COMMIT` に適用します。
`static <T> TransactionalApplicationListener<PayloadApplicationEvent<T>>`	`forPayload(TransactionPhase phase, ConsumerSE<T> consumer)` 指定されたペイロードコンシューマー用に新しい `TransactionalApplicationListener` を作成します。
`default StringSE`	`getListenerId()` リスナーが個別に参照できるように識別子を返します。
`default int`	`getOrder()` トランザクション同期内で実行順序を返します。
`default TransactionPhase`	`getTransactionPhase()` リスナーが呼び出される `TransactionPhase` を返します。
`void`	`processEvent(E event)` 指定された `ApplicationEvent` をすぐに処理します。

インターフェース org.springframework.context.ApplicationListener から継承されたメソッド
onApplicationEvent

- メソッドの詳細
  - getOrder
```
default int getOrder()
```
    トランザクション同期内で実行順序を返します。
    デフォルトは Ordered.LOWEST_PRECEDENCE です。
    次で指定:
    インターフェース Ordered の getOrder
    戻り値:
    オーダー額
    関連事項:
    TransactionSynchronization.getOrder()
  - getListenerId
```
default StringSE getListenerId()
```
    リスナーが個別に参照できるように識別子を返します。
    特定の補完コールバックの実装では特定の ID を提供する必要がある場合がありますが、他のシナリオでは、空の文字列（共通のデフォルト値として）も使用できます。
    関連事項:
    SmartApplicationListener.getListenerId(), TransactionalEventListener.id(), addCallback(org.springframework.transaction.event.TransactionalApplicationListener.SynchronizationCallback)
  - getTransactionPhase
```
default TransactionPhase getTransactionPhase()
```
    リスナーが呼び出される TransactionPhase を返します。
    デフォルトのフェーズは TransactionPhase.AFTER_COMMIT です。
  - addCallback
```
void addCallback(TransactionalApplicationListener.SynchronizationCallback callback)
```
    トランザクション同期内の処理時、つまり実際のトランザクション中に processEvent(E) がトリガーされたときに呼び出されるコールバックを追加します。
    パラメーター:
    callback - 適用する同期コールバック
  - processEvent
```
void processEvent(E event)
```
    指定された ApplicationEvent をすぐに処理します。ApplicationListener.onApplicationEvent(ApplicationEvent) とは対照的に、このメソッドの呼び出しは、関連付けられた transaction phase に延期することなく、指定されたイベントを直接処理します。
    パラメーター:
    event - ターゲットリスナーの実装を通じて処理するイベント
  - forPayload
```
static <T> TransactionalApplicationListener<PayloadApplicationEvent<T>> forPayload(ConsumerSE<T> consumer)
```
    指定されたペイロードコンシューマー用に新しい TransactionalApplicationListener を作成し、デフォルトのフェーズ TransactionPhase.AFTER_COMMIT に適用します。
    次で指定:
    インターフェース ApplicationListener<E extends ApplicationEvent> の forPayload
    型パラメーター:
    T - イベントペイロードの型
    パラメーター:
    consumer - イベントペイロードコンシューマー
    戻り値:
    対応する TransactionalApplicationListener インスタンス
    関連事項:
    PayloadApplicationEvent.getPayload(), TransactionalApplicationListenerAdapter
  - forPayload
```
static <T> TransactionalApplicationListener<PayloadApplicationEvent<T>> forPayload(TransactionPhase phase,
                                                                                   ConsumerSE<T> consumer)
```
    指定されたペイロードコンシューマー用に新しい TransactionalApplicationListener を作成します。
    型パラメーター:
    T - イベントペイロードの型
    パラメーター:
    phase - リスナーを呼び出すトランザクションフェーズ
    consumer - イベントペイロードコンシューマー
    戻り値:
    対応する TransactionalApplicationListener インスタンス
    関連事項:
    PayloadApplicationEvent.getPayload(), TransactionalApplicationListenerAdapter

インターフェース TransactionalApplicationListener<E extends ApplicationEvent>

ネストされたクラスのサマリー

フィールドサマリー

インターフェース org.springframework.core.Ordered から継承されたフィールド

メソッドのサマリー

インターフェース org.springframework.context.ApplicationListener から継承されたメソッド

メソッドの詳細

getOrder

getListenerId

getTransactionPhase

addCallback

processEvent

forPayload

forPayload