クラス AbstractKafkaListenerEndpoint<K,V>

メソッドの詳細

• setBeanFactory

  public void setBeanFactory(BeanFactory beanFactory) throws BeansException

  次で指定:

  インターフェース BeanFactoryAware の setBeanFactory 

  例外:

  BeansException

• getBeanFactory

  @Nullable protected BeanFactory getBeanFactory()

• getResolver

  @Nullable protected BeanExpressionResolver getResolver()

• getBeanExpressionContext

  @Nullable protected BeanExpressionContext getBeanExpressionContext()

• getBeanResolver

  @Nullable protected BeanResolver getBeanResolver()

• setId

  public void setId(@Nullable StringSE id)

• setMainListenerId

  public void setMainListenerId(@Nullable StringSE id)

• getMainListenerId

  @Nullable public StringSE getMainListenerId()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このコンテナーが再試行トピック用である場合は、メインリスナー ID を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getMainListenerId 

  戻り値:

  メインのリスナー ID または null。

• getId

  @Nullable public StringSE getId()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントの ID を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getId 

  戻り値:

  このエンドポイントの ID。エンドポイントが実際のリスナーコンテナーに対して解決されるときに、ID をさらに修飾できます。

  関連事項:

  • KafkaListenerContainerFactory.createListenerContainer(org.springframework.kafka.config.KafkaListenerEndpoint)

• setGroupId

  public void setGroupId(@Nullable StringSE groupId)

  グループ ID を設定して、ContainerFactory の group.id プロパティをオーバーライドします。

  パラメーター:

  groupId - グループ ID。

  導入:

  1.3

• getGroupId

  @Nullable public StringSE getGroupId()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントの groupId を返します - 存在する場合は、コンシューマーファクトリの group.id プロパティをオーバーライドします。

  次で指定:

  インターフェース KafkaListenerEndpoint の getGroupId 

  戻り値:

  グループ ID。null の場合があります。

• setTopics

  public void setTopics(StringSE... topics)

  使用するトピックを設定します。これらまたは 'topicPattern' または 'topicPartitions' のいずれかを指定する必要がありますが、混合は指定しないでください。

  パラメーター:

  topics - 設定します。

  関連事項:

  • setTopicPartitions(TopicPartitionOffset...)
  • setTopicPattern(Pattern)

• getTopics

  public CollectionSE<StringSE> getTopics()

  このエンドポイントのトピックを返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getTopics 

  戻り値:

  このエンドポイントのトピック。

• setTopicPartitions

  public void setTopicPartitions(TopicPartitionOffset... topicPartitions)

  使用する topicPartitions を設定します。this または 'topic' または 'topicPattern' のいずれかを指定する必要がありますが、混合は指定できません。

  パラメーター:

  topicPartitions - 設定します。

  導入:

  2.3

  関連事項:

  • setTopics(String...)
  • setTopicPattern(Pattern)

• getTopicPartitionsToAssign

  @Nullable public TopicPartitionOffset[] getTopicPartitionsToAssign()

  このエンドポイントの topicPartitions を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getTopicPartitionsToAssign 

  戻り値:

  このエンドポイントの topicPartitions。

  導入:

  2.3

• setTopicPattern

  public void setTopicPattern(PatternSE topicPattern)

  使用するトピックパターンを設定します。トピックまたは topicPartitions では使用できません。

  パラメーター:

  topicPattern - パターン

  関連事項:

  • setTopicPartitions(TopicPartitionOffset...)
  • setTopics(String...)

• getTopicPattern

  @Nullable public PatternSE getTopicPattern()

  このエンドポイントの topicPattern を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getTopicPattern 

  戻り値:

  このエンドポイントの topicPattern。

• getGroup

  @Nullable public StringSE getGroup()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントのグループを返すか、グループにない場合は null を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getGroup 

  戻り値:

  このエンドポイントのグループ、またはグループにない場合は null。

• setGroup

  public void setGroup(StringSE group)

  対応するリスナーコンテナーのグループを設定します。

  パラメーター:

  group - グループ。

• isBatchListener

  public boolean isBatchListener()

  このエンドポイントがバッチリスナーを作成する場合は true を返します。

  戻り値:

  バッチリスナーの場合は true。

  導入:

  1.1

