Package io.debezium.metadata

Interface ComponentMetadata

public interface ComponentMetadata

  • Method Details

    • getComponentDescriptor

      ComponentDescriptor getComponentDescriptor()

    • getConfigDefinition

      default ConfigDefinition getConfigDefinition()
      Returns the configuration definition for this metadata provider.

      Known limitations:

      • ConfigDefinition is connector-centric: It assumes a fixed categorization (type/connector/history/events) that makes sense for database connectors but not for other components like SMTs, which lack "history" or "events" configuration.
      • Dual grouping mechanism: Fields can define their own Field.Group (e.g., CONNECTION, FILTERS), while ConfigDefinition imposes additional category-level groups when converting to ConfigDef via ConfigDefinition#configDef(). This creates two overlapping grouping systems.
      • Default implementation workaround: This default implementation places all fields into the "type" category, which may not be semantically appropriate for non-connector components.

      Consider refactoring to make ConfigDefinition more generic and rely solely on field-level groups rather than imposing hardcoded categories.

      Groups should be extracted from the fields and the group order defined by Field.Group

      In future only this method should be used and the getConnectorFields() removed

    • getComponentFields

      Field.Set getComponentFields()