クラス KafkaAdmin

実装されたすべてのインターフェース:
AwareSmartInitializingSingletonApplicationContextAwareKafkaAdminOperations

アプリケーションコンテキストで定義されたトピックを作成するために AdminClient に委譲する管理者。
導入:
1.3
作成者:
Gary Russell, Artem Bilan, Adrian Gygax
  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static class
    複数のトピックを単一の Bean として宣言するのを容易にする NewTopic のコレクションのラッパー。
  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final DurationSE
    デフォルトのクローズタイムアウト期間は 10 秒です。
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    提供された構成に基づいて、AdminClient を使用してインスタンスを作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    利用可能な場合は、クラスター ID を返します。
    void
    createOrModifyTopics(org.apache.kafka.clients.admin.NewTopic... topics)
    トピックが存在しない場合は作成するか、必要に応じてパーティションの数を増やします。
    MapSE<StringSE,org.apache.kafka.clients.admin.TopicDescription>
    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
    void
    setAutoCreate(boolean autoCreate)
    コンテキストの初期化中にトピックの自動作成を抑制するには、false に設定します。
    void
    setCloseTimeout(int closeTimeout)
    クローズタイムアウトを秒単位で設定します。
    void
    クラスター 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

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
  • フィールドの詳細

    • DEFAULT_CLOSE_TIMEOUT

      public static final DurationSE DEFAULT_CLOSE_TIMEOUT
      デフォルトのクローズタイムアウト期間は 10 秒です。
  • コンストラクターの詳細

    • KafkaAdmin

      public KafkaAdmin(MapSE<StringSE,ObjectSE> config)
      提供された構成に基づいて、AdminClient を使用してインスタンスを作成します。
      パラメーター:
      config - AdminClient の構成。
  • メソッドの詳細

    • setApplicationContext

      public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
      次で指定:
      インターフェース ApplicationContextAwaresetApplicationContext 
      例外:
      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

      protected PredicateSE<org.apache.kafka.clients.admin.NewTopic> getCreateOrModifyTopic()
      NewTopic を作成または変更するかどうかを決定するために使用される述語を返します。
      戻り値:
      述語。
      導入:
      2.9.10
      関連事項:
    • setClusterId

      public void setClusterId(StringSE clusterId)
      クラスター ID を設定します。これを使用すると、ユーザーが管理者権限を持っていない場合に、ブローカーからクラスター ID を取得しようとするのを防ぐことができます。
      パラメーター:
      clusterId - 設定する clusterId
      導入:
      3.1
    • getConfigurationProperties

      public MapSE<StringSE,ObjectSE> getConfigurationProperties()
      インターフェースからコピーされた説明: KafkaAdminOperations
      この管理者の構成の変更不可能なコピーを取得します。
      次で指定:
      インターフェース KafkaAdminOperationsgetConfigurationProperties 
      戻り値:
      構成マップ。
    • afterSingletonsInstantiated

      public void afterSingletonsInstantiated()
      次で指定:
      インターフェース SmartInitializingSingletonafterSingletonsInstantiated 
    • initialize

      public final boolean initialize()
      このメソッドを呼び出して、トピックをチェック / 追加します。これは、アプリケーションコンテキストが初期化されたときにブローカーが使用できず、fatalIfBrokerNotAvailable が false であるか、autoCreate が false に設定されている場合に必要になることがあります。
      戻り値:
      成功した場合は true。
      関連事項:
    • newTopics

      protected CollectionSE<org.apache.kafka.clients.admin.NewTopic> newTopics()
      作成または変更する NewTopic のコレクションを返します。デフォルトの実装では、アプリケーションコンテキスト内のすべての NewTopic Bean を取得し、それぞれに setCreateOrModifyTopic(Predicate) 述語を適用します。同じトピック名の NewTopic がある場合は、TopicForRetryable Bean も削除されます。これは述語を呼び出す前に実行されます。
      戻り値:
      NewTopic のコレクション。
      導入:
      2.9.10
      関連事項:
    • clusterId

      @Nullable public StringSE clusterId()
      インターフェースからコピーされた説明: KafkaAdminOperations
      利用可能な場合は、クラスター ID を返します。
      次で指定:
      インターフェース KafkaAdminOperationsclusterId 
      戻り値:
      記述クラスタ ID。
    • createOrModifyTopics

      public void createOrModifyTopics(org.apache.kafka.clients.admin.NewTopic... topics)
      インターフェースからコピーされた説明: KafkaAdminOperations
      トピックが存在しない場合は作成するか、必要に応じてパーティションの数を増やします。
      次で指定:
      インターフェース KafkaAdminOperationscreateOrModifyTopics 
      パラメーター:
      topics - トピック。
    • describeTopics

      public MapSE<StringSE,org.apache.kafka.clients.admin.TopicDescription> describeTopics(StringSE... topicNames)
      インターフェースからコピーされた説明: KafkaAdminOperations
      これらのトピックの TopicDescription を取得します。
      次で指定:
      インターフェース KafkaAdminOperationsdescribeTopics 
      パラメーター:
      topicNames - トピック名。
      戻り値:
      name:topicDescription のマップ。
    • getAdminConfig

      protected MapSE<StringSE,ObjectSE> getAdminConfig()