クラス KafkaAdmin
java.lang.ObjectSE
org.springframework.kafka.core.KafkaResourceFactory
org.springframework.kafka.core.KafkaAdmin
- 実装されたすべてのインターフェース:
Aware
、SmartInitializingSingleton
、ApplicationContextAware
、KafkaAdminOperations
public class KafkaAdmin
extends KafkaResourceFactory
implements ApplicationContextAware, SmartInitializingSingleton, KafkaAdminOperations
アプリケーションコンテキストで定義されたトピックを作成するために
AdminClient
に委譲する管理者。- 導入:
- 1.3
- 作成者:
- Gary Russell, Artem Bilan, Adrian Gygax
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static class
複数のトピックを単一の Bean として宣言するのを容易にするNewTopic
のコレクションのラッパー。フィールドサマリー
フィールドコンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明void
利用可能な場合は、クラスター ID を返します。void
createOrModifyTopics
(org.apache.kafka.clients.admin.NewTopic... topics) トピックが存在しない場合は作成するか、必要に応じてパーティションの数を増やします。describeTopics
(StringSE... topicNames) これらのトピックのTopicDescription
を取得します。この管理者の構成の変更不可能なコピーを取得します。protected PredicateSE<org.apache.kafka.clients.admin.NewTopic>
NewTopic
を作成または変更するかどうかを決定するために使用される述語を返します。int
操作のタイムアウトを秒単位で返します。final boolean
このメソッドを呼び出して、トピックをチェック / 追加します。これは、アプリケーションコンテキストが初期化されたときにブローカーが使用できず、fatalIfBrokerNotAvailable
が false であるか、autoCreate
が false に設定されている場合に必要になることがあります。protected CollectionSE<org.apache.kafka.clients.admin.NewTopic>
作成または変更するNewTopic
のコレクションを返します。void
setApplicationContext
(ApplicationContext applicationContext) void
setAutoCreate
(boolean autoCreate) コンテキストの初期化中にトピックの自動作成を抑制するには、false に設定します。void
setCloseTimeout
(int closeTimeout) クローズタイムアウトを秒単位で設定します。void
setClusterId
(StringSE clusterId) クラスター ID を設定します。void
setCreateOrModifyTopic
(PredicateSE<org.apache.kafka.clients.admin.NewTopic> createOrModifyTopic) 検出されたNewTopic
Bean がこの管理インスタンスによる作成または変更の対象となる場合に true を返す述語を設定します。void
setFatalIfBrokerNotAvailable
(boolean fatalIfBrokerNotAvailable) 初期化中にブローカーに接続できない場合にアプリケーションコンテキストのロードに失敗する場合は、true に設定して、トピックを確認 / 追加します。void
setModifyTopicConfigs
(boolean modifyTopicConfigs) true に設定すると、現在のトピック構成プロパティがNewTopic
Bean のプロパティと比較され、異なる場合は更新されます。void
setOperationTimeout
(int operationTimeout) 操作タイムアウトを秒単位で設定します。クラス org.springframework.kafka.core.KafkaResourceFactory から継承されたメソッド
checkBootstrap, getBootstrapServers, setBootstrapServersSupplier
フィールドの詳細
DEFAULT_CLOSE_TIMEOUT
デフォルトのクローズタイムアウト期間は 10 秒です。
コンストラクターの詳細
KafkaAdmin
提供された構成に基づいて、AdminClient
を使用してインスタンスを作成します。- パラメーター:
config
-AdminClient
の構成。
メソッドの詳細
setApplicationContext
- 次で指定:
- インターフェース
ApplicationContextAware
のsetApplicationContext
- 例外:
BeansException
setCloseTimeout
public void setCloseTimeout(int closeTimeout) クローズタイムアウトを秒単位で設定します。デフォルトはDEFAULT_CLOSE_TIMEOUT
秒です。- パラメーター:
closeTimeout
- タイムアウト。
setOperationTimeout
public void setOperationTimeout(int operationTimeout) 操作のタイムアウトを秒単位で設定します。デフォルトは 30 秒です。- パラメーター:
operationTimeout
- タイムアウト。
getOperationTimeout
public int getOperationTimeout()操作のタイムアウトを秒単位で返します。- 戻り値:
- タイムアウト。
- 導入:
- 3.0.2
setFatalIfBrokerNotAvailable
public void setFatalIfBrokerNotAvailable(boolean fatalIfBrokerNotAvailable) 初期化中にブローカーに接続できない場合にアプリケーションコンテキストのロードに失敗する場合は、true に設定して、トピックを確認 / 追加します。- パラメーター:
fatalIfBrokerNotAvailable
- 失敗するのは本当です。
setAutoCreate
public void setAutoCreate(boolean autoCreate) コンテキストの初期化中にトピックの自動作成を抑制するには、false に設定します。- パラメーター:
autoCreate
- コンテキストの初期化中にトピックを作成するかどうかを示すブールフラグ- 関連事項:
setModifyTopicConfigs
public void setModifyTopicConfigs(boolean modifyTopicConfigs) true に設定すると、現在のトピック構成プロパティがNewTopic
Bean のプロパティと比較され、異なる場合は更新されます。- パラメーター:
modifyTopicConfigs
- 必要に応じて構成を確認および更新する場合は true。- 導入:
- 2.8.7
setCreateOrModifyTopic
public void setCreateOrModifyTopic(PredicateSE<org.apache.kafka.clients.admin.NewTopic> createOrModifyTopic) 検出されたNewTopic
Bean がこの管理インスタンスによる作成または変更の対象となる場合に true を返す述語を設定します。デフォルトの述語は、すべてのNewTopic
に対して true を返します。newTopics()
のデフォルト実装によって使用されます。- パラメーター:
createOrModifyTopic
- 述語。- 導入:
- 2.9.10
- 関連事項:
getCreateOrModifyTopic
NewTopic
を作成または変更するかどうかを決定するために使用される述語を返します。- 戻り値:
- 述語。
- 導入:
- 2.9.10
- 関連事項:
setClusterId
クラスター ID を設定します。これを使用すると、ユーザーが管理者権限を持っていない場合に、ブローカーからクラスター ID を取得しようとするのを防ぐことができます。- パラメーター:
clusterId
- 設定する clusterId- 導入:
- 3.1
getConfigurationProperties
インターフェースからコピーされた説明:KafkaAdminOperations
この管理者の構成の変更不可能なコピーを取得します。- 次で指定:
- インターフェース
KafkaAdminOperations
のgetConfigurationProperties
- 戻り値:
- 構成マップ。
afterSingletonsInstantiated
public void afterSingletonsInstantiated()- 次で指定:
- インターフェース
SmartInitializingSingleton
のafterSingletonsInstantiated
initialize
public final boolean initialize()このメソッドを呼び出して、トピックをチェック / 追加します。これは、アプリケーションコンテキストが初期化されたときにブローカーが使用できず、fatalIfBrokerNotAvailable
が false であるか、autoCreate
が false に設定されている場合に必要になることがあります。- 戻り値:
- 成功した場合は true。
- 関連事項:
newTopics
作成または変更するNewTopic
のコレクションを返します。デフォルトの実装では、アプリケーションコンテキスト内のすべてのNewTopic
Bean を取得し、それぞれにsetCreateOrModifyTopic(Predicate)
述語を適用します。同じトピック名の NewTopic がある場合は、TopicForRetryable
Bean も削除されます。これは述語を呼び出す前に実行されます。- 戻り値:
NewTopic
のコレクション。- 導入:
- 2.9.10
- 関連事項:
clusterId
インターフェースからコピーされた説明:KafkaAdminOperations
利用可能な場合は、クラスター ID を返します。- 次で指定:
- インターフェース
KafkaAdminOperations
のclusterId
- 戻り値:
- 記述クラスタ ID。
createOrModifyTopics
public void createOrModifyTopics(org.apache.kafka.clients.admin.NewTopic... topics) インターフェースからコピーされた説明:KafkaAdminOperations
トピックが存在しない場合は作成するか、必要に応じてパーティションの数を増やします。- 次で指定:
- インターフェース
KafkaAdminOperations
のcreateOrModifyTopics
- パラメーター:
topics
- トピック。
describeTopics
public MapSE<StringSE,org.apache.kafka.clients.admin.TopicDescription> describeTopics(StringSE... topicNames) インターフェースからコピーされた説明:KafkaAdminOperations
これらのトピックのTopicDescription
を取得します。- 次で指定:
- インターフェース
KafkaAdminOperations
のdescribeTopics
- パラメーター:
topicNames
- トピック名。- 戻り値:
- name:topicDescription のマップ。
getAdminConfig