クラス KafkaProducerMessageHandlerSpec<K,V,S extends KafkaProducerMessageHandlerSpec<K,V,S>>
java.lang.ObjectSE
org.springframework.integration.dsl.IntegrationComponentSpec <S、KafkaProducerMessageHandler <K、V>>
org.springframework.integration.dsl.MessageHandlerSpec <S、KafkaProducerMessageHandler <K、V>>
org.springframework.integration.kafka.dsl.KafkaProducerMessageHandlerSpec<K,V,S>
- 型パラメーター:
K
- 鍵の型。V
- 値の型。S
-KafkaProducerMessageHandlerSpec
拡張型。
- 実装されたすべてのインターフェース:
DisposableBean
、FactoryBean<KafkaProducerMessageHandler<K,
、V>> InitializingBean
、Lifecycle
、Phased
、SmartLifecycle
- 既知の直属サブクラス
KafkaOutboundGatewaySpec
,KafkaProducerMessageHandlerSpec.KafkaProducerMessageHandlerTemplateSpec
public class KafkaProducerMessageHandlerSpec<K,V,S extends KafkaProducerMessageHandlerSpec<K,V,S>>
extends MessageHandlerSpec<S,KafkaProducerMessageHandler<K,V>>
- 導入:
- 5.4
- 作成者:
- Artem Bilan, Biju Kunjummen, Gary Russell
ネストされたクラスのサマリー
ネストされたクラスフィールドのサマリー
クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
logger, PARSER, target
インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTE
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
メソッドのサマリー
修飾子と型メソッド説明<P> S
flush
(FunctionSE<Message<P>, BooleanSE> flushFunction) 実行時に呼び出されるFunction
SE を構成して、送信後にプロデューサーをフラッシュするかどうかを決定します。flushExpression
(StringSE flushExpression) 送信後にプロデューサーをフラッシュするかどうかを決定するように SpEL 式を構成します。flushExpression
(Expression flushExpression) 送信後にプロデューサーをフラッシュするかどうかを決定するようにExpression
を構成します。futuresChannel
(StringSE futuresChannel) 先物送信先のチャネルを設定します。futuresChannel
(MessageChannel futuresChannel) 先物送信先のチャネルを設定します。headerMapper
(org.springframework.kafka.support.KafkaHeaderMapper mapper) Spring メッセージングヘッダーを Kafka ヘッダーにマップするには、ヘッダーマッパーを指定します。messageKey
(StringSE messageKey) Kafka トピックにメッセージを格納するようにメッセージキーを設定します。<P> S
messageKey
(FunctionSE<Message<P>, ?> messageKeyFunction) 実行時に呼び出されるFunction
SE を構成して、メッセージがトピックに保管されるメッセージキーを決定します。messageKeyExpression
(StringSE messageKeyExpression) SpEL 式を構成して、評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定します。messageKeyExpression
(Expression messageKeyExpression) 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定するようにExpression
を構成します。partitionId
(IntegerSE partitionId) partitionId または Kafka トピックを構成します。<P> S
partitionId
(FunctionSE<Message<P>, IntegerSE> partitionIdFunction) 実行時に呼び出されるFunction
SE を構成して、メッセージがトピックに保管されるパーティション ID を判別します。partitionIdExpression
(StringSE partitionIdExpression) 評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定する SpEL 式を構成します。partitionIdExpression
(Expression partitionIdExpression) 評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定するようにExpression
を構成します。KafkaProducerMessageHandler.ProducerRecordCreator
を設定してProducerRecord
を作成します。sendFailureChannel
(StringSE sendFailureChannel) 失敗した送信結果が送信されるチャネルを設定します。sendFailureChannel
(MessageChannel sendFailureChannel) 失敗した送信結果が送信されるチャネルを設定します。sendSuccessChannel
(StringSE sendSuccessChannel) 成功した送信結果が送信されるチャネルを設定します。sendSuccessChannel
(MessageChannel sendSuccessChannel) 成功した送信結果が送信されるチャネルを設定します。sendTimeout
(long sendTimeout) KafkaProducerMessageHandler
が操作結果の送信を待機する時間をミリ秒単位で指定します。sync
(boolean sync) KafkaProducerMessageHandler
が送信操作の結果を待機する必要があるかどうかを示すboolean
。<P> S
timestamp
(FunctionSE<Message<P>, LongSE> timestampFunction) Kafka レコードのタイムスタンプがトピックに格納されることを決定するために実行時に呼び出されるFunction
SE を構成します。timestampExpression
(StringSE timestampExpression) 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように SpEL 式を構成します。timestampExpression
(Expression timestampExpression) 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するようにExpression
を構成します。メッセージを送信するように Kafka トピックを構成します。<P> S
topic
(FunctionSE<Message<P>, StringSE> topicFunction) メッセージの送信先のトピックを決定するために実行時に呼び出されるFunction
SE を構成します。topicExpression
(StringSE topicExpression) 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように SpEL 式を構成します。topicExpression
(Expression topicExpression) 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するようにExpression
を構成します。useTemplateConverter
(boolean use) テンプレートのメッセージコンバーターを使用してproducerRecordCreator
の代わりにProducerRecord
を作成するには、true に設定します。クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.beans.factory.FactoryBean から継承されたメソッド
isSingleton
メソッドの詳細
topic
topicExpression
topicExpression
評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するようにExpression
を構成します。- パラメーター:
topicExpression
- トピック式。- 戻り値:
- スペック。
topic
メッセージの送信先のトピックを決定するために実行時に呼び出されるFunction
SE を構成します。通常、Java 8 ラムダ式で使用されます。.<Foo>topic(m -> m.getPayload().getTopic())
- 型パラメーター:
P
- 予想されるペイロード型。- パラメーター:
topicFunction
- トピック関数。- 戻り値:
- 現在の
KafkaProducerMessageHandlerSpec
。 - 関連事項:
messageKeyExpression
messageKey
messageKeyExpression
評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定するようにExpression
を構成します。- パラメーター:
messageKeyExpression
- メッセージキー式。- 戻り値:
- スペック。
messageKey
実行時に呼び出されるFunction
SE を構成して、メッセージがトピックに保管されるメッセージキーを決定します。通常、Java 8 ラムダ式で使用されます。.<Foo>messageKey(m -> m.getPayload().getKey())
- 型パラメーター:
P
- 予想されるペイロード型。- パラメーター:
messageKeyFunction
- メッセージキー機能。- 戻り値:
- 現在の
KafkaProducerMessageHandlerSpec
。 - 関連事項:
partitionId
partitionIdExpression
partitionId
実行時に呼び出されるFunction
SE を構成して、メッセージがトピックに保管されるパーティション ID を判別します。通常、Java 8 ラムダ式で使用されます。.partitionId(m -> m.getHeaders().get("partitionId", Integer.class))
- 型パラメーター:
P
- 予想されるペイロード型。- パラメーター:
partitionIdFunction
- partitionId 関数。- 戻り値:
- スペック。
partitionIdExpression
評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定するようにExpression
を構成します。- パラメーター:
partitionIdExpression
- 使用する partitionId 式。- 戻り値:
- スペック。
timestampExpression
timestamp
Kafka レコードのタイムスタンプがトピックに格納されることを決定するために実行時に呼び出されるFunction
SE を構成します。通常、Java 8 ラムダ式で使用されます。.timestamp(m -> m.getHeaders().get("mytimestamp_header", Long.class))
- 型パラメーター:
P
- 予想されるペイロード型。- パラメーター:
timestampFunction
- タイムスタンプ関数。- 戻り値:
- スペック。
timestampExpression
評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するようにExpression
を構成します。- パラメーター:
timestampExpression
- 使用するタイムスタンプ式。- 戻り値:
- スペック。
flushExpression
送信後にプロデューサーをフラッシュするかどうかを決定するように SpEL 式を構成します。デフォルトでは、ヘッダーkafka_flush
の値がBoolean.TRUE
SE の場合、プロデューサーはフラッシュされます。- パラメーター:
flushExpression
- 使用するタイムスタンプ式。- 戻り値:
- スペック。
flush
実行時に呼び出されるFunction
SE を構成して、送信後にプロデューサーをフラッシュするかどうかを決定します。デフォルトでは、ヘッダーkafka_flush
の値がBoolean.TRUE
SE の場合、プロデューサーはフラッシュされます。通常、JavaLambda 式で使用されます。.flush(m -> m.getPayload().shouldFlush())
- 型パラメーター:
P
- 予想されるペイロード型。- パラメーター:
flushFunction
- フラッシュ機能。- 戻り値:
- スペック。
flushExpression
送信後にプロデューサーをフラッシュするかどうかを決定するようにExpression
を構成します。デフォルトでは、ヘッダーkafka_flush
の値がBoolean.TRUE
SE の場合、プロデューサーはフラッシュされます。- パラメーター:
flushExpression
- 使用するタイムスタンプ式。- 戻り値:
- スペック。
sync
KafkaProducerMessageHandler
が送信操作の結果を待機する必要があるかどうかを示すboolean
。デフォルトはfalse
です。sync
モードでは、ダウンストリーム送信操作の例外が再スローされます。- パラメーター:
sync
- 送信モード。デフォルトでは非同期です。- 戻り値:
- スペック。
sendTimeout
KafkaProducerMessageHandler
が操作結果の送信を待機する時間をミリ秒単位で指定します。デフォルトは 10 秒です。- パラメーター:
sendTimeout
- 送信操作の結果を待機するためのタイムアウト。- 戻り値:
- スペック。
headerMapper
Spring メッセージングヘッダーを Kafka ヘッダーにマップするには、ヘッダーマッパーを指定します。- パラメーター:
mapper
- マッパー。- 戻り値:
- スペック。
sendSuccessChannel
成功した送信結果が送信されるチャネルを設定します。- パラメーター:
sendSuccessChannel
- チャンネル。- 戻り値:
- スペック。
sendSuccessChannel
sendFailureChannel
失敗した送信結果が送信されるチャネルを設定します。- パラメーター:
sendFailureChannel
- チャンネル。- 戻り値:
- スペック。
sendFailureChannel
futuresChannel
先物送信先のチャネルを設定します。- パラメーター:
futuresChannel
- チャンネル。- 戻り値:
- スペック。
futuresChannel
producerRecordCreator
KafkaProducerMessageHandler.ProducerRecordCreator
を設定してProducerRecord
を作成します。useTemplateConverter
が true の場合は無視されます。- パラメーター:
creator
- クリエイター。- 戻り値:
- スペック。
- 導入:
- 5.5.5
useTemplateConverter
テンプレートのメッセージコンバーターを使用してproducerRecordCreator
の代わりにProducerRecord
を作成するには、true に設定します。- パラメーター:
use
- コンバーターを使用する場合は true。- 戻り値:
- スペック。
- 導入:
- 5.5.5