KafkaInboundGateway (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.gateway.MessagingGatewaySupport
    - - org.springframework.integration.kafka.inbound.KafkaInboundGateway<K,V,R>

型パラメーター:
K - 鍵の型。
V - リクエスト値型。
R - 応答値の型。
実装されているすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, Pausable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
```
public class KafkaInboundGateway<K,V,R>
extends MessagingGatewaySupport
implements Pausable, OrderlyShutdownCapable
```
受信ゲートウェイ。
導入:
5.4
作成者:
Gary Russell, Artem Bilan, Urs Keller

ネストされたクラスの要約
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.gateway.MessagingGatewaySupport から継承されたフィールド
  messagingTemplate
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターの概要

コンストラクター
コンストラクターと説明
`KafkaInboundGateway(org.springframework.kafka.listener.AbstractMessageListenerContainer<K, V> messageListenerContainer, org.springframework.kafka.core.KafkaTemplate<K, R> kafkaTemplate)` 提供されたコンテナーを使用してインスタンスを構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`int`	`afterShutdown()` スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。
`int`	`beforeShutdown()` シャットダウンが始まる前に呼び出されます。
`protected void`	`doStart()` サブクラスは、開始動作でこのメソッドを実装する必要があります。
`protected void`	`doStop()` サブクラスは、停止動作でこのメソッドを実装する必要があります。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`protected AttributeAccessor`	`getErrorMessageAttributes(Message<?> message)` `errorMessageStrategy` でエラーメッセージを作成するときに使用する `AttributeAccessor` を設定します。
`boolean`	`isPaused()` エンドポイントが一時停止しているかどうかを確認します。
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`pause()` エンドポイントを一時停止します。
`void`	`resume()` 一時停止した場合は、エンドポイントを再開します。
`void`	`setBindSourceRecord(boolean bindSourceRecord)` true に設定すると、`IntegrationMessageHeaderAccessor.SOURCE_DATA` という名前のヘッダーにソースコンシューマーレコードがバインドされます。
`void`	`setMessageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter)` メッセージコンバーターを設定します。モードに応じて、`RecordMessageConverter` または `BatchMessageConverter` でなければなりません。
`void`	`setOnPartitionsAssignedSeekCallback(java.util.function.BiConsumerSE<MapSE<org.apache.kafka.common.TopicPartition,LongSE>,org.springframework.kafka.listener.ConsumerSeekAware.ConsumerSeekCallback> onPartitionsAssignedCallback)` `KafkaMessageListenerContainer` からの `ConsumerSeekAware.ConsumerSeekCallback#onPartitionsAssigned(Map, ConsumerSeekAware.ConsumerSeekCallback)` 呼び出し中にシーク管理用の `BiConsumer`SE を指定します。
`void`	`setPayloadType(ClassSE<?> payloadType)` 型認識メッセージコンバーター（`StringJsonMessageConverter` など）を使用する場合は、コンバーターが作成するペイロード型を設定します。
`void`	`setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)` 再試行操作用の `RecoveryCallback` インスタンス。null の場合、再試行が終了した後、例外がコンテナーにスローされます（エラーチャネルが設定されていない場合）。
`void`	`setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)` `KafkaInboundGateway.IntegrationRecordMessageListener` を `RetryingMessageListenerAdapter` にラップする `RetryTemplate` インスタンスを指定します。

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.integration.support.management.ManageableLifecycle から継承されたメソッド
isRunning, start, stop

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAs

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- コンストラクターの詳細
  - KafkaInboundGateway
```
public KafkaInboundGateway(org.springframework.kafka.listener.AbstractMessageListenerContainer<K,V> messageListenerContainer,
                           org.springframework.kafka.core.KafkaTemplate<K,R> kafkaTemplate)
```
    提供されたコンテナーを使用してインスタンスを構築します。
    パラメーター:
    messageListenerContainer - コンテナー。
    kafkaTemplate - kafka テンプレート。
- メソッドの詳細
  - setMessageConverter
```
public void setMessageConverter(org.springframework.kafka.support.converter.RecordMessageConverter messageConverter)
```
    メッセージコンバーターを設定します。モードに応じて、RecordMessageConverter または BatchMessageConverter でなければなりません。
    パラメーター:
    messageConverter - コンバーター。
  - setPayloadType
```
public void setPayloadType(ClassSE<?> payloadType)
```
    型認識メッセージコンバーター（StringJsonMessageConverter など）を使用する場合、コンバーターが作成するペイロード型を設定します。デフォルトは ObjectSE です。
    パラメーター:
    payloadType - 型。
  - setRetryTemplate
```
public void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
```
    KafkaInboundGateway.IntegrationRecordMessageListener を RetryingMessageListenerAdapter にラップする RetryTemplate インスタンスを指定します。
    パラメーター:
    retryTemplate - 使用する RetryTemplate。
  - setRecoveryCallback
```
public void setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)
```
    再試行操作用の RecoveryCallback インスタンス。null の場合、再試行が終了した後、例外がコンテナーにスローされます（エラーチャネルが設定されていない場合）。setRetryTemplate(RetryTemplate) が指定されていない場合は意味がありません。
    パラメーター:
    recoveryCallback - リカバリコールバック。
  - setOnPartitionsAssignedSeekCallback
```
public void setOnPartitionsAssignedSeekCallback(java.util.function.BiConsumerSE<MapSE<org.apache.kafka.common.TopicPartition,LongSE>,org.springframework.kafka.listener.ConsumerSeekAware.ConsumerSeekCallback> onPartitionsAssignedCallback)
```
    KafkaMessageListenerContainer からの ConsumerSeekAware.ConsumerSeekCallback#onPartitionsAssigned(Map, ConsumerSeekAware.ConsumerSeekCallback) 呼び出し中のシーク管理用に BiConsumerSE を指定します。これは、内部 MessagingMessageListenerAdapter 実装から呼び出されます。
    パラメーター:
    onPartitionsAssignedCallback - 使用する BiConsumerSE
    導入:
    3.0.4
    関連事項:
    ConsumerSeekAware.onPartitionsAssigned(java.util.Map<org.apache.kafka.common.TopicPartition, java.lang.Long>, org.springframework.kafka.listener.ConsumerSeekAware.ConsumerSeekCallback)
  - setBindSourceRecord
```
public void setBindSourceRecord(boolean bindSourceRecord)
```
    true に設定すると、IntegrationMessageHeaderAccessor.SOURCE_DATA という名前のヘッダーにソースコンシューマーレコードがバインドされます。
    パラメーター:
    bindSourceRecord - バインドする場合は true。
    導入:
    3.1.4
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス MessagingGatewaySupport の onInit
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、開始動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    オーバーライド:
    クラス MessagingGatewaySupport の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、停止動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    オーバーライド:
    クラス MessagingGatewaySupport の doStop
  - pause
```
public void pause()
```
    インターフェースからコピーされた説明: Pausable
    エンドポイントを一時停止します。
    次で指定:
    インターフェース Pausable の pause
  - resume
```
public void resume()
```
    インターフェースからコピーされた説明: Pausable
    一時停止した場合は、エンドポイントを再開します。
    次で指定:
    インターフェース Pausable の resume
  - isPaused
```
public boolean isPaused()
```
    インターフェースからコピーされた説明: Pausable
    エンドポイントが一時停止しているかどうかを確認します。
    次で指定:
    インターフェース Pausable の isPaused
    戻り値:
    一時停止した場合は true。
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessagingGatewaySupport の getComponentType
  - beforeShutdown
```
public int beforeShutdown()
```
    インターフェースからコピーされた説明: OrderlyShutdownCapable
    シャットダウンが始まる前に呼び出されます。実装は、新しいメッセージの受け入れを停止する必要があります。オプションで、処理中のアクティブなメッセージの数を返すことができます。
    次で指定:
    インターフェース OrderlyShutdownCapable の beforeShutdown
    戻り値:
    使用可能な場合、アクティブなメッセージの数。
  - afterShutdown
```
public int afterShutdown()
```
    インターフェースからコピーされた説明: OrderlyShutdownCapable
    スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。
    次で指定:
    インターフェース OrderlyShutdownCapable の afterShutdown
    戻り値:
    使用可能な場合、アクティブなメッセージの数。
  - getErrorMessageAttributes
```
protected AttributeAccessor getErrorMessageAttributes(Message<?> message)
```
    クラスからコピーされた説明: MessagingGatewaySupport
    errorMessageStrategy でエラーメッセージを作成するときに使用する AttributeAccessor を設定します。
    オーバーライド:
    クラス MessagingGatewaySupport の getErrorMessageAttributes
    パラメーター:
    message - メッセージ。
    戻り値:
    属性。

クラス KafkaInboundGateway<K,V,R>

ネストされたクラスの要約

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.integration.gateway.MessagingGatewaySupport から継承されたフィールド

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

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

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.gateway.MessagingGatewaySupport から継承されたメソッド

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

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

インターフェース org.springframework.integration.support.management.ManageableLifecycle から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

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

コンストラクターの詳細

KafkaInboundGateway

メソッドの詳細

setMessageConverter

setPayloadType

setRetryTemplate

setRecoveryCallback

setOnPartitionsAssignedSeekCallback

setBindSourceRecord

onInit

doStart

doStop

pause

resume

isPaused

getComponentType

beforeShutdown

afterShutdown

getErrorMessageAttributes