• getBatchListener

  @Nullable public BooleanSE getBatchListener()

  このエンドポイントの現在のバッチリスナーフラグを返します。明示的に設定されていない場合は null を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getBatchListener 

  戻り値:

  バッチリスナーフラグ。

  導入:

  2.8

• setBatchListener

  public void setBatchListener(boolean batchListener)

  このエンドポイントがバッチリスナーを作成する必要がある場合は、true に設定します。

  パラメーター:

  batchListener - バッチリスナーの場合は true。

  導入:

  1.1

• setReplyTemplate

  public void setReplyTemplate(KafkaTemplate<?,?> replyTemplate)

  返信の送信に使用する KafkaTemplate を設定します。

  パラメーター:

  replyTemplate - テンプレート。

  導入:

  2.0

• getReplyTemplate

  @Nullable protected KafkaTemplate<?,?> getReplyTemplate()

• getRecordFilterStrategy

  @Nullable protected RecordFilterStrategy<? super K,? super V> getRecordFilterStrategy()

• setRecordFilterStrategy

  public void setRecordFilterStrategy(RecordFilterStrategy<? super K,? super V> recordFilterStrategy)

  RecordFilterStrategy 実装を設定します。

  パラメーター:

  recordFilterStrategy - 戦略の実装。

• isAckDiscarded

  protected boolean isAckDiscarded()

• setAckDiscarded

  public void setAckDiscarded(boolean ackDiscarded)

  setRecordFilterStrategy(RecordFilterStrategy) が破棄されたメッセージを確認する場合は true に設定します。

  パラメーター:

  ackDiscarded - ackDiscarded。

• getClientIdPrefix

  @Nullable public StringSE getClientIdPrefix()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  コンテナーのクライアント ID プレフィックスを返します。並行性が使用される場合、一意の ID を提供するために "-n" が接尾辞として付けられます。

  次で指定:

  インターフェース KafkaListenerEndpoint の getClientIdPrefix 

  戻り値:

  クライアント ID プレフィックス。

• setClientIdPrefix

  public void setClientIdPrefix(StringSE clientIdPrefix)

  クライアント ID プレフィックスを設定します。コンシューマー構成プロパティのクライアント ID をオーバーライドします。

  パラメーター:

  clientIdPrefix - プレフィックス。

  導入:

  2.1.1

• getConcurrency

  @Nullable public IntegerSE getConcurrency()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントのコンテナーの同時実行性を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getConcurrency 

  戻り値:

  並行性。

• setConcurrency

  public void setConcurrency(IntegerSE concurrency)

  このエンドポイントのコンテナーの同時実行性を設定します。

  パラメーター:

  concurrency - 並行性。

  導入:

  2.2

• getAutoStartup

  @Nullable public BooleanSE getAutoStartup()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントのコンテナーの autoStartup を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getAutoStartup 

  戻り値:

  autoStartup。

• setAutoStartup

  public void setAutoStartup(BooleanSE autoStartup)

  このエンドポイントのコンテナーの autoStartup を設定します。

  パラメーター:

  autoStartup - autoStartup。

  導入:

  2.2

• setReplyHeadersConfigurer

  public void setReplyHeadersConfigurer(ReplyHeadersConfigurer replyHeadersConfigurer)

  応答メッセージを作成するときに呼び出される設定者を設定します。

  パラメーター:

  replyHeadersConfigurer - コンフィギュレーター。

  導入:

  2.2

• getConsumerProperties

  @Nullable public PropertiesSE getConsumerProperties()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  コンシューマーファクトリによって提供されるコンシューマープロパティとマージされるコンシューマープロパティを取得します。ここのプロパティは、コンシューマーファクトリの同じ名前のプロパティよりも優先されます。group.id および client.id は無視されます。

  次で指定:

  インターフェース KafkaListenerEndpoint の getConsumerProperties 

  戻り値:

  プロパティ。

  関連事項:

  • ConsumerConfig
  • KafkaListenerEndpoint.getGroupId()
  • KafkaListenerEndpoint.getClientIdPrefix()

• setConsumerProperties

  public void setConsumerProperties(PropertiesSE consumerProperties)

  コンシューマーファクトリによって提供されるコンシューマープロパティとマージされるコンシューマープロパティを設定します。ここのプロパティは、コンシューマーファクトリの同じ名前のプロパティよりも優先されます。group.id および client.id は無視されます。

  パラメーター:

  consumerProperties - プロパティ。

  導入:

  2.1.4

  関連事項:

  • ConsumerConfig
  • setGroupId(String)
  • setClientIdPrefix(String)

