クラス KafkaAdmin

方法の詳細

• setApplicationContext

  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException

  次で指定:

  インターフェース 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 - コンテキストの初期化中にトピックを作成するかどうかを示すブールフラグ

  関連事項:

  • initialize()

• 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

  関連事項:

  • newTopics()

• getCreateOrModifyTopic

  protected PredicateSE<org.apache.kafka.clients.admin.NewTopic> getCreateOrModifyTopic()

  NewTopic を作成または変更するかどうかを決定するために使用される述語を返します。

  戻り値:

  述語。

  導入:

  2.9.10

  関連事項:

  • newTopics()

• setClusterId

  public void setClusterId(StringSE clusterId)

  クラスター ID を設定します。これを使用すると、ユーザーが管理者権限を持っていない場合に、ブローカーからクラスター ID を取得しようとするのを防ぐことができます。

  パラメーター:

  clusterId - 設定する clusterId

  導入:

  3.1

• getClusterId

  public @Nullable StringSE getClusterId()

  clusterId プロパティを取得します。

  戻り値:

  クラスター ID。

  導入:

  3.1.8

• setClusterIdRetryInterval

  public void setClusterIdRetryInterval(DurationSE clusterIdRetryInterval)

  ブローカーからクラスタ ID を取得する試行が失敗した後、再度試行する最小間隔を設定します。デフォルトは 5 minutes です。Duration.ZEROSE に設定すると、clusterId() ごとに取得が試行されます。

  パラメーター:

  clusterIdRetryInterval - 間隔。

  導入:

  4.1.1

  関連事項:

  • clusterId()

• getConfigurationProperties

  public MapSE<StringSE,ObjectSE> getConfigurationProperties()

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

  この管理者の構成の変更不可能なコピーを取得します。

  次で指定:

  インターフェース KafkaAdminOperations 内の getConfigurationProperties 

  戻り値:

  構成マップ。

• afterSingletonsInstantiated

  public void afterSingletonsInstantiated()

  次で指定:

  インターフェース SmartInitializingSingleton 内の afterSingletonsInstantiated 

• initialize

  public final boolean initialize()

  このメソッドを呼び出して、トピックをチェック / 追加します。これは、アプリケーションコンテキストが初期化されたときにブローカーが使用できず、fatalIfBrokerNotAvailable が false であるか、autoCreate が false に設定されている場合に必要になることがあります。

  戻り値:

  成功した場合は true。

  関連事項:

  • setFatalIfBrokerNotAvailable(boolean)
  • setAutoCreate(boolean)

• newTopics

  protected CollectionSE<org.apache.kafka.clients.admin.NewTopic> newTopics()

  作成または変更する NewTopic のコレクションを返します。デフォルトの実装では、アプリケーションコンテキスト内のすべての NewTopic Bean を取得し、それぞれに setCreateOrModifyTopic(Predicate) 述語を適用します。同じトピック名の NewTopic がある場合は、TopicForRetryable Bean も削除されます。これは述語を呼び出す前に実行されます。

  戻り値:

  NewTopic のコレクション。

  導入:

  2.9.10

  関連事項:

  • setCreateOrModifyTopic(Predicate)

• clusterId

  public @Nullable StringSE clusterId()

  最初の呼び出しでブローカーからクラスター ID を取得し、それを返します。取得に失敗した場合は、その旨が記録され、clusterIdRetryInterval が経過するまで再試行されません。試行するたびに Admin インスタンスが作成され、最大 operationTimeout の間ブロックされるため、呼び出しごとに再試行すると、監視機能が有効になっているリスナーコンテナーなどの呼び出し元が停止する可能性があります。

  次で指定:

  インターフェース KafkaAdminOperations 内の clusterId 

  戻り値:

  クラスター ID。取得に成功しなかった場合は null。

• 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 - トピック名。

  戻り値:

  名前: topicDescription の地図。

• deleteTopics

  public void deleteTopics(StringSE... topicNames)

  Kafka クラスターからトピックを削除します。

  次で指定:

  インターフェース KafkaAdminOperations 内の deleteTopics 

  パラメーター:

  topicNames - 削除するトピック名。

  例外:

  KafkaException - 操作が失敗した場合。

  導入:

  4.0

• createAdmin

  protected org.apache.kafka.clients.admin.Admin createAdmin()

  AdminClient クラスを使用して新しい Admin クライアントインスタンスを作成します。

  戻り値:

  新しい Admin クライアントインスタンス。

  導入:

  3.3.0

  関連事項:

  • AdminClient.create(Map)

• getAdminConfig

  protected MapSE<StringSE,ObjectSE> getAdminConfig()