• isSplitIterables

  public boolean isSplitIterables()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  true の場合、IterableSE の戻り結果は個別のレコードに分割されます。

  次で指定:

  インターフェース KafkaListenerEndpoint の isSplitIterables 

  戻り値:

  true に分割します。

• setSplitIterables

  public void setSplitIterables(boolean splitIterables)

  IterableSE 応答値を個別のレコードに分割することを無効にするには、false に設定します。

  パラメーター:

  splitIterables - 無効にする場合は false。デフォルトは真。

  導入:

  2.3.5

• getListenerInfo

  @Nullable public byte[] getListenerInfo()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  レコードヘッダーに挿入するリスナー情報を取得します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getListenerInfo 

  戻り値:

  情報。

• setListenerInfo

  public void setListenerInfo(@Nullable byte[] listenerInfo)

  レコードヘッダーに挿入するリスナー情報を設定します。

  パラメーター:

  listenerInfo - 情報。

  導入:

  2.8.4

• getBatchToRecordAdapter

  @Nullable protected BatchToRecordAdapter<K,V> getBatchToRecordAdapter()

• setBatchToRecordAdapter

  public void setBatchToRecordAdapter(BatchToRecordAdapter<K,V> batchToRecordAdapter)

  BatchToRecordAdapter を設定します。

  パラメーター:

  batchToRecordAdapter - アダプター。

  導入:

  2.4.2

• setCorrelationHeaderName

  public void setCorrelationHeaderName(StringSE correlationHeaderName)

  相関 ID のカスタムヘッダー名を設定します。デフォルト KafkaHeaders.CORRELATION_ID。このヘッダーは、返信メッセージでエコーバックされます。

  パラメーター:

  correlationHeaderName - ヘッダー名。

  導入:

  3.0

• getContainerPostProcessor

  public ContainerPostProcessor<?,?,?> getContainerPostProcessor()

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントの ContainerPostProcessor を返します。明示的に設定されていない場合は null を返します。

  次で指定:

  インターフェース KafkaListenerEndpoint の getContainerPostProcessor 

  戻り値:

  コンテナーのポストプロセッサー。

• setContainerPostProcessor

  public void setContainerPostProcessor(ContainerPostProcessor<?,?,?> containerPostProcessor)

  エンドポイントに ContainerPostProcessor を設定して、コンテナーの作成と構成後にコンテナーをカスタマイズできるようにします。

  パラメーター:

  containerPostProcessor - ポストプロセッサー。

  導入:

  3.1

• afterPropertiesSet

  public void afterPropertiesSet()

  次で指定:

  インターフェース InitializingBean の afterPropertiesSet 

• setupListenerContainer

  public void setupListenerContainer(MessageListenerContainer listenerContainer, @Nullable MessageConverter messageConverter)

  インターフェースからコピーされた説明: KafkaListenerEndpoint

  このエンドポイントで定義されたモデルを使用して、指定されたメッセージリスナーコンテナーをセットアップします。

  このエンドポイントは、それを使用可能にするために、指定されたコンテナーのリクエストされた欠落オプションを提供する必要があります。通常、これは使用する queues および messageListener の設定に関するものですが、実装はすでに設定されているデフォルト設定をオーバーライドする場合があります。

  次で指定:

  インターフェース KafkaListenerEndpoint の setupListenerContainer 

  パラメーター:

  listenerContainer - 設定するリスナーコンテナー

  messageConverter - メッセージコンバーター - null でもかまいません

• createMessageListener

  protected abstract MessagingMessageListenerAdapter<K,V> createMessageListener(MessageListenerContainer container, @Nullable MessageConverter messageConverter)

  指定されたコンテナーに対してこのエンドポイントを提供できる MessageListener を作成します。

  パラメーター:

  container - MessageListenerContainer を使用して MessageListener を作成します。

  messageConverter - メッセージコンバーター - null の場合があります。

  戻り値:

  MessageListener インスタンス。

• getEndpointDescription

  protected StringBuilderSE getEndpointDescription()

  このエンドポイントの説明を返します。

  戻り値:

  このエンドポイントの説明。

  toString() 結果に含めるために、サブクラスで使用できます。

• toString

  public StringSE toString()

  オーバーライド:

  クラス ObjectSE の